OpenID y OAuth

Próxima versión — Zylon 1.58Esta documentación se publica antes del lanzamiento para que puedas preparar tus integraciones de API. La imagen de la versión todavía no está disponible. Para instalaciones con 1.57, consulta la documentación de 1.57.

Usa estos endpoints para iniciar flujos OpenID/OAuth. Los endpoints de inicio de sesión están pensados para el navegador y devuelven redirecciones; los callbacks reciben la respuesta del proveedor.

Las integraciones deben estar habilitadas antes de usar OAuth. Consulta las guías del operador para Confluence y SharePoint.

Solicitud básica y respuesta

Inicia un flujo de inicio de sesión llamando al endpoint del proveedor y siguiendo la redirección.

Redirecciones SSO de usuario

Inicio de sesión Google
Inicio de sesión Microsoft

curl -i "https://{BASE_URL}/api/v1/auth/google/login"

Ejemplo de respuesta

HTTP/1.1 302 Found
Location: https://accounts.google.com/o/oauth2/v2/auth?client_id=...&redirect_uri=...

curl -i "https://{BASE_URL}/api/v1/auth/microsoft/login"

Ejemplo de respuesta

HTTP/1.1 302 Found
Location: https://login.microsoftonline.com/common/oauth2/v2.0/authorize?client_id=...&redirect_uri=...

Redirecciones OAuth de integraciones

Usa project_id para crear una integración de proyecto u omítelo para crear una integración de organización con rol AppAdmin o superior. El parámetro opcional connector_name establece su nombre visible.

Parametros del endpoint

Tipo	Nombre	Obligatorio	Notas
Query	`project_id`	No	Proyecto propietario de la integración. Omítelo para una integración de organización.
Query	`connector_name`	No	Nombre visible del nuevo artefacto de integración.

Inicio de sesión Confluence
Inicio de sesión SharePoint

curl -i "https://{BASE_URL}/api/v1/app/artifact/integration/confluence/login?project_id={projectID}&connector_name=Confluence" \
  -H "Authorization: Bearer {API_TOKEN}" \
  -H "x-org: {org_slug}"

Ejemplo de respuesta

HTTP/1.1 302 Found
Location: https://auth.atlassian.com/authorize?client_id=...&redirect_uri=...

curl -i "https://{BASE_URL}/api/v1/app/artifact/integration/sharepoint/login?project_id={projectID}&connector_name=SharePoint" \
  -H "Authorization: Bearer {API_TOKEN}" \
  -H "x-org: {org_slug}"

Ejemplo de respuesta

HTTP/1.1 302 Found
Location: https://login.microsoftonline.com/common/oauth2/v2.0/authorize?client_id=...&redirect_uri=...

Inicio de sesión con una instancia específica

Envía integration_artifact_id para sustituir las credenciales OAuth de un artefacto de integración existente. Incluye project_id cuando la integración pertenece a un proyecto.

Parametros del endpoint

Tipo	Nombre	Obligatorio	Notas
Query	`integration_artifact_id`	Si	Artefacto de integración existente cuyas credenciales OAuth se sustituirán.
Query	`project_id`	Condicional	Proyecto propietario de la integración. Inclúyelo para una integración de proyecto.

Instancia Confluence
Instancia SharePoint

curl -i "https://{BASE_URL}/api/v1/app/artifact/integration/confluence/login?project_id={projectID}&integration_artifact_id={integrationArtifactID}" \
  -H "Authorization: Bearer {API_TOKEN}" \
  -H "x-org: {org_slug}"

Ejemplo de respuesta

HTTP/1.1 302 Found
Location: https://auth.atlassian.com/authorize?client_id=...&state=conf_8a7b6c5d4e3f2a1b

curl -i "https://{BASE_URL}/api/v1/app/artifact/integration/sharepoint/login?project_id={projectID}&integration_artifact_id={integrationArtifactID}" \
  -H "Authorization: Bearer {API_TOKEN}" \
  -H "x-org: {org_slug}"

Ejemplo de respuesta

HTTP/1.1 302 Found
Location: https://login.microsoftonline.com/common/oauth2/v2.0/authorize?client_id=...&state=sp_1c2d3e4f5a6b7c8d

Renovación del token de la integración

Parametros del endpoint

Tipo	Nombre	Obligatorio	Notas
Path	`integrationArtifactID`	Si	Artefacto de integración cuyo token se renovará.

Renovar token Confluence
Renovar token SharePoint

curl -X POST "https://{BASE_URL}/api/v1/app/artifact/{integrationArtifactID}/integration/confluence/refresh_token" \
  -H "Authorization: Bearer {API_TOKEN}" \
  -H "x-org: {org_slug}"

Ejemplo de respuesta

"ok"

curl -X POST "https://{BASE_URL}/api/v1/app/artifact/{integrationArtifactID}/integration/sharepoint/refresh_token" \
  -H "Authorization: Bearer {API_TOKEN}" \
  -H "x-org: {org_slug}"

Ejemplo de respuesta

"ok"

Callbacks

Microsoft callback
Confluence callback
SharePoint callback

Parametros del endpoint

Tipo	Nombre	Obligatorio	Notas
Query	`code`	Si	Código de autorización OAuth.
Query	`state`	Si	Valor OAuth `state` devuelto por el proveedor.

curl -i "https://{BASE_URL}/api/v1/auth/microsoft/callback?code=...&state=..."

Ejemplo de respuesta

HTTP/1.1 302 Found
Location: https://{BASE_URL}/app/login/success

Parametros del endpoint

Tipo	Nombre	Obligatorio	Notas
Query	`code`	Si	Código de autorización OAuth.
Query	`state`	Si	Valor OAuth `state` devuelto por el proveedor.

curl -i "https://{BASE_URL}/api/v1/app/artifact/integration/confluence/callback?code=...&state=..."

Ejemplo de respuesta

HTTP/1.1 302 Found
Location: https://{BASE_URL}/app/integrations/confluence

Parametros del endpoint

Tipo	Nombre	Obligatorio	Notas
Query	`code`	Si	Código de autorización OAuth.
Query	`state`	Si	Valor OAuth `state` devuelto por el proveedor.

curl -i "https://{BASE_URL}/api/v1/app/artifact/integration/sharepoint/callback?code=...&state=..."

Ejemplo de respuesta

HTTP/1.1 302 Found
Location: https://{BASE_URL}/app/integrations/sharepoint

Errores y casos límite

302: esperado en inicio de sesión y callback.
401/403: token ausente para la renovación.
404: no se encontró el artefacto de integración o el proyecto.

Primeros pasos

Construye con Zylon

Coding Agents

OpenID y OAuth

Solicitud básica y respuesta

Redirecciones SSO de usuario

Redirecciones OAuth de integraciones

Inicio de sesión con una instancia específica

Renovación del token de la integración

Callbacks

Errores y casos límite

​Solicitud básica y respuesta

​Redirecciones SSO de usuario

​Redirecciones OAuth de integraciones

​Inicio de sesión con una instancia específica

​Renovación del token de la integración

​Callbacks

​Errores y casos límite

Solicitud básica y respuesta

Redirecciones SSO de usuario

Redirecciones OAuth de integraciones

Inicio de sesión con una instancia específica

Renovación del token de la integración

Callbacks

Errores y casos límite