Configurar integración con Keycloak

Configurar integración con Keycloak

Resumen

En este artículo explicamos cómo integrar tu instancia de Keycloak para proteger los métodos de las APIs.

Para aplicar las configuraciones necesitarás acceso al administrador Keycloak con todos los permisos habilitados.

Las imágenes y textos pueden variar según la versión que utilices.

Versiones

Vor-Tex soporta las últimas versiones de Keycloak. Puedes conocer el listado de versiones aqui [https://www.keycloak.org/docs/latest/release_notes/index.html]

Para conocer tu versión de Keycloak debes ir a el menú superior derecho y acceder a la sección Realm info. Allí encontrarás el atributo Server Version con su valor.



Configurar Keycloak

A continuación encotrarás los pasos que debes seguir para configuar tu Keycloak.


Crear y configurar realm

Un realm (o reino) en Keycloak es la entidad u objeto que agrupa a un conjunto de usuarios, roles y grupos.

Pudes aplicar las siguientes configuraciones en un real ya existente o crear uno nuevo para integrar a Vor-Tex.

Si ya tienes un realm creado y quieres utilizarlo, continúa al siguiente paso.

Para crear un realm debes desplegar los realms existentes en el menú lateral izquierdo, y luego hacer clic sobre Create Realm.



Define un nombre para el realm y luego haz clic en Create.



Configurar usuario

Para que Vor-Tex pueda integrarse con Keycloak, es necesario un usuario con accesos de administración sobre el realm.

Puedes utilizar un usuario existente, o para mayor control puedes crear un nuevo usuario que utilizarás en Vor-Tex.

Para crear un usuario, debes ir a la sección Users en el menú y luego Create user.

Ingresa un nombre de usuario y completa el resto de los campos. Luego haz clic en Create.






Configurar credenciales de usuario

Una vez creado el usuario, ingresa a la pestaña Credentials y asina una contraseña con el botón Set password.

Ingresa una contraseña segura y guarda los cambios.



Configurar cliente

Ingresa a Clients y busca en el listado al cliente `admin-cli`.

Accede al detalle del cliente `admin-cli` y activa las siguientes opciones:
  1. Client authentication: On
  2. Authentication flow: Direct access grants; Service account roles.


Luego de guardar los cambios, al activar la opción Service account roles se mostrará la pestaña Service account roles.

Ingresa a esa pestaña y luego haz clic sobre Asign roles.


Busca el cliente `real-management` y luego haz clic en Assign.



Ingresa a la pestaña Credentials para obtener el client_secret que necesitarás para configurar la integración con Vor-Tex.



Obtener datos de configuración

Para configurar la integración en Vor-Tex necesitarás:
  1. Host: el domonio del servidor de tu Keycloak (host y puerto)
  2. Username: el nombre de usuario creado y configurado para la integración.
  3. Password: la contraseña asignada al usuario.
  4. Realm: el nombre del realm (o reino) que integrarás.
  5. client_secret: el cliente_secret (obtenido en la pestaña Credentials del cliente `admin-cli`).

Configurar Vor-Tex

Comunicate con nosotros a support@vor-tex.io para que apliquemos las configuraciones en tu cunta de Vor-Tex.

Próximos pasos

Vor-Tex ya está integrado a tu Keycloak. Para probar la integración, protege un método con OAuth2.0.








    • Related Articles

    • Personalización de dominios

      Resumen Por defecto, la plataforma ofrece dominios bajo *.vor-tex.io, aunque puede utilizar dominios propios. Configurar dominios Para configurar los dominios de su Portal del desarrollador y entornos del API Gateway, el adminsitrador de su dominio ...

    • Crear y configurar API

      Resumen Las APIs serán expuestas en el portal para desarrolladores. Una API puede contener múltiples versiones, y cada una de las versiones mútiples métodos. Para crear una API debe ir a APIs > Nueva API. Configurar API Al crear una nueva API deberá ...

    • Cómo configurar Variables de contexto

      Resumen Las variables de contexto permiten asociar valores asignados a la cuenta, usuarios y aplicaciones a valores de parámetros de los métodos de las APIs. Al configurar el método de la API puedes releacionar sus parámetros a variables de contexto. ...

    • Configurar privacidad de APIs y métodos

      Resumen Puedes definir la privacidad de tus APIs y métodos para otorgar acceso solo a los usuarios que desees, o revocar los accesos cuando lo requieras. Reglas de privacidad Puedes configurar la visibilidad de las APIs y los métodos, es decir, si ...

    • Configurar Spool en origen de datos

      Introducción Spool es una funcionalidad que permite entregar grandes volúmenes de datos en las APIs. Por buenas prácticas las APIs entregan de forma sincrónica hasta un máximo de 10.000 registros, aunque en algunos casos de uso puede ser necesario ...