Exportieren von Benutzerrollenzuweisungen

Exportiert einen Bericht mit allen Rollen und Rollenzuweisungen, die einem UiPath®-Produkt zugeordnet sind.

Postman-Sammlung

Um die Export-API „Zugriff überprüfen“ zu verwenden, laden Sie die Postman-Sammlung in Ihrer Postman-App herunter und importieren Sie sie.

Hinweis:

Bei Verwendung der Postman-Sammlung können Fehler auftreten, wenn die Antwort größer als 50 MB ist. Diese Einstellung in Postman kann geändert werden (in der Desktop- sowie in der Web-Version), indem Sie zu Einstellungen navigieren, dann Allgemein auswählen und dann die Max. Antwortgröße auf null MB festlegen.

API-Endpunkt

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

Ersetzen Sie {accessURL} in allen Endpunktpfaden durch die Basis-URL für Ihre Cloud-Plattform:

Cloud Platform	Zugriffs-URL
Test Cloud	https://cloud.uipath.com/
Test Cloud Public Sector	https://govcloud.uipath.us/
Test Cloud Dedicated.	https://{customURL}.dedicated.uipath.com/

Scopes

• Erfordert Benutzer-Scopes auf Plattformebene.
• Dieser Endpunkt erfordert ein Benutzerzugriffstoken oder ein unterstütztes S2S-Token.
• Nur Anwendungs-Token (Client-Anmeldeinformationen) mit Anwendungs-Scopes werden nicht unterstützt und führen zur Antwort 403 Forbidden .
• Stellen Sie beim Konfigurieren einer externen Anwendung Folgendes sicher:
  • Die angeforderten Scopes sind Benutzer-Scopes, keine Anwendungs-Scopes.
  • Das Token wird über einen Benutzerauthentifizierungsflow (z. B. Autorisierungscodeflow) oder über eine genehmigte S2S-Konfiguration generiert.

Anforderungsheader

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

Hinweis:

Das Zugriffstoken muss entweder sein:

• Ein Benutzerzugriffstoken oder
• Ein unterstütztes S2S-Token. Token, die mithilfe des Flows der Client-Anmeldeinformationen mit Anwendungs-Scopes generiert werden, werden für diesen Endpunkt nicht unterstützt.

Abfrageparameter

Abfrageparameter	Datentyp	Beschreibung
exportoutputtype (erforderlich)	string	Geben Sie eines der beiden verfügbaren Dateiformate an: .json oder .csv
expandgroupmemberships (erforderlich)	string	true – ermöglicht das Erweitern von AAD-Gruppenmitgliedschaften in der Antwort. false oder fehlend – AAD-Mitglieder, die Teil lokaler Gruppen sind, sind im Bericht nicht sichtbar.

Antworten

200 OK

Der Bericht der Benutzerrollen und Rollenzuweisungen wird im Format .json oder .csv auf Ihre Maschine heruntergeladen.

Beispielanforderung

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

Der folgende Antworttext steht für einen erfolgreichen Abruf der Benutzerrolle und der Rollenzuweisung:

[
    {
        "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"
    },
...
]

In der folgenden Tabelle werden die Headerfelder aus der exportierten Datei beschrieben:

Feld	Beschreibung
ID	Der eindeutige Bezeichner der Rollenzuweisung.
RoleName	Der Rollenname, der in der Benutzeroberfläche angezeigt wird. Zum Beispiel Folder Administrator
RollenID	Der eindeutige Bezeichner der Rolle.
Rollenbeschreibung	Die Rollenbeschreibung, wie auf der Benutzeroberfläche angezeigt. Zum Beispiel Folder Administrator Zum Beispiel Folder Administrator
Rollentyp	Der Rollentyp, wie vom Benutzer oder dem System definiert: Benutzerdefiniert : Von einem Benutzer definierte Rolle. Integriert : Rolle ist standardmäßig im Verwaltungsportal vorhanden.
Rollenzuweisungstyp	Der Rollenzuweisungstyp beim Erstellen, der eine der folgenden Optionen sein kann: Benutzerdefiniert : Zuweisung durch den Benutzer. Integriert : Standardmäßige Zuweisung im Verwaltungsportal.
Umfang	Der Scope ist eine bestimmte Ebene in der Organisationshierarchie, die als Grenze für bestimmte Aktionen, Berechtigungen und Objekte dient. Ein Scope kann eine der folgenden hierarchischen Optionen sein, die als IDs dargestellt werden: Organisation Mandant Dienst Ordner
ScopeMitAnzeigenamen	Der Scope ist eine bestimmte Ebene in der Organisationshierarchie, die als Grenze für bestimmte Aktionen, Berechtigungen und Objekte dient. Ein Scope kann eine der folgenden hierarchischen Optionen sein: Organisation Mandant Dienst Ordner
ServiceName	Der Name des UiPath-Diensts, zu dem die Rolle gehört.
Sicherheitsprinzipal-ID	Der eindeutige Bezeichner für die Identität eines Benutzers, einer Gruppe usw.
Sicherheitsprinzipaltyp	Der Identitätstyp eines Benutzers, einer Gruppe oder eines Roboters.
SicherheitsprinzipalEMail	Die E-Mail-Adresse des Benutzers. Dieses Feld ist leer, wenn es sich bei der Identität nicht um einen Benutzer handelt.
AnzeigenameDesSicherheitsprinzipals	Der Name der Identität. Dieses Feld ist bei Verzeichnisbenutzern leer.
GeerbtAusGruppenname	Der Gruppenname, von dem die Rollenzuweisung geerbt wird.
GeerbtAusGruppenID	Gruppenbezeichner, von dem die Rollenzuweisung geerbt wird.
Mandantenname	Der Name des Mandanten, in dem die Zuweisung vorgenommen wird. Dieses Feld ist bei Zuweisungen auf Organisationsebene leer.
Organisationsname	Der Name der Organisation, in der die Zuweisung vorgenommen wird.
OrganizationId	Der Bezeichner der Organisation, in der die Zuweisung vorgenommen wird.
TenantId	Der Bezeichner des Mandanten, in dem die Zuweisung vorgenommen wird. Dieses Feld ist bei Zuweisungen auf Organisationsebene leer.
CreatedBy	Der eindeutige Bezeichner des Benutzers, der die Zuweisung erstellt.
Erstellt von Anzeigename	Der Name des Benutzers, der die Zuweisung erstellt.
Erstellt am	Der Zeitstempel, wann die Rolle zugewiesen ist.
Ordnername	Der Name des Ordners, der der Zuweisung zugeordnet ist.
FolderKey	Der eindeutige Bezeichner des Ordners, der der Zuweisung zugeordnet ist.
ProjectId	Die ID des Projekts (z. B. Document Understanding oder IXP), das der Zuweisung zugeordnet ist.