エンタープライズ Active Directory (AD) に接続するために AD ディレクトリを使用している場合、この操作を呼び出して、ご利用のエンタープライズ AD からユーザー情報を取得します。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
リージョン ID。WUYING Workspace がサポートするリージョンの一覧を取得するには、DescribeRegions を呼び出します。 |
cn-hangzhou |
| Filter |
string |
任意 |
あいまい検索用の文字列。この文字列を含むすべての結果が返されます。 |
alice |
| DirectoryId |
string |
必須 |
AD ディレクトリ ID。 |
cn-hangzhou+dir-jedbpr4sl9l37**** |
| NextToken |
string |
任意 |
次のクエリを開始するためのトークン。この値が空の場合、これ以上結果はありません。 |
caeba0bbb2be03f84eb48b699f0a4883 |
| MaxResults |
integer |
任意 |
1 ページあたりに返されるエントリ数。
|
10 |
| OUPath |
string |
任意 |
AD ドメイン内の組織単位 (OU) のパス。ListUserAdOrganizationUnits を呼び出して、OU パスを取得できます。 |
example.com/Domain Controllers |
| AssignedInfo |
string |
任意 |
説明
このパラメーターは公開されていません。 |
1 |
| SortType |
string |
任意 |
ソート方法。 列挙値:
|
asc |
| IncludeAssignedUser |
boolean |
任意 |
クラウドデスクトップが割り当てられているユーザーのみを返すかどうかを指定します。 |
true |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答オブジェクト。 |
||
| NextToken |
string |
次のクエリを開始するためのトークン。このパラメーターが空の場合、すべての結果が返されています。 |
caeba0bbb2be03f84eb48b699f0a4883 |
| RequestId |
string |
リクエスト ID。 |
1CBAFFAB-B697-4049-A9B1-67E1FC5F**** |
| Users |
array<object> |
AD ディレクトリ内のユーザーからなる配列。AD ディレクトリに Administrator および Guest ユーザーしか存在しない場合、空の `Users` 配列が返されます。 |
|
|
object |
ユーザー オブジェクト。 |
||
| EndUser |
string |
ユーザー名。 |
Alice |
| DisplayName |
string |
表示名。 |
Alice |
| AssignedDesktopNumber |
integer |
割り当てられたクラウドデスクトップの数。 |
2 |
|
string |
メールアドレス。 |
user@example.com |
|
| Phone |
string |
携帯電話番号。 |
130******** |
| DisplayNameNew |
string |
||
| UserPrincipalName |
string |
例
成功レスポンス
JSONJSON
{
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"Users": [
{
"EndUser": "Alice",
"DisplayName": "Alice",
"AssignedDesktopNumber": 2,
"Email": "user@example.com",
"Phone": "130********",
"DisplayNameNew": "",
"UserPrincipalName": ""
}
]
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。