Exporter les attributions de rôles utilisateur

Exporte un rapport contenant tous les rôles et toutes les attributions de rôles associés à n’importe quel produit UiPath®.

Collection Postman

Pour utiliser l’API d’exportation Vérifier l’accès, téléchargez et importez la collection Postman dans votre application Postman.

Remarque :

Lorsque vous utilisez la collection Postman, vous pouvez rencontrer des erreurs lorsque la réponse est supérieure à 50 Mo. Ce paramètre sur Postman peut être modifié (dans les versions Desktop et Web) en accédant à Paramètres, puis en sélectionnant Général, puis en définissant la Taille maximale de la réponse sur zéro Mo.

Point de terminaison de l’API

GET {accessURL}/<yourorgname>/pap_/api/userroleassignments/export

Remplacez {accessURL} dans tous les chemins de point de terminaison par l'URL de base de votre plate-forme cloud :

Cloud Platform	URL d'accès
Test Cloud	https://cloud.uipath.com/
Test Cloud Secteur Public	https://govcloud.uipath.us/
Test Cloud dédié	https://{customURL}.dedicated.uipath.com/

Étendues

• Nécessite des étendues utilisateur au niveau de la plate-forme.
• Ce point de terminaison nécessite un jeton d'accès utilisateur ou un jeton S2S pris en charge.
• Les jetons uniquement à l’application (flux d’informations d’identification du client ) utilisant des étendues d’application ne sont pas pris en charge et entraîneront une réponse 403 Forbidden .
• Lors de la configuration d'une application externe, veillez à ce que :
  • Les étendues demandées sont des étendues d'utilisateur, et non des étendues d'application.
  • Le jeton est généré via un flux d'authentification utilisateur ou via une configuration S2S approuvée.

En-têtes de requête.

--header 'Authorization: Bearer {access_token}'\

Remarque :

Le jeton d’accès doit être :

• Un jeton d’accès utilisateur, ou
• Un jeton S2S pris en charge. Les jetons générés à l’aide du flux d’informations d’identification du client avec les étendues d’application ne sont pas pris en charge pour ce point de terminaison.

Paramètres de requête

Paramètre de requête	Type de données	Description
exportoutputtype (requis)	string	Spécifiez l'un des deux formats de fichier disponibles : .json ou .csv
expandgroupmemberships (requis)	string	true : permet d'étendre les adhésions au groupe AAD dans la réponse. false ou manquant - Les membres AAD qui font partie de groupes locaux ne sont pas visibles dans le rapport.

Réponses

200 OK

Le rapport sur les rôles d'utilisateur et les téléchargements d'attribution de rôles sur votre machine, au format .json ou .csv .

Exemple de requête

curl --location -- request GET 'https://cloud.uipath.com/acmeorg/pap_/api/userroleassignments/export?exportoutputtype=json' \
--header 'Authorization: Bearer {your token}

Le corps de la réponse suivante représente une récupération réussie du rôle de l'utilisateur et de l'affectation des rôles :

[
    {
        "Id": "34ecc3f3-a582-4cad-9889-120d7a3ffd62",
        "RoleUniqueName": "DOCUMENTUNDERSTANDING.DU VIEWER",
        "RoleDescription": "Can view all the entities but has not rights to edit or delete them.",
        "SecurityPrincipalId": "cdc34b5b-77d2-4ae1-9744-209d21ce557d",
        "RoleAssignmentType": "BuiltIn",
        "RoleType": "BUILTIN",
        "Scope": "/",
        "OrganizationId": "feb0dd79-85b6-483b-b297-0e49a1aa5b7d",
        "TenantId": null,
        "CreatedBy": "7f36fcc2-b822-430b-ae30-5ecfbacac186",
        "CreatedOn": "2023-03-30T08:30:04.9346766+00:00"
    },
...
]

Le tableau suivant décrit les champs d'en-tête du fichier exporté :

Champ	Description
Id	L’identifiant unique de l’attribution de rôle.
RoleName	Le nom du rôle tel qu'affiché dans l'interface. Par exemple, Folder Administrator
IDRôle	L’identificateur unique du rôle.
DescriptionRôle	La description du rôle, telle qu'affichée dans l'interface. Par exemple, Folder Administrator Par exemple, Folder Administrator
Type de rôle	Le type de rôle, tel que défini par l'utilisateur ou le système : Personnalisé : rôle défini par un utilisateur. Intégré : Rôle présent par défaut dans le portail d’administration.
TypeAffectationRôle	Le type d'affectation du rôle lors de sa création, qui peut être l'une des deux options suivantes : Personnalisé : affectation effectuée par l'utilisateur. Intégré : affectation effectuée par défaut dans le portail d’administration.
Portée	L’étendue est un niveau spécifique de la hiérarchie organisationnelle qui sert de limite pour certaines actions, autorisations et objets. Une étendue peut être l'une des options hiérarchiques suivantes, représentées sous forme d'ID : Organisation Locataire Service Dossier
ÉtendueAvecNomsComplet	L’étendue est un niveau spécifique de la hiérarchie organisationnelle qui sert de limite pour certaines actions, autorisations et objets. Une étendue peut être l'une des options hiérarchiques suivantes : Organisation Locataire Service Dossier
ServiceName	Le nom du service UiPath auquel appartient le rôle.
IDPrincipalSécurité	L’identifiant unique de l’identité d’un utilisateur, d’un groupe, etc.
TypePrincipalSécurité	Le type d'identité d'un utilisateur, d'un groupe ou d'un robot.
EmailSécuritéPrincipal	L'e-mail de l'utilisateur. Ce champ est vide lorsque l'identité ne correspond pas à un utilisateur.
NomAffichagePrincipalSécurité	Nom de l'identité. Ce champ est vide en cas d'utilisateurs d'annuaire.
HéritéDeNomGroupe	Le nom du groupe à partir duquel l'attribution de rôle est héritée.
HéritéDepuisIDGroupe	L'identifiant du groupe à partir duquel l'attribution de rôle est héritée.
NomLocataire	Le nom du locataire où l'affectation est effectuée. Ce champ est vide en cas d'affectations au niveau de l'organisation.
NomOrganisation	Le nom de l'organisation où l'affectation est effectuée.
OrganizationId	L'identifiant de l'organisation où l'affectation est effectuée.
TenantId	L'identifiant du locataire où l'affectation est effectuée. Ce champ est vide en cas d'affectations au niveau de l'organisation.
CreatedBy	L'identifiant unique de l'utilisateur qui crée l'affectation.
CrééParNomComplet	Nom de l’utilisateur qui crée l’affectation.
Date de création	L’horodatage auquel le rôle est attribué.
NomDossier	Le nom du dossier associé à l’affectation.
FolderKey	L'identifiant unique du dossier associé à l'affectation.
ProjectId	L'ID du projet associé à l' Document Understanding .