Obtenir l'accès effectif au niveau de l'organisation

API d'accès efficace au niveau de l'organisation permettant de récupérer les rôles et les affectations d'un principal entre les locataires actifs dans Automation Cloud.

Récupère l'accès efficace pour un utilisateur, un groupe ou une application externe dans une organisation. La réponse combine les affectations de l'étendue 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 d'utilisateur, l'appelant doit être un administrateur de l'organisation. Les administrateurs des locataires 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'affectation de rôles à 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'affectation de rôles à 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 l'accès efficace au niveau de l'organisation pour une entité 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 est insensible à 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 facultatif de nom de service. Seules les affectations du service spécifié sont renvoyées.
roleNameStartsWith	Chaîne de caractères (string)	Filtre facultatif de préfixe du nom de 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 efficaces pour l'entité de sécurité demandée.

Propriété de la réponse	Description
roleAssignments	Groupes d'affectation paginés, indexés par locataire et rôle. Les groupes sans un tenantId contiennent des affectations au niveau de l'organisation. Les groupes dont l'étendue est limitée à l'organisation apparaissent avant les groupes dont l'étendue est limitée au locataire.
grantedServicesMetadata	Liste de services non paginée à l'échelle de l'organisation pour lesquels l'entité a une affectation de rôle.
grantedRolesMetadata	Liste non paginée à l'échelle de l'organisation des rôles accordés à l'entité.

400 Requête incorrecte

Renvoyé lorsque les valeurs de pagination ne sont pas valides ou quand 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 à 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"
  }
}'