Automation Cloud – Massenauflösung von Verzeichnisentitäten nach Name

automation-cloud

latest

false

Automation Cloud-API-Handbuch

Massenauflösung von Verzeichnisentitäten nach Name

BulkResolveByName-Endpunkt zum Auflösen mehrerer Verzeichnisentitäten desselben Typs nach Namen in einer einzigen Anforderung, eingeschränkt auf eine bestimmte Organisation.

Löst mehrere Verzeichnisentitäten anhand ihrer Namen in einer einzigen Anforderung auf, basierend auf der Organisations-ID. Alle Entitäten in der Anforderung müssen vom gleichen Typ sein.

API-Endpunkt

POST {accessURL}/{organizationName}/identity_/api/Directory/BulkResolveByName/{partitionGlobalId}

Ersetzen Sie {accessURL} in allen Endpunktpfaden 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/`

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'

Hinweis:

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ätsnamen an. Im Gegensatz zu BulkResolve müssen alle Entitäten vom gleichen Typ sein.

{
    "entityNames": [
        "john.doe@example.com",
        "jane.smith@example.com"
    ],
    "entityType": "User",
    "scope": null
}
{
    "entityNames": [
        "john.doe@example.com",
        "jane.smith@example.com"
    ],
    "entityType": "User",
    "scope": null
}

Eigenschaften	Datentyp	Beschreibung
`entityNames` (erforderlich)	Array of Strings	Die Namen der aufzulösenden Verzeichnisentitäten (z. B. E-Mail-Adressen für Benutzer, Gruppennamen für Gruppen).
`entityType` (erforderlich)	String	Der Typ aller Entitäten in der Anforderung. Gültige Werte: `User`, `Group`, `Application`.
`scope` (optional)	String	Optionaler Scope für Active Directory-Entitäten.

Antworten

200 OK

Gibt ein Wörterbuch zurück, das jeden Entitätsnamen seiner aufgelösten Verzeichnisentität zuordnet. Entitäten, die nicht aufgelöst werden konnten, werden als null zurückgegeben.

{
    "john.doe@example.com": {
        "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"
    },
    "jane.smith@example.com": null
}
{
    "john.doe@example.com": {
        "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"
    },
    "jane.smith@example.com": null
}

400 Ungültige Anforderung

Wird zurückgegeben, wenn erforderliche Parameter fehlen oder ungültig sind.

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 zwei Benutzer anhand ihrer E-Mail-Adressen auflösen.

Der Aufruf sollte dem folgenden Beispiel ähneln (cURL):

curl --location --request POST 'https://cloud.uipath.com/{organizationName}/identity_/api/Directory/BulkResolveByName/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
    "entityNames": [
        "john.doe@example.com",
        "jane.smith@example.com"
    ],
    "entityType": "User"
}'
curl --location --request POST 'https://cloud.uipath.com/{organizationName}/identity_/api/Directory/BulkResolveByName/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
    "entityNames": [
        "john.doe@example.com",
        "jane.smith@example.com"
    ],
    "entityType": "User"
}'

Hier ist der Antworttext für einen erfolgreichen Aufruf:

{
    "john.doe@example.com": {
        "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"
    },
    "jane.smith@example.com": null
}
{
    "john.doe@example.com": {
        "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"
    },
    "jane.smith@example.com": null
}

Auf dieser Seite

API-Endpunkt
Scopes
Anforderungsheader
Pfadparameter
Anforderungstext
Antworten
200 OK
400 Ungültige Anforderung
Beispielanforderung

War diese Seite hilfreich?

Vorherige (previous)Massenauflösung von Verzeichnisentitäten

WeiterRobot-Konto

API-Endpunkt​

Scopes​

Anforderungsheader​

Pfadparameter​

Anforderungstext​

Antworten​

200 OK​

400 Ungültige Anforderung​

Beispielanforderung​