Obtener acceso efectivo en el nivel de organización

API de acceso efectivo a nivel de organización para recuperar los roles y asignaciones de un director en tenants activos en Test Cloud.

Recupera el acceso efectivo para un usuario, grupo o aplicación externa en una organización. La respuesta combina asignaciones de ámbito de organización con asignaciones a nivel de tenant de cada tenant activo. No se incluyen los detalles de la asignación a nivel de carpeta.

Punto final de API

POST {accessURL}/{organizationName}/pdp_/api/geteffectiveaccess

Sustituye {accessURL} por la URL base de tu plataforma en la nube:

Cloud Platform	URL de acceso
Test Cloud	https://cloud.uipath.com
Test Cloud Sector Público	https://govcloud.uipath.us
Test Cloud Dedicado	https://{customURL}.dedicated.uipath.com

Permisos

Para las solicitudes realizadas con un token de acceso de usuario, la persona que llama debe ser un administrador de la organización. Los administradores de tenants reciben una respuesta 403 Forbidden.

Solicitar encabezados.

Authorization: Bearer {access_token}
Content-Type: application/json

Para obtener información sobre cómo obtener un token de acceso, consulta Métodos de autenticación.

Parámetros de consulta

Parámetro de consulta	Tipo de datos	Descripción
top	Entero	Número máximo de grupos de asignación de roles que se devolverán. El valor predeterminado es 10 y el máximo es 50. El valor no puede ser negativo.
skip	Entero	Número de grupos de asignación de roles que se omitirán. El valor predeterminado es 0, y el valor no puede ser negativo.

Solicitar cuerpo

El siguiente ejemplo recupera el acceso efectivo a nivel de organización para un principal de seguridad:

{
  "securityPrincipalId": "00000000-0000-0000-0000-000000000001",
  "scopeIdentifier": {
    "scopeType": "Organization"
  }
}

Propiedad	Tipo de datos	Descripción
securityPrincipalId	Cadena (GUID)	Identificador del usuario, grupo o aplicación externa cuyo acceso efectivo se devuelve.
scopeIdentifier.scopeType	Cadena	Debe ser Organization para los resultados en el nivel de organización. El valor no distingue entre mayúsculas y minúsculas.
scopeIdentifier.value.id	Cadena (GUID)	Identificador de organización opcional. Si se incluye, debe coincidir con la organización de la persona que llama.
serviceName	Cadena	Filtro de nombre de servicio opcional. Solo se devuelven las asignaciones para el servicio especificado.
roleNameStartsWith	Cadena	Filtro de prefijo de nombre de rol opcional. Solo se devuelven las asignaciones cuyo nombre de rol comienza con el valor especificado.

Respuesta

200 OK

Devuelve la información de acceso efectiva para el principal de seguridad solicitado.

Propiedad de respuesta	Descripción
roleAssignments	Grupos de asignación paginados, codificados por tenant y rol. Los grupos sin tenantId contienen asignaciones de ámbito de organización. Los grupos de ámbito de organización aparecen antes de los grupos de ámbito de tenant.
grantedServicesMetadata	Lista no paginada de servicios de toda la organización para los que el director tiene una asignación de roles.
grantedRolesMetadata	Lista no paginada de roles de toda la organización otorgados al director.

400 Bad Request

Se devuelve cuando los valores de paginación no son válidos o cuando scopeIdentifier.value.id no coincide con la organización de la persona que llama.

401 No autorizado

Se devuelve cuando falta el token al portador o no es válido.

403 Forbidden

Se devuelve cuando una persona que llama con token de usuario no es un administrador de la organización.

Solicitud de ejemplo

curl --location --request POST 'https://cloud.uipath.com/{organizationName}/pdp_/api/geteffectiveaccess?top=10&skip=0' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "securityPrincipalId": "00000000-0000-0000-0000-000000000001",
  "scopeIdentifier": {
    "scopeType": "Organization"
  }
}'