- Erste Schritte
- Authentication
- Scopes und Berechtigungen
- Plattformverwaltungs-APIs
- API-Ratenlimits für Identity Server
- Abrufen von partitionGlobalId zur API-Verwendung
- Warnungen
- Effektiven Zugriff auf Organization-Ebene abrufen
- Exportieren von Benutzerrollenzuweisungen
Effektive Zugriffs-API auf Organisationsebene zum Abrufen der Rollen und Zuweisungen eines Prinzipals für aktive Mandanten in der Automation Cloud.
Ruft den effektiven Zugriff für einen Benutzer, eine Gruppe oder eine externe Anwendung in einer Organization ab. Die Antwort kombiniert Zuweisungen im Organization-Scope mit Zuweisungen auf Mandantenebene von jedem aktiven Mandanten. Zuweisungsdetails auf Ordnerebene sind eingeschlossen.
API-Endpunkt
POST {accessURL}/{organizationName}/pdp_/api/geteffectiveaccess
Ersetzen Sie {accessURL} durch die Basis-URL für Ihre Cloud-Plattform:
| Cloud Platform | Zugriffs-URL |
|---|---|
| Automation Cloud | https://cloud.uipath.com |
| Automation Cloud – Öffentlicher Sektor | https://govcloud.uipath.us |
| Automatisierung – cloudgeeignet | https://{customURL}.dedicated.uipath.com |
Berechtigungen
Anforderungen, die mit einem Benutzerzugriffstoken gemacht werden, müssen von einem Organization Administrator stammen. Mandant Administrators erhalten eine 403 ForbiddenAntwort.
Anforderungsheader
Authorization: Bearer {access_token}
Content-Type: application/json
Authorization: Bearer {access_token}
Content-Type: application/json
Informationen zum Abrufen eines Zugriffstokens finden Sie unter Authentifizierungsmethoden.
Abfrageparameter
| Abfrageparameter | Datentyp | Beschreibung |
|---|---|---|
top | Integer | Maximale Anzahl der zurückzugebenden Rollenzuweisungsgruppen. Der Standard ist 10, und das Maximum ist 50. Der Wert darf nicht negativ sein. |
skip | Integer | Anzahl der zu überspringenden Rollenzuweisungsgruppen. Der Standard ist 0, und der Wert kann nicht negativ sein. |
Anforderungstext
Das folgende Beispiel ruft den effektiven Zugriff auf Organisationsebene für einen Sicherheitsprinzipal ab:
{
"securityPrincipalId": "00000000-0000-0000-0000-000000000001",
"scopeIdentifier": {
"scopeType": "Organization"
}
}
{
"securityPrincipalId": "00000000-0000-0000-0000-000000000001",
"scopeIdentifier": {
"scopeType": "Organization"
}
}
| Eigenschaften | Datentyp | Beschreibung |
|---|---|---|
securityPrincipalId | Zeichenfolge (GUID) | Bezeichner des Benutzers, der Gruppe oder der externen Anwendung, deren effektiver Zugriff zurückgegeben wird. |
scopeIdentifier.scopeType | String | Muss Organization für Ergebnisse auf Organisationsebene sein. Der Wert ist unabhängig von der Groß-/Kleinschreibung. |
scopeIdentifier.value.id | Zeichenfolge (GUID) | Optionaler Organization-Bezeichner. Wenn enthalten, muss er mit der Organization des Anrufers übereinstimmen. |
serviceName | String | Optionaler Dienstnamen-Filter. Nur Zuweisungen für den angegebenen Dienst werden zurückgegeben. |
roleNameStartsWith | String | Optionaler Rollennamen-Präfixfilter. Nur Zuweisungen, deren Rollenname mit dem angegebenen Wert beginnt, werden zurückgegeben. |
Antworten
200 OK
Gibt die effektiven Zugriffsinformationen für den angeforderten Sicherheitsprinzipal zurück.
| Antworteigenschaft | Beschreibung |
|---|---|
roleAssignments | Paginierte Zuweisungsgruppen, die durch Mandant und Rolle definiert werden. Gruppen ohne eine tenantId enthalten Zuweisungen mit Organization-Scope. Gruppen mit Organization-Scope werden vor Gruppen mit Mandanten-Scope angezeigt. |
grantedServicesMetadata | Nicht paginierte organisationsweite Liste der Dienste, für die der Principal eine Rollenzuweisung hat. |
grantedRolesMetadata | Nicht paginierte organisationsweite Liste der Rollen, die dem Prinzipal gewährt werden. |
400 Ungültige Anforderung
Wird zurückgegeben, wenn Paginierungswerte ungültig sind oder nicht mit der Organization des Anrufers scopeIdentifier.value.id übereinstimmen.
401 Nicht autorisiert
Wird zurückgegeben, wenn das Bearer-Token fehlt oder ungültig ist.
403 Forbidden
Wird zurückgegeben, wenn ein Benutzer-Token-Aufrufer kein Organization Administrator ist.
Beispielanforderung
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"
}
}'
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"
}
}'