Verzeichnis durchsuchen

Search Directory-API-Endpunkt zum Suchen von Benutzern, Gruppen oder Anwendungen nach Präfix-String innerhalb einer Organisation in Test Cloud.

Durchsucht das Verzeichnis nach Entitäten (Benutzer, Gruppen oder Anwendungen), die mit einer Präfixzeichenfolge übereinstimmen, basierend auf der Organisations-ID.

API-Endpunkt

GET {accessURL}/{organizationName}/identity_/api/Directory/Search/{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'

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, in der gesucht werden soll.

Abfrageparameter

Abfrageparameter	Datentyp	Beschreibung
startsWith (erforderlich)	String	Die Präfixzeichenfolge, nach der gesucht werden soll. Die Ergebnisse stimmen mit Entitäten überein, deren Name, E-Mail-Adresse oder Anzeigename mit diesem Wert beginnt.
entityType (optional)	String	Der Typ der Verzeichnisentität, nach der gesucht werden soll. Gültige Werte: User, Group, Application. Kann nicht zusammen mit sourceFilter verwendet werden.
sourceFilter (optional)	Array of Strings	Filtert Ergebnisse nach Quelle. Gültige Werte: LocalUsers, DirectoryUsers, LocalGroups, DirectoryGroups, RobotAccounts, Applications. Kann nicht zusammen mit entityType verwendet werden.
scope (optional)	String	Optionaler Scope, der für Entitäten in Active Directory verwendet wird.

Antworten

200 OK

Gibt eine Liste der Verzeichnisentitäten zurück, die den Suchkriterien entsprechen.

[
    {
        "source": "aad",
        "identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "identityName": "[e-mail]",
        "displayName": "John Doe",
        "email": "[e-mail]",
        "type": "User",
        "objectType": "DirectoryUser"
    },
    {
        "source": "aad",
        "identifier": "aad|b2c3d4e5-f6a7-8901-bcde-f12345678901",
        "identityName": "Engineering Team",
        "displayName": "Engineering Team",
        "email": null,
        "type": "Group",
        "objectType": "DirectoryGroup"
    }
]

400 Ungültige Anforderung

Wird zurückgegeben, wenn sowohl entityType als auch sourceFilter angegeben sind 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 nach Benutzern suchen, deren Name mit „john“ beginnt.

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

curl --location --request GET 'https://cloud.uipath.com/{organizationName}/identity_/api/Directory/Search/3fa85f64-5717-4562-b3fc-2c963f66afa6?startsWith=john&entityType=User' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'

Hier ist der Antworttext für einen erfolgreichen Aufruf:

[
    {
        "source": "aad",
        "identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "identityName": "[e-mail]",
        "displayName": "John Doe",
        "email": "[e-mail]",
        "type": "User",
        "objectType": "DirectoryUser"
    }
]