Get organization-level effective access

Organization-level effective access API for retrieving a principal's roles and assignments across active tenants in Automation 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.

Point de terminaison de l’API

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

Remplacez {accessURL} par l'URL de base de votre plate-forme cloud :

Cloud Platform	URL d'accès
Automation Cloud	https://cloud.uipath.com
Automation Cloud pour le Secteur public	https://govcloud.uipath.us
Cloud d'automatisation dédié	https://{customURL}.dedicated.uipath.com

Autorisations

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

En-têtes de requête.

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

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

Paramètres de requête

Paramètre de requête	Type de données	Description
top	Entier	Maximum number of role-assignment groups to return. The default is 10, and the maximum is 50. The value cannot be negative.
skip	Entier	Number of role-assignment groups to skip. The default is 0, and the value cannot be negative.

Corps de la requête

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

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

Propriété	Type de données	Description
securityPrincipalId	Chaîne (GUID)	Identifier of the user, group, or external application whose effective access is returned.
scopeIdentifier.scopeType	Chaîne de caractères (string)	Must be Organization for organization-level results. The value is case-insensitive.
scopeIdentifier.value.id	Chaîne (GUID)	Optional organization identifier. If included, it must match the caller's organization.
serviceName	Chaîne de caractères (string)	Optional service-name filter. Only assignments for the specified service are returned.
roleNameStartsWith	Chaîne de caractères (string)	Optional role-name prefix filter. Only assignments whose role name starts with the specified value are returned.

Réponses

200 OK

Returns the effective access information for the requested security principal.

Response property	Description
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 Requête incorrecte

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

401 Non autorisé

Returned when the bearer token is missing or invalid.

403 Forbidden

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

Exemple de requête

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