- Erste Schritte
- Authentication
- Scopes und Berechtigungen
- Plattformverwaltungs-APIs
- API-Ratenlimits für Identity Server
- Abrufen von partitionGlobalId zur API-Verwendung
- Warnungen
- Erhalten Sie effektiven Zugriff auf Organisationsebene
- Exportieren von Benutzerrollenzuweisungen
API für effektiven Zugriff auf Organisationsebene zum Abrufen der Rollen und Zuweisungen eines Prinzipals über aktive Mandanten in Test Cloud hinweg.
Ruft den effektiven Zugriff für einen Benutzer, eine Gruppe oder eine externe Anwendung in einer Organisation ab. Die Antwort kombiniert organisationsbezogene Zuweisungen mit Zuweisungen auf Mandantenebene von jedem aktiven Mandanten. Zuweisungsdetails auf Ordnerebene sind nicht enthalten.
API-Endpunkt
POST {accessURL}/{organizationName}/pdp_/api/geteffectiveaccess
Ersetzen Sie {accessURL} 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 |
Berechtigungen
Für Anforderungen, die mit einem Benutzerzugriffstoken gestellt werden, muss der Aufrufer ein Organisationsadministrator sein. Tenant Administrators erhalten eine 403 Forbidden Antwort.
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 Standardwert ist 10, der Maximum ist 50. Der Wert darf nicht negativ sein. |
skip | Integer | Anzahl der zu überspringenden Rollenzuweisungsgruppen. Der Standardwert ist 0 und der Wert darf nicht negativ sein. |
Anforderungstext
Im folgenden Beispiel wird der effektive Zugriff auf Organisationsebene für einen Sicherheitsprinzipal abgerufen:
{
"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, dessen effektiver Zugriff zurückgegeben wird. |
scopeIdentifier.scopeType | String | Muss Organization für Ergebnisse auf Organisationsebene sein. Beim Wert wird die Groß-/Kleinschreibung nicht berücksichtigt. |
scopeIdentifier.value.id | Zeichenfolge (GUID) | Optionaler Organisationsbezeichner. Wenn sie enthalten ist, muss sie mit der Organisation des Aufrufers übereinstimmen. |
serviceName | String | Optionaler Dienstnamenfilter. Nur Zuweisungen für den angegebenen Dienst werden zurückgegeben. |
roleNameStartsWith | String | Optionaler Filter für Rollennamenpräfix. 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, verschlüsselt nach Mandant und Rolle. Gruppen ohne tenantId enthalten organisationsbezogene Zuweisungen. Organisationsbezogene Gruppen werden vor mandantenbezogenen Gruppen angezeigt. |
grantedServicesMetadata | Nicht paginierte organisationsweite Liste von Diensten, für die der Prinzipal eine Rollenzuweisung hat. |
grantedRolesMetadata | Nicht paginierte organisationsweite Liste der Rollen, die dem Prinzipal gewährt wurden. |
400 Ungültige Anforderung
Wird zurückgegeben, wenn Paginierungswerte ungültig sind oder wenn scopeIdentifier.value.id nicht mit der Organisation des Aufrufers übereinstimmt.
401 Nicht autorisiert
Wird zurückgegeben, wenn das Bearer-Token fehlt oder ungültig ist.
403 Forbidden
Wird zurückgegeben, wenn ein Benutzertoken-Aufrufer kein Organisationsadministrator 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"
}
}'