- Erste Schritte
- Authentication
- Scopes und Berechtigungen
- Plattformverwaltungs-APIs
API-Endpunkt zum Auflösen mehrerer Verzeichnisentitäten anhand ihrer eindeutigen Bezeichner und Typen in einer einzigen Anforderung innerhalb einer Organisation.
Löst mehrere Verzeichnisentitäten anhand ihrer eindeutigen Bezeichner und Typen in einer einzigen Anforderung basierend auf der Organisations-ID auf.
API-Endpunkt
POST {accessURL}/{organizationName}/identity_/api/Directory/BulkResolve/{partitionGlobalId}
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
Folgende Scopes sind erforderlich:
- PM.Verzeichnis
Anforderungsheader
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
Um das {access_token} zu erhalten, müssen Sie sich mit einer der hier beschriebenen Methoden authentifizieren.
Pfadparameter
| Pfadparameter | Datentyp | Beschreibung |
|---|---|---|
partitionGlobalId (erforderlich) | Zeichenfolge (GUID) | Die ID der Organisation, innerhalb derer die Entitäten aufgelöst werden sollen. |
Anforderungstext
Der Anforderungstext gibt die aufzulösenden Entitäten an. Jede Entitäts-ID entspricht dem Entitätstyp beim gleichen Index.
{
"entityIds": [
"aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"aad|b2c3d4e5-f6a7-8901-bcde-f12345678901"
],
"entityTypes": [
"User",
"Group"
]
}
{
"entityIds": [
"aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"aad|b2c3d4e5-f6a7-8901-bcde-f12345678901"
],
"entityTypes": [
"User",
"Group"
]
}
| Eigenschaften | Datentyp | Beschreibung |
|---|---|---|
entityIds (erforderlich) | Array of Strings | Die eindeutigen Bezeichner der aufzulösenden Verzeichnisentitäten. |
entityTypes (erforderlich) | Array of Strings | Die Typen, die den einzelnen Entitäts-IDs entsprechen. Gültige Werte: User, Group, Application. Muss die gleiche Länge wie entityIds haben. |
Antworten
200 OK
Gibt ein Wörterbuch zurück, das jeden Entitätsbezeichner seiner aufgelösten Verzeichnisentität zuordnet. Entitäten, die nicht aufgelöst werden konnten, werden als null zurückgegeben.
{
"aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890": {
"objectType": "DirectoryUser",
"source": "aad",
"identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "john.doe@example.com",
"email": "john.doe@example.com",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe"
},
"aad|b2c3d4e5-f6a7-8901-bcde-f12345678901": {
"objectType": "DirectoryGroup",
"source": "aad",
"identifier": "aad|b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "Engineering Team",
"displayName": "Engineering Team"
}
}
{
"aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890": {
"objectType": "DirectoryUser",
"source": "aad",
"identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "john.doe@example.com",
"email": "john.doe@example.com",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe"
},
"aad|b2c3d4e5-f6a7-8901-bcde-f12345678901": {
"objectType": "DirectoryGroup",
"source": "aad",
"identifier": "aad|b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "Engineering Team",
"displayName": "Engineering Team"
}
}
400 Ungültige Anforderung
Wird zurückgegeben, wenn entityIds und entityTypes unterschiedliche Längen haben oder wenn erforderliche Parameter fehlen.
Beispielanforderung
Angenommen, Sie haben alle Informationen gesammelt, die zum Erstellen des API-Aufrufs erforderlich sind.
- Ihre
{baseURL}ist: https://cloud.uipath.com/{organizationName}/identity_ - Ihre
{access_token}ist:1234(aus Gründen der Länge). - Die
{partitionGlobalId}lautet:3fa85f64-5717-4562-b3fc-2c963f66afa6 - Sie möchten einen Benutzer und eine Gruppe in einem Aufruf auflösen.
Der Aufruf sollte dem folgenden Beispiel ähneln (cURL):
curl --location --request POST 'https://cloud.uipath.com/{organizationName}/identity_/api/Directory/BulkResolve/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
"entityIds": [
"aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"aad|b2c3d4e5-f6a7-8901-bcde-f12345678901"
],
"entityTypes": [
"User",
"Group"
]
}'
curl --location --request POST 'https://cloud.uipath.com/{organizationName}/identity_/api/Directory/BulkResolve/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
"entityIds": [
"aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"aad|b2c3d4e5-f6a7-8901-bcde-f12345678901"
],
"entityTypes": [
"User",
"Group"
]
}'
Hier ist der Antworttext für einen erfolgreichen Aufruf:
{
"aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890": {
"objectType": "DirectoryUser",
"source": "aad",
"identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "john.doe@example.com",
"email": "john.doe@example.com",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe"
},
"aad|b2c3d4e5-f6a7-8901-bcde-f12345678901": {
"objectType": "DirectoryGroup",
"source": "aad",
"identifier": "aad|b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "Engineering Team",
"displayName": "Engineering Team"
}
}
{
"aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890": {
"objectType": "DirectoryUser",
"source": "aad",
"identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "john.doe@example.com",
"email": "john.doe@example.com",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe"
},
"aad|b2c3d4e5-f6a7-8901-bcde-f12345678901": {
"objectType": "DirectoryGroup",
"source": "aad",
"identifier": "aad|b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "Engineering Team",
"displayName": "Engineering Team"
}
}