API Identity
API Identity es un nuevo tipo de API creada para facilitar la autenticación por contraseña flujo Password de OAuth). Esta API sustituye OAuth Directory y permite modificar y tratar las llamadas hechas para los servidores de autenticación.
— Aviso de discontinuidad: OAuth Directory — Desde la Release 1901.1.2.0, OAuth Directory ha sido descontinuado y es necesario tener una API Identity registrada para utilizar el flujo Password. En versiones anteriores, OAuth Directory es responsable de la autenticación (puede acceder a la documentación de esta funcionalidad descontinuada aquí). |
Funcionamiento
API Identities poseen en su cuerpo API que contienen los interceptores OAuth y/o Access Token Validation con la opción Password habilitada.
Cuando una aplicación utiliza alguna de estas API asociadas, ocurre lo siguiente: al requerir un access token del tipo Password, será realizada una petición para la API Identity, que tratará la llamada y la envirará para el endpoint de autenticación.
El endpoint que el servicio de autorización solicitará a la API Identity depende directamente del entorno utilizado para la llamada a la API OAuth 2.0. Por eso, la API Identity y API OAuth 2.0 deberán estar implantadas en el mismo entorno, lo que permite que la misma API tenga comportamientos diferentes en flujos de entornos distintos.
Puede ver más sobre API OAuth 2.0 aquí. |
Una API común puede estar asociada a más de una API Identity, y una aplicación (app) puede estar asociada a más de una API. En estos casos, el servicio de autorización enviará peticiones a cada Identity asociada, una a una. En el caso que la contraseña sea válida en alguna API Identity, él dejará de ejecutar las restantes. En el caso que en ninguna API Identity la contraseña sea válida, no será permitido crear un access token.
El cuerpo pasado a la API Identity en el momento de la llamada tendrá todo el contenido enviado para la solicitud de access token en el flujo Password, permitiendo más posibilidades en la autenticación de contraseñas.
En el caso que la llamada para la API Identity retorne un campo en el cuerpo con la clave extraInfo
, el contenido de este campo estará presente en el extraInfo
del access token generado.
Cómo crear una API Identity
Para la creación de una nueva API Identity, seleccionar la opción Create API Identity en la esquina inferior derecha de la pantalla APIs (en el menú que aparece al colocar el cursor en el botón flotante +).
Será abierta la página de construcción de APIs y deberán ser llenadas todas las informaciones necesarias, así como cuando se crea una API común:
El destino (API Destination que fue establecido al hacer clic en el ícono en la sección Flows) deberá ser el endpoint que ejecutará la verificación de contraseña. |
Diferente de APIs comunes, la API Identity posee el campo Identity, donde es posible seleccionar APIs que poseen los interceptores OAuth y/o Access Token Validation, con la opción Password habilitada.
Hecho esto, su API puede ser publicada (botón Publish) y estará lista para uso.
Share your suggestions with us!
Click here and then [+ Submit idea]