Get organization-level effective access

Organization-level effective access API for retrieving a principal's roles and assignments across active tenants in Test Cloud.

Retrieves effective access for a user, group, or external application across an organization. The response combines organization-scoped assignments with tenant-level assignments from every active tenant. Folder-level assignment details are not included.

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

For requests made with a user access token, the caller must be an Organization Administrator. Tenant Administrators receive a 403 Forbidden response.

Solicitar encabezados.

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

For information about obtaining an access token, see Authentication methods.

Parámetros de consulta

Parámetro de consulta	Tipo de datos	Descripción
top	Entero	Maximum number of role-assignment groups to return. The default is 10, and the maximum is 50. The value cannot be negative.
skip	Entero	Number of role-assignment groups to skip. The default is 0, and the value cannot be negative.

Solicitar cuerpo

The following example retrieves organization-level effective access for one security principal:

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

Propiedad	Tipo de datos	Descripción
securityPrincipalId	Cadena (GUID)	Identifier of the user, group, or external application whose effective access is returned.
scopeIdentifier.scopeType	Cadena	Must be Organization for organization-level results. The value is case-insensitive.
scopeIdentifier.value.id	Cadena (GUID)	Optional organization identifier. If included, it must match the caller's organization.
serviceName	Cadena	Optional service-name filter. Only assignments for the specified service are returned.
roleNameStartsWith	Cadena	Optional role-name prefix filter. Only assignments whose role name starts with the specified value are returned.

Respuesta

200 OK

Returns the effective access information for the requested security principal.

Response property	Descripción
roleAssignments	Paginated assignment groups, keyed by tenant and role. Groups without a tenantId contain organization-scoped assignments. Organization-scoped groups appear before tenant-scoped groups.
grantedServicesMetadata	Non-paginated organization-wide list of services for which the principal has a role assignment.
grantedRolesMetadata	Non-paginated organization-wide list of roles granted to the principal.

400 Bad Request

Returned when pagination values are invalid or when scopeIdentifier.value.id does not match the caller's organization.

401 No autorizado

Returned when the bearer token is missing or invalid.

403 Forbidden

Returned when a user-token caller is not an Organization Administrator.

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"
  }
}'