Recursos disponibles

UiPath® expone las siguientes API:

• API de Orchestrator

• API de Test Manager

• Acceso a la API de gestión de la plataforma

  • Auditoría: recuperar y descargar los registros de auditoría de la organización.

  • Licencias: recuperar y asignar licencias.

  • Identidad: crear, actualizar o eliminar cuentas y gestionar la configuración de la organización.

• API de Document Understanding

• API de AI Center

• API de Mercado de UiPath

• API de UiPath Academy

• API de StudioWeb

• Acceso a la API de contextualización
• PIMS
• Acceso a la API de Process Mining
• Acceso a la API de seguimiento

• API de Data Fabric

• IXP.ServicioExterno

Esta guía está dedicada al acceso a los recursos dentro del contexto de la plataforma (gestión de la plataforma) para la organización. Consulta la documentación específica del producto para obtener información sobre las API basadas en productos.

Nota: Además, las API de gestión de la plataforma están siendo objeto de un proceso de mejora funcional que puede provocar cambios en los puntos finales. Por ello, las API actuales están marcadas como Vista previa en nuestra documentación de referencia.

Auditoría

• GET /audit_/api/auditlogs: recupera los registros de auditoría de la organización.
• GET /audit_/api/auditlogs/download: descarga los registros de auditoría de la organización.

Grupo

• GET 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).
• GET /identity_/api/Group/{partitionGlobalId}/{groupId}: recupera el grupo local o integrado especificado en el ID de partición especificado.
• POST /identity_/api/Group: crea un nuevo grupo local.
• PUT /identity_/api/Group/{groupId}: actualiza la información de un grupo local.
• DELETE /identity_/api/Group/{partitionGlobalId}: elimina todos los grupos locales del ID de partición especificado (tanto de la organización como del tentant).
• DELETE /identity_/api/Group/{partitionGlobalId}/{groupId} : elimina el grupo local especificado.

Cuenta de Robot

• GET /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).
• GET /identity_/api/RobotAccount/{partitionGlobalId}/{robotAccountId}: recupera la cuenta de robot especificada en el ID de partición especificado.
• POST /identity_/api/RobotAccount: crea una nueva cuenta de robot.
• PUT /identity_/api/RobotAccount/{robotAccountId}: actualiza la información de la cuenta del robot especificada.
• DELETE /identity_/api/RobotAccount/{partitionGlobalId}/{robotAccountId}: elimina la cuenta de robot especificada.
• DELETE /identity_/api/RobotAccount/{partitionGlobalId}: elimina todas las cuentas de robot en el ID de partición especificado.

Configuración

• GET /identity_/api/Setting: recupera la configuración de una aplicación según una lista de claves para un tenant específico.
• PUT /identity_/api/Setting: actualiza o crea nuevas configuraciones en un tenant específico.

Certificados SAML

• PUT https://cloud.uipath.com/{organizationName}/identity_/api/SamlCertificate/primary : carga o actualiza el certificado SAML principal.
• PUT https://cloud.uipath.com/{organizationName}/identity_/api/SamlCertificate/secondary –

  Carga o actualiza el certificado SAML secundario.

• POST https://cloud.uipath.com/{organizationName}/identity_/api/SamlCertificate/{partitionGlobalId}/switch : cambia el certificado secundario para que se convierta en el certificado principal.
• GET https://cloud.uipath.com/{organizationName}/identity_/api/SamlCertificate/{partitionGlobalId}/certificates : obtener el par de certificados para la organización.
• DELETE https://cloud.uipath.com/{organizationName}/identity_/api/SamlCertificate/{partitionGlobalId}/{certificateId} : elimina un certificado en función de su ID.

Usuario

• GET /identity_/api/User/{userId}: recupera información sobre el usuario especificado.
• POST /identity_/api/User/{userId}/changepassword: actualiza la contraseña para el usuario especificado.
• PUT /identity_/api/User/{userId}: actualiza la información de usuario específica.
• DELETE /identity_/api/User: elimina todos los usuarios.
• DELETE /identity_/api/User/{userId}: elimina el usuario especificado.

Asignación de licencias

• GET /lease_/api/account​/{accountId}​/user-license​/group​/{groupId}: recupera una lista de todas las licencias de usuario disponibles para crear o editar un grupo.
• PUT /lease_/api/account/{accountId}/user-license/group/{groupId}: asigna o actualiza una regla de grupo.