Resultados de la búsqueda :

×

Guía paso a paso para configurar la autenticación de API REST en Confluence

Confluence proporciona API REST para realizar una serie de operaciones como Crear página, Eliminar página, Agregar comentario, Crear espacio, etc. Sin embargo, solo admite dos métodos de autenticación para API REST:

  1. Autenticación básica
  2. Uso de Confluence como proveedor de OAuth 1.0

El complemento de autenticación de API REST para Confluence le permite utilizar cualquier proveedor externo de OAuth 2.0/conexión OpenID para autenticar las API REST.

 

Beneficios de utilizar el complemento de autenticación de API REST:

  1. Seguro: Esto es más seguro que la autenticación básica, ya que las credenciales del usuario no se pasan con cada solicitud de API. El complemento solo requiere un token de acceso generado por el proveedor externo OAuth 2.0/OpenID Connect.
  2. Flexible:  Le permite utilizar cualquier proveedor externo de OAuth 2.0/OpenID Connect para la autenticación y no solo Confluence.
  3. Protección general: El complemento también puede bloquear solicitudes de autenticación básica de modo que nadie sin un token de acceso válido pueda usar ninguna API REST.
  4. Compatible con SSO: Si utiliza el inicio de sesión único para Confluence, puede configurar su proveedor de identidad para que también proporcione autenticación para las API REST.

 

El flujo de autenticación de API REST implica estos dos sencillos pasos:

  1. Solicitar token de acceso del proveedor OAuth 2.0/OIDC
  2. Llame a la API REST de Confluence utilizando este token de acceso

Pasos para configurar la autenticación OAuth 2.0/OpenID Connect utilizando el complemento de autenticación API REST miniOrange para Confluence:

Nota:  He utilizado miniOrange OAuth Provider como ejemplo aquí. El complemento admite cualquier proveedor de conexión OAuth 2.0/OpenID personalizado, como Azure AD, Keycloak, Okta, Gsuite (aplicaciones de Google), AWS Cognito, Github, Gitlab, etc.

Paso 1: Configure el flujo de OAuth entre su aplicación cliente y el proveedor de OAuth 2.0/OpenID Connect:

    1. Aplicación de cliente: Es un servicio o usuario que desea acceder a la API REST de Confluence.
    2. Deberá configurar un flujo OAuth entre miniOrange y su aplicación cliente. La aplicación cliente es cualquier servicio o usuario que llame a la API REST de Confluence.
    3. Se utilizará para autorizar al usuario y obtener el token de acceso.  Note: Este flujo se configurará entre su aplicación cliente y el proveedor miniOrange OAuth. El complemento de autenticación de API REST no participa en este proceso. Si su aplicación no es compatible con OAuth 2.0, envíenos un correo electrónico a info@xecurify.com.
    4. Configure miniOrange como proveedor de OpenID siguiendo la guía paso a paso en este enlace: Configure miniOrange como proveedor de OpenID Connect.
    5. Después de configurar miniOrange como proveedor de OAuth, vaya a Apps Administrar aplicaciones. Haga clic en el enlace Editar al lado de la aplicación que creó en miniOrange.
    6. Copia el Punto final de información de usuario.

Paso 2: Configure el punto final de introspección en el complemento de autenticación de API REST:

    1. Punto final de introspección: Un punto final de introspección es un punto final del proveedor OAuth/OpenID que se puede llamar usando token de acceso y devuelve nombre de usuario en respuesta.
    2. Seleccione Proveedor de OAuth personalizado existentes Proveedor de OAuth Pestaña Configuración
    3. Escriba la Punto final de información de usuario copiado en el paso 1 en el campo Punto final de introspección. Se parece a esto.
      https://login.xecurify.com/moas/rest/oauth/getuserinfo
    4. El punto final de información de usuario de miniOrange devuelve una respuesta como esta:
      { "sub": "demouser", "firstname": "Demo", "email": "demo@example.com", "nombre de usuario": "demouser", "apellido": "Usuario" }
    5. Atributo de nombre de usuario: Esta clave en la respuesta del punto final de introspección le indica al complemento qué usuario está realizando la llamada a la API.
    6. En la respuesta anterior, nombre de usuario El atributo contiene el nombre de usuario de Confluence de la persona que realiza la llamada API. Por lo tanto, el nombre de usuario se ingresa como atributo de nombre de usuario. Entonces el complemento sabrá que el usuario "demouser" de Confluence está realizando una llamada a la API.

Paso 3: Obtenga el token de acceso del proveedor miniOrange OAuth:

    1. Inicie el flujo de OAuth con miniOrange. Este flujo de OAuth se ve así.

2. Al final de este flujo, se devolverá un token de acceso al URI de redireccionamiento de su aplicación configurado en miniOrange.

3. Un token de acceso de muestra del proveedor miniOrange OAuth se ve así.

  A834c0606ba71336423013699db8e971

Paso 4: Utilice la API REST de Confluence mediante el token de acceso:

    1. Llame a Confluence a cualquier API REST. Incluya el token de acceso en el encabezado de Autorización. A continuación se muestra un ejemplo de cómo crear una API de página.

Solicitud:

     curl \ -X POST \ -H "Autorización: Portador " \ -H "Tipo de contenido: aplicación/json" \ --data {ver más abajo} \ http://localhost:8090/confluence/rest/api/content/|phython-mjson.tool \

 

Los datos de entrada:

     { "tipo":"página", "título":"nueva página", "espacio":{ "clave":"TST" }, "cuerpo":{ "almacenamiento":{ "valor":" Esto es una nueva pagina ", "representación": "almacenamiento" } } }

2. El complemento validará el token de acceso.
3. El problema se creará si el token de acceso no es válido.
4. Si el token no es válido o falta, la llamada devolverá una respuesta 401 no autorizada.

Aquí está el diagrama de flujo de la autenticación de API REST utilizando el complemento miniOrange.

¡Hola!

¿Necesitas ayuda? ¡Estamos aquí!

SOPORTE
Póngase en contacto con el soporte técnico de miniOrange
comercial

Gracias por su consulta.

Si no recibe noticias nuestras dentro de las 24 horas, no dude en enviar un correo electrónico de seguimiento a info@xecurify.com