ディレクトリ エンティティを一括解決する

組織 ID に基づいて、単一の要求内の一意の識別子と種類によって複数のディレクトリ エンティティを解決します。

API エンドポイント

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

すべてのエンドポイント パスの {accessURL} は、ご使用のクラウド プラットフォームのベース URL に置き換えてください。

Cloud Platform	アクセス URL
Test Cloud	https://cloud.uipath.com/
Test Cloud (公共部門向け)	https://govcloud.uipath.us/
Test Cloud (専有型)	https://{customURL}.dedicated.uipath.com/

スコープ

次のスコープが必要です。

• Pm。ディレクトリ

要求ヘッダー

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

注:

{access_token}を取得するには、必ずこちらで説明するいずれかの方法で認証を行ってください。

パス パラメーター

パス パラメーター	データ型	説明
partitionGlobalId (必須)	文字列 (GUID)	組織内のエンティティを解決する組織の ID です。

要求本文

要求本文では、解決するエンティティを指定します。各エンティティ ID は、同じインデックスのエンティティの種類に対応します。

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

プロパティ	データ型	説明
entityIds (必須)	String の配列	解決するディレクトリ エンティティの一意の識別子です。
entityTypes (必須)	String の配列	各エンティティ ID に対応する型。有効な値: User、 Group、 Applicationです。entityIdsと同じ長さにする必要があります。

応答

200 OK

各エンティティ識別子を、その解決されたディレクトリ エンティティにマッピングするディクショナリを返します。解決できなかったエンティティは、 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 Bad Request

entityIds と entityTypes の長さが異なる場合、または必要なパラメーターがない場合に返されます。

要求の例

API 呼び出しの構築に必要な情報をすべて収集したとします。

• {baseURL}: https://cloud.uipath.com/{organizationName}/identity_
• {access_token} は 1234 です (長さを考慮)。
• {partitionGlobalId} は 3fa85f64-5717-4562-b3fc-2c963f66afa6 です。
• ユーザーとグループを 1 回の呼び出しで解決する場合。

呼び出しは次の例のようになります (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"
    ]
}'

呼び出しが成功した場合、応答本文は次のようになります。

{
    "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"
    }
}