Résolution en bloc des entités d'annuaire

Résout plusieurs entités de répertoire par leurs identifiants et types uniques dans une seule requête, en fonction de l’ID de l’organisation.

Point de terminaison de l’API

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

Remplacez {accessURL} dans tous les chemins de point de terminaison par l'URL de base de votre plate-forme cloud :

Cloud Platform	URL d'accès
Test Cloud	https://cloud.uipath.com/
Test Cloud Secteur Public	https://govcloud.uipath.us/
Test Cloud dédié	https://{customURL}.dedicated.uipath.com/

Étendues

Nécessite les étendues suivantes :

• PM.Répertoire

En-têtes de requête.

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

Remarque :

Pour obtenir le {access_token}, assurez-vous de vous authentifier via l'une des méthodes décrites ici.

Paramètres de chemin d'accès

Paramètre du chemin d'accès	Type de données	Description
partitionGlobalId (requis)	Chaîne (GUID)	L'ID de l'organisation au sein de laquelle résoudre les entités.

Corps de la requête

Le corps de la requête spécifie les entités à résoudre. Chaque ID d'entité correspond au type d'entité au même index.

{
    "entityIds": [
        "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "aad|b2c3d4e5-f6a7-8901-bcde-f12345678901"
    ],
    "entityTypes": [
        "User",
        "Group"
    ]
}

Propriété	Type de données	Description
entityIds (requis)	Tableau de chaînes	Les identificateurs uniques des entités d'annuaire à résoudre.
entityTypes (requis)	Tableau de chaînes	Les types correspondant à chaque ID d'entité. Valeurs valides: User, Group, Application. Doit être de la même longueur que entityIds.

Réponses

200 OK

Renvoie un dictionnaire mappant chaque identifiant d'entité à son entité de répertoire résolue. Les entités qui n'ont pas pu être résolues sont renvoyées en tant que null.

{
    "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890": {
        "objectType": "DirectoryUser",
        "source": "aad",
        "identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "name": "[e-mail]",
        "email": "[e-mail]",
        "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 Requête incorrecte

Renvoyé lorsque entityIds et entityTypes ont des longueurs différentes, ou lorsque des paramètres requis sont manquants.

Exemple de requête

Supposons que vous ayez rassemblé toutes les informations nécessaires pour créer l'appel d'API.

• Votre {baseURL} est : https://cloud.uipath.com/{organizationName}/identity_
• Votre {access_token} est : 1234 (pour des considérations de longueur).
• Le {partitionGlobalId} est : 3fa85f64-5717-4562-b3fc-2c963f66afa6
• Vous souhaitez résoudre un utilisateur et un groupe en un seul appel.

L’appel doit ressembler à l’exemple suivant (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"
    ]
}'

Voici la réponse pour un appel réussi :

{
    "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890": {
        "objectType": "DirectoryUser",
        "source": "aad",
        "identifier": "aad|a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "name": "[e-mail]",
        "email": "[e-mail]",
        "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"
    }
}