Bénéficier d’un accès efficace au niveau de l’organisation

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

Récupère l'accès efficace pour un utilisateur, un groupe ou une application externe dans l'ensemble d'une organisation. La réponse combine les affectations au niveau de l’organisation avec les affectations au niveau du locataire de chaque locataire actif. Les détails de l'affectation au niveau du dossier ne sont pas inclus.

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

Pour les demandes effectuées avec un jeton d’accès utilisateur, l’appelant doit être un administrateur de l’organisation. Les Tenant Administrators reçoivent une réponse 403 Forbidden.

En-têtes de requête.

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

Pour plus d’informations sur l’obtention d’un jeton d’accès, consultez la section Méthodes d’authentification.

Paramètres de requête

Paramètre de requête	Type de données	Description
top	Entier	Nombre maximal de groupes d'attribution de rôle à renvoyer. La valeur par défaut est 10 et le maximum est 50. La valeur ne peut pas être négative.
skip	Entier	Nombre de groupes d'attribution de rôle à ignorer. La valeur par défaut est 0 et la valeur ne peut pas être négative.

Corps de la requête

L’exemple suivant récupère un accès efficace au niveau de l’organisation pour un principal de sécurité:

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

Propriété	Type de données	Description
securityPrincipalId	Chaîne (GUID)	Identificateur de l’utilisateur, du groupe ou de l’application externe dont l’accès effectif est renvoyé.
scopeIdentifier.scopeType	Chaîne de caractères (string)	Doit être Organization pour les résultats au niveau de l'organisation. La valeur n'est pas sensible à la casse.
scopeIdentifier.value.id	Chaîne (GUID)	Identificateur d'organisation facultatif. S'il est inclus, il doit correspondre à l'organisation de l'appelant.
serviceName	Chaîne de caractères (string)	Filtre de nom de service facultatif. Seules les affectations au service spécifié sont renvoyées.
roleNameStartsWith	Chaîne de caractères (string)	Filtre facultatif de préfixe du nom du rôle. Seules les affectations dont le nom de rôle commence par la valeur spécifiée sont renvoyées.

Réponses

200 OK

Renvoie les informations d’accès effectives pour le principal de sécurité demandé.

Propriété de la réponse	Description
roleAssignments	Groupes d'affectation paginés, clés par locataire et par rôle. Les groupes sans tenantId contiennent des affectations au niveau de l'organisation. Les groupes au niveau de l'organisation apparaissent avant les groupes au niveau du locataire.
grantedServicesMetadata	Liste de services non paginés à l'échelle de l'organisation pour lesquels le principal se voit attribuer un rôle.
grantedRolesMetadata	Liste non pagination à l'échelle de l'organisation des rôles accordés au principal.

400 Requête incorrecte

Renvoyé lorsque les valeurs de pagination ne sont pas valides ou lorsque scopeIdentifier.value.id ne correspond pas à l’organisation de l’appelant.

401 Non autorisé

Renvoyé lorsque le jeton du porteur est manquant ou non valide.

403 Forbidden

Renvoyé lorsqu'un appelant avec jeton d'utilisateur n'est pas un administrateur de l'organisation.

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