Referencia de API REST

Documentación detallada de la API REST para Containerized Identity Manager en formato Swagger.

Visión general

Las API REST para el Administrador de identidades en contenedores son disponible aquí en el formato Swagger.

Nota: Para obtener información sobre las API de lote de asignación de acceso, consulte este tema.

También puede acceder a estas API REST desde la interfaz de usuario del producto Containerized Identity Manager . Lleve a cabo los pasos siguientes:

Abra la siguiente URL en su navegador web: https://{IP_ADDRESS}:{PORT_NUMBER}/openapi/ui/#/
Aquí:
IP_ADDRESS: Proporcione la dirección IP del entorno de Kubernetes
PORT_NUMBER: Proporcione el número de puerto para Containerized Identity Manager
Aparece una página de índice con la lista de las API REST disponibles para Containerized Identity Manager.

Invocación de las API REST

En esta sección se describe cómo invocar las API REST disponibles para Containerized Identity Manager.

Hay tres categorías de API REST disponibles y la forma en que invoca las API difiere para cada categoría.

API no protegidas

Se puede acceder a estas API con cualquier autenticación. No es necesario que pase ninguna cabecera o cookies adicionales para invocarlas.

Por ejemplo: la API GET “itim/rest/password/configuration” devuelve la configuración de contraseña para Identity Manager.

API protegidas utilizadas para la búsqueda/recuperación de recursos (GET)

El usuario debe estar autenticado y autorizado para realizar la operación. La solicitud debe contener la cookie LtpaToken2 para que el servidor recupere y valide la información de autenticación.

Por ejemplo: la API GET “/itim/rest/systemusers/me” se utiliza para obtener información sobre un usuario que ha iniciado sesión en la cuenta del sistema de Identity Manager.

API protegidas utilizadas para la creación/modificación/supresión de recursos (PUT, POST, DELETE)

El usuario debe estar autenticado y autorizado para realizar la operación. La solicitud debe contener la cookie LtpaToken2 para que el servidor recupere y valide la información de autenticación. Además de esta cookie, también es necesario pasar una cabecera CSRFToken y una cookie csrfToken .

Por ejemplo: la API POST “/itim/rest/people” se utiliza para crear una persona nueva con los atributos especificados.

A continuación, veremos los pasos para recuperar la cookie LtpaToken2 y la señal CSRF:

Recuperación de la cookie LtpaToken2 y la señal CSRF

Realice los pasos siguientes.

Obtenga la cookie LtpaToken2 .

Invocar la siguiente API REST para obtener la cookie LtpaToken2


POST /itim/j_security_check
Headers:
Content-Type: application/x-www-form-urlencoded
Body:
j_username: <username>
j_password: <password>
Response:
200 OK

Cookies de respuesta: LtpaToken2

Recupere la cabecera CSRFToken y la cookie csrfToken .
Invoque la siguiente API REST para recuperar la cabecera CSRFToken y la cookie csrfToken :
```
GET /itim/rest/systemusers/me
Headers:
Cookie: <LtpaToken2 Cookie>
Response:
200 OK
```
Respuesta: 200 OK

Cabeceras de respuesta: CSRFToken: <CSRF Token value>

Cookies de respuesta: csrfToken: <encoded CSRF Token cookie>
Invocación de las API PUT/POST/DELETE REST
Cualquier solicitud de API PUT, POST o DELETE debe contener lo siguiente:
- La cabecera de solicitud debe contener el CSRFToken que el usuario autorizado ha recibido en la cabecera de respuesta de la API de “/itim/rest/systemusers/me” .
- Las cookies de solicitud deben contener la cookie LtpaToken2 .
- Las cookies de solicitud deben contener la cookie csrfToken que se genera invocando la API “/itim/rest/systemusers/me” .

API REST para IM-Software Stack o IM-VA frente a las API REST de Containerized Identity Manager

Debe tener en cuenta una diferencia significativa entre las API REST para Identity Manager-Pila de software o Identity Manager-Dispositivo virtual y las API REST para Containerized Identity Manager.

Para IM-SS o IM-VA, las API REST utilizan la sesión del servidor de aplicaciones para almacenar algunos datos. Por lo tanto, es necesario recuperar y pasar la cookie JSESSIONID para cada solicitud.

Containerized Identity Manager no utiliza la cookie JSESSIONID para invocar las API REST. Sin embargo, debido a este cambio, es necesario pasar la cookie csrfToken para las solicitudes PUT, POST y DELETE.

Esta diferencia debe tenerse en cuenta si tiene previsto migrar de SS o VA a Containerized Identity Manager. Es posible que tenga que modificar la aplicación personalizada.