orchestrator
2024.10
true
UiPath logo, featuring letters U and I in white

Guía de la API de Orchestrator

Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Última actualización 11 de nov. de 2024

Solicitudes de usuario

Nota:
  • Las solicitudes GET a los puntos finales /odata/Users o /odata/Users({}) devuelven un dominio vacío para los usuarios de AD.
  • Las solicitudes GetOrganizationUnits(Id) y GetRoles(Id) solo devuelven carpetas y roles establecidos explícitamente para un usuario aprovisionado automáticamente. Los heredados de la configuración del grupo pueden recuperarse a través del punto final /api/DirectoryService/GetDirectoryPermissions?userId={userId}.

Eliminar un usuario

Eliminar

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Users(446)

Solicitar encabezados.

Clave

Valor

Autorización

Portador

Código de respuesta

204 Sin contenido

Cambiar el idioma

El siguiente ejemplo le permite cambiar el idioma del usuario con el ID 749 al japonés.

Publicar

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Users(749)/UiPath.Server.Configuration.OData.ChangeUserCulture

Solicitar encabezados.

Clave

Valor

Autorización

Portador

Solicitar cuerpo

{
    "culture": "ja"
}{
    "culture": "ja"
}

Código de respuesta

200 OK

Aprovisionar un robot para un usuario

PONER

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Users(13)

Solicitar encabezados.

Clave

Valor

Autorización

Portador

Solicitar cuerpo

{
  "RobotProvision": {
     "UserName": "uipath\\john.smith",
     "RobotId": 53,
     "RobotType": "Development",
     "ExecutionSettings": {}
  }
}{
  "RobotProvision": {
     "UserName": "uipath\\john.smith",
     "RobotId": 53,
     "RobotType": "Development",
     "ExecutionSettings": {}
  }
}

Código de respuesta

200 OK

Asignar roles

Puedes usar este punto final para asignar uno o más roles al ID de usuario especificado, que puede ser el ID de un grupo, una cuenta de usuario o una cuenta de robot.

Publicar

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Users(9)/UiPath.Server.Configuration.OData.AssignRoles

Solicitar encabezados.

Clave

Valor

Autorización

Portador

Solicitar cuerpo

{
  "roleIds": [
    1,3
  ]
}{
  "roleIds": [
    1,3
  ]
}

Ejemplo

La siguiente solicitud actualiza la cuenta o el grupo con el ID de usuario 9 sobrescribiendo sus roles asignados con los roles que tienen los ID 1 y 3.

Roles antes de la solicitud

Roles después de la solicitud

seleccionados

Sin roles

1 y 3
Se han asignado roles con los ID 1 y 3 .
Roles con ID 1 y 2
1 y 3
Se eliminó el rol con ID 2 y se asignó el rol con ID 3.
Rol con ID 2
1 y 3
Se eliminó el rol con el ID 2 0} y se asignaron los roles con los ID 1 y 3 .

cURL

curl -X POST "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Users({key})/UiPath.Server.Configuration.OData.AssignRoles" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"roleIds\": [ {RoleID1},{RoleID2} ] }"

IU de Swagger (disponible en https://https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/swagger)


Paso a paso

A continuación, se muestra un procedimiento de ejemplo sobre cómo asignar roles a una cuenta:

  1. Realiza una solicitud GET en /odata/Roles para recuperar la lista de roles.

    Puedes usar cualquier tipo de filtro compatible con OData, si es necesario.

  2. Anota los ID de los roles que quieres asignar.
  3. Realiza una solicitud GET en /odata/Users para recuperar la lista de cuentas.

    La lista incluye grupos, cuentas de usuario y cuentas de robots.

    Puedes usar cualquier tipo de filtro compatible con OData, si es necesario.

  4. Anota los ID de las cuentas a las que quieres asignar roles.
  5. Realiza una solicitud POST a /odata/Users({key})/UiPath.Server.Configuration.OData.AssignRoles para cada cuenta a la que quieras asignar roles.
    • {key} es un ID de cuenta único para la cuenta a la que desea asignar roles
    • {roleID} es un ID único de rol para el rol que desea asignar; puedes enumerar varios ID, separados por comas.

¿Te ha resultado útil esta página?

Obtén la ayuda que necesitas
RPA para el aprendizaje - Cursos de automatización
Foro de la comunidad UiPath
Uipath Logo White
Confianza y seguridad
© 2005-2024 UiPath. Todos los derechos reservados.