Gestión de usuarios

Funcionalidad disponible

Las API de gestión de plataforma exponen la siguiente funcionalidad de la plataforma:

Escenarios de gestión	Métodos de autenticación
Gestión de usuarios: crea, actualiza o elimina usuarios o grupos, además de gestionar la configuración de la organización	Aplicaciones externas

URL base

Todas las llamadas a la API de gestión de plataformas se hacen a través de métodos HTTP a la URL base.

Recomendamos cifrar los datos que envíes a través de llamadas API usando el protocolo https.

Nota:

Para implementaciones de Automation Cloud y Automation Suite, todas las URL de Identity Server contienen el segmento /identity_.
Para implementaciones autónomas, todas las URL de Identity Server contienen el segmento /identity.

Lista de recursos

Las API de gestión de plataforma otorgan a tu aplicación control sobre los siguientes recursos:

Gestión de usuarios

Auditoría

OBTENER {BaseURL}/identity/api/AuditQuery/{organizationId} : recupera los registros de auditoría para el ID de organización especificado.
GET {BaseURL}/identity/api/AuditQuery/{organizationId}/download: descarga los registros de auditoría para el ID de organización especificado.

Grupo

OBTENER {BaseURL}/identity/api/Group/{partitionGlobalId} : recupera todos los grupos locales e integrados a partir del ID de partición especificado (ya sea de organización o de tenant).
OBTENER {BaseURL}/identity/api/Group/{partitionGlobalId}/{groupId} : recupera el grupo local o integrado especificado en el ID de partición especificado.
PUBLICAR {BaseURL}/identity/api/Group : crea un nuevo grupo local.
PUT {BaseURL}/identity/api/Group/{groupId} : actualiza la información de un grupo local.
ELIMINAR {BaseURL}/identity/api/Group/{partitionGlobalId} : elimina todos los grupos locales del ID de partición especificado (ya sea de organización o de tenant).
ELIMINAR {BaseURL}/identity/api/Group/{partitionGlobalId}/{groupId} : elimina el grupo local especificado.

Plantilla del mensaje

OBTENER {BaseURL}/identity/api/MessageTemplate : recupera una plantilla de mensaje utilizando el filtro proporcionado.
OBTENER {BaseURL}/identity/api/MessageTemplate/{templateId} : recupera la plantilla de mensaje especificada.
PUT {BaseURL}/identity/api/MessageTemplate/{templateId}: : actualiza la plantilla de mensaje especificada.

Cuenta de Robot

OBTENER {BaseURL}/identity/api/RobotAccount/{partitionGlobalId} : recupera todas las cuentas de robot en el ID de partición especificado (ya sea de organización o de tenant).
OBTENER {BaseURL}/identity/api/RobotAccount/{partitionGlobalId}/{robotAccountId} : recupera la cuenta de robot especificada en el ID de partición especificado.
PUBLICAR {BaseURL}/identity/api/RobotAccount : crea una nueva cuenta de robot.
PUT {BaseURL}/identity/api/RobotAccount/{robotAccountId} : actualiza la información de la cuenta del robot especificada.
DELETE {BaseURL}/identity/api/RobotAccount/{partitionGlobalId}/{robotAccountId}: : elimina la cuenta de robot especificada.
ELIMINAR {BaseURL}/identity/api/RobotAccount/{partitionGlobalId} : elimina todas las cuentas de robot en el ID de partición especificado.

Configuración

OBTENER {BaseURL}/identity/api/Setting : recupera la configuración de una aplicación basada en una lista de claves para un tenant específico.
PUT {BaseURL}/identity/api/Setting : actualiza o crea nuevas configuraciones en un tenant específico.

Usuario

OBTENER {BaseURL}/identity/api/User/{userId} : recupera información sobre el usuario especificado.
PUBLICAR {BaseURL}/identity/api/User : crea un nuevo usuario. Este punto final es idempotente: intentar sobrescribir un usuario elimina el existente.
PUBLICAR {BaseURL}/identity/api/User/BulkCreate : crea usuarios en masa.
POST {BaseURL}/identity/api/User/{userId}/ changepassword: actualiza la contraseña para el usuario especificado.
PUT {BaseURL}/identity/api/User/{userId}: actualiza la información del usuario especificada.
ELIMINAR {BaseURL}/identity/api/User : elimina todos los usuarios.
ELIMINAR {BaseURL}/identity/api/User/{userId} : elimina el usuario especificado.

UserLoginAttempt

OBTENER {BaseURL}/identity/api/User/{userId}/loginAttempts : recupera los intentos de inicio de sesión del usuario especificado.

Ámbitos por recurso de API

Los ámbitos definen el nivel de acceso de tu aplicación a los recursos de gestión de plataforma.

Por ejemplo, para generar un token de autenticación para tu aplicación, atraviesas varios ámbitos. Cuando tu aplicación realiza una llamada a la API para acceder a un recurso, el token es validado frente a los ámbitos del recurso. Si el recurso está incluido en los ámbitos que atravesaste con una solicitud token, la llamada tiene éxito y verifica permisos de usuario por punto final (Consulta permisos para solicitudes GET y Escribir permisos para solicitudes POST, PUT o DELETE). De lo contrario, el servidor rechaza la llamada.

Permisos por punto final

Los permisos otorgan a tu aplicación el acceso a una funcionalidad específica dentro de un recurso. Cada permiso está vinculado a un ámbito. Cuando tu aplicación haya accedido al recurso correctamente, el servidor verificará si el usuario autenticado tiene el permiso adecuado para el método correspondiente del punto final.

Por ejemplo, puedes permitir a algunos usuarios ver grupos de usuarios, pero no eliminarlos o actualizarlos.

Los métodos GET requieren, por defecto, permisos de lectura, mientras que los métodos POST, PUT y DELETE requieren permisos de escritura.

Lista de ámbitos y permisos

Gestión de usuarios

La siguiente tabla resume los ámbitos y permisos necesarios para realizar una acción específica:

Recurso	Ámbitos	Permisos
Consulta de auditoría	PM.Audit	PM.Audit.Read (para solicitudes GET)
Grupo	PM.Group	P. M. Group.Read (para solicitudes GET) PM.Group.Write (para solicitudes POST, PUT y DELETE)
Plantilla del mensaje	PM.MessageTemplate	PM.MessageTemplate.Read (para solicitudes GET) PM.MessageTemplate.Write (for PUT requests)
Cuenta de Robot	PM.RobotAccount	PM.RobotAccount.Read (para solicitudes GET) P. M. UiPath RobotAccount.Write (para solicitudes POST, PUT y DELETE)
Configuración	PM.Setting	P. M. Setting.Read (para solicitudes GET) P. M. Setting.Write (para solicitudes PUT)
Usuario	PM.User	P. M. User.Read (para solicitudes GET) P. M. User.Write (para solicitudes POST, PUT o DELETE)
UserLoginAttempt	PM.UserLoginAttempt	PM.UserLoginAttempt.Read (para solicitudes GET)