test-cloud
latest
false
- 基本情報
- 認証
- 範囲と権限
- プラットフォーム管理 API
重要 :
このコンテンツの一部は機械翻訳によって処理されており、完全な翻訳を保証するものではありません。
新しいコンテンツの翻訳は、およそ 1 ～ 2 週間で公開されます。
Test Cloud API ガイド
最終更新日時 2026年5月15日
単一のディレクトリ エンティティを、組織 ID に基づいて名前と種類で解決します。
API エンドポイント
POST {accessURL}/{organizationName}/identity_/api/Directory/ResolveByName/{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'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
注:
{access_token}を取得するには、必ずこちらで説明するいずれかの方法で認証を行ってください。
パス パラメーター
| パス パラメーター | データ型 | 説明 |
|---|---|---|
partitionGlobalId (必須) | 文字列 (GUID) | 組織内のエンティティを解決する組織の ID です。 |
要求本文
要求本文では、解決するエンティティを名前で指定します。
{
"entityName": "string",
"entityType": "User"
}
{
"entityName": "string",
"entityType": "User"
}
| プロパティ | データ型 | 説明 |
|---|---|---|
entityName (必須) | 文字列 | ディレクトリ エンティティの名前 (例: ユーザーのメール アドレス、グループのグループ名) です。 |
entityType (必須) | 文字列 | ディレクトリ エンティティの種類です。有効な値: User、 Group、 Applicationです。 |
応答
200 OK
完全なディレクトリ エンティティを返します。応答の形状は、Resolve エンドポイントと同じです (エンティティの種類によって異なります)。
404 見つかりません
エンティティまたはパーティションが見つからない場合に返されます。
要求の例
API 呼び出しの構築に必要な情報をすべて収集したとします。
{baseURL}: https://cloud.uipath.com/{organizationName}/identity_{access_token}は1234です (長さを考慮)。{partitionGlobalId}は3fa85f64-5717-4562-b3fc-2c963f66afa6です。- メール アドレス
john.doe@example.comでユーザーを解決する場合
呼び出しは次の例のようになります (cURL)。
curl --location --request POST 'https://cloud.uipath.com/{organizationName}/identity_/api/Directory/ResolveByName/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
"entityName": "john.doe@example.com",
"entityType": "User"
}'
curl --location --request POST 'https://cloud.uipath.com/{organizationName}/identity_/api/Directory/ResolveByName/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
"entityName": "john.doe@example.com",
"entityType": "User"
}'
呼び出しが成功した場合、応答本文は次のようになります。
{
"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",
"jobTitle": "Software Engineer",
"companyName": "Contoso",
"city": "Seattle",
"department": "Engineering",
"isActive": true,
"creationTime": "2025-01-15T10:30:00Z"
}
{
"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",
"jobTitle": "Software Engineer",
"companyName": "Contoso",
"city": "Seattle",
"department": "Engineering",
"isActive": true,
"creationTime": "2025-01-15T10:30:00Z"
}