ディレクトリアカウント情報（ユーザー名、メールアドレス、表示名など）を取得します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ecd:DescribeUsers |
list |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| MaxResults |
integer |
任意 |
1 ページあたりに返されるエントリ数です。
|
10 |
| NextToken |
string |
任意 |
次のクエリを開始するためのトークンです。返されたエントリ数が MaxResults の値を超える場合、トークンが返されます。このトークンを次のクエリで使用して、クエリを続行できます。 |
caeba0bbb2be03f84eb48b699f0a**** |
| Filter |
string |
任意 |
あいまい検索のフィルターです。このフィルターはユーザー名 (EndUserId) およびメールアドレス (Email) と一致します。このパラメーターはワイルドカード文字 (*) をサポートしています。たとえば、このパラメーターを |
a*m |
| FilterMap |
object |
任意 |
||
|
string |
任意 |
|||
| EndUserIds |
array |
任意 |
完全に一致させるユーザー名 (EndUserId) のリストです。 |
|
|
string |
任意 |
ユーザー名 (EndUserId) による完全一致で、同じユーザー名を持つアカウントの情報を照会します。 |
alice |
|
| ExcludeEndUserIds |
array |
任意 |
完全に除外するユーザー名 (EndUserId) のリストです。 |
|
|
string |
任意 |
指定したユーザー名 (EndUserId) をクエリから除外し、そのユーザー名を含まないアカウントのリストを取得します。 |
tony |
|
| OrgId |
string |
任意 |
組織 ID による完全一致で、その組織に属するアカウントのリストを照会します。 |
org-4mdgc1cocc59z**** |
| GroupId |
string |
任意 |
ユーザーグループ ID による完全一致で、そのユーザーグループに属するアカウントのリストを照会します。 |
ug-12341234**** |
| ShowExtras |
object |
任意 |
説明
このパラメーターは一般公開されていません。 |
|
|
any |
任意 |
Group：ユーザーが所属するグループ。
- Org：ユーザーが所属する部門。
- ResourcesCount：割り当てられたリソース数。
- Properties：ユーザー属性。 |
ResourcesCount: true |
|
| FilterWithAssignedResources |
object |
任意 |
説明
このパラメーターは一般公開されていません。 |
|
|
boolean |
任意 |
Desktop：クラウドデスクトップ。
- DesktopGroup：共有クラウドデスクトップ。
- CloudDrive：エンタープライズクラウドドライブ（ユーザーの個人用ドライブ）。
- App：クラウドアプリケーション。 |
DesktopGroup: true |
|
| IsQueryAllSubOrgs |
boolean |
任意 |
ユーザーに関する拡張情報を照会します。 |
true |
| FilterWithAssignedResource |
object |
任意 |
クラウドリソースが割り当てられているかどうかに基づいてユーザーをフィルターします。 |
|
|
string |
任意 |
キーは以下のいずれかのタイプであり、値はブール値です。true を渡すと、指定されたクラウドリソースが割り当てられているユーザーをフィルターします。
|
App:aig-jfgmanbo**** |
|
| Status |
integer |
任意 |
サブ組織内のユーザーを照会するかどうかを指定します。 |
|
| ExcludeGroupId |
string |
任意 |
||
| BusinessChannel |
string |
任意 |
ステータス |
ENTERPRISE |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスデータです。 |
||
| RequestId |
string |
リクエスト ID です。 |
1CBAFFAB-B697-4049-A9B1-67E1FC5F**** |
| NextToken |
string |
次のクエリを開始するためのトークンです。このパラメーターが空の場合、すべての結果が返されたことを示します。 |
caeba0bbb2be03f84eb48b699f0a4883 |
| Users |
array<object> |
簡便アカウントの詳細です。 |
|
|
array<object> |
簡便アカウントの詳細です。 |
||
| Id |
integer |
簡便アカウントの ID です。 |
4205** |
| EndUserId |
string |
エンドユーザー ID です。 |
alice |
|
string |
メールアドレスです。 |
username@example.com |
|
| Phone |
string |
電話番号です。このパラメーターは、電話番号が設定されている場合にのみ返されます。 |
1381111**** |
| Status |
integer |
簡便アカウントのステータスです。 列挙値:
|
0 |
| OwnerType |
string |
簡便アカウントのタイプです。アカウントは以下のいずれかの方法で有効化できます。
列挙値:
|
Normal |
| Remark |
string |
簡便アカウントに関する備考です。 |
Test user. |
| OrgId |
string |
簡便アカウントが属する組織の ID です。 説明
このパラメーターは非推奨であり、今後のリリースで削除される可能性があります。 |
org-4mdgc1cocc59z**** |
| WyId |
string |
簡便アカウントのグローバル一意識別子です。 |
41fd1254d8f7**** |
| IsTenantManager |
boolean |
ユーザーがテナント管理者であるかどうかを示します。 |
true |
| Groups |
array<object> |
簡便アカウントが属するユーザーグループです。 |
|
|
object |
簡便アカウントが属するユーザーグループの詳細です。 |
||
| GroupId |
string |
ユーザーグループの ID です。 |
ug-12341234**** |
| GroupName |
string |
ユーザーグループの名前です。 |
用户组1 |
| Orgs |
array<object> |
簡便アカウントが属する組織です。 |
|
|
object |
簡便アカウントが属する組織の詳細です。 |
||
| OrgId |
string |
組織の ID です。 |
org-4mdgc1cocc59z**** |
| OrgName |
string |
組織の名前です。 |
部门1 |
| OrgNamePath |
string |
||
| Avatar |
string |
ユーザーのアバターの URL です。 |
https://cdn.***** |
| Address |
string |
ユーザーの勤務先住所です。 |
杭州市*** |
| NickName |
string |
ユーザーのニックネームです。
|
李** |
| RealNickName |
string |
ユーザーの表示名です。 |
李** |
| JobNumber |
string |
社員 ID です。 |
A10000** |
| Extras |
object |
ユーザーの拡張プロパティです。 |
|
| AssignedResourceCount |
object |
割り当てられたクラウドリソースの数です。 |
|
|
any |
キーはリソースタイプを、値はリソース数を指定します。以下のリソースタイプがサポートされています。
|
Desktop: 3 |
|
| ResourcePolicyList |
array<object> |
||
|
object |
|||
| PolicyId |
string |
||
| PolicyName |
string |
||
| ExternalName |
string |
外部システムからインポートされたユーザー名です。 説明
このパラメーターは内部利用専用です。 |
马** |
| Properties |
array<object> |
ユーザーのカスタムプロパティのリストです。 |
|
|
object |
カスタムプロパティを表すキーと値のペアです。 |
||
| Key |
string |
プロパティキーです。 |
Role |
| Value |
string |
プロパティ値です。 |
Student |
| EnableAdminAccess |
boolean |
管理者アクセスが有効かどうかを示します。 |
|
| PasswordExpireDays |
integer |
||
| PasswordExpireRestDays |
integer |
例
成功レスポンス
JSONJSON
{
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
"Users": [
{
"Id": 0,
"EndUserId": "alice",
"Email": "username@example.com",
"Phone": "1381111****",
"Status": 0,
"OwnerType": "Normal",
"Remark": "Test user.",
"OrgId": "org-4mdgc1cocc59z****",
"WyId": "41fd1254d8f7****",
"IsTenantManager": true,
"Groups": [
{
"GroupId": "ug-12341234****",
"GroupName": "用户组1"
}
],
"Orgs": [
{
"OrgId": "org-4mdgc1cocc59z****",
"OrgName": "部门1",
"OrgNamePath": ""
}
],
"Avatar": "https://cdn.*****",
"Address": "杭州市***",
"NickName": "李**",
"RealNickName": "李**",
"JobNumber": "A10000**",
"Extras": {
"AssignedResourceCount": {
"key": "Desktop: 3"
},
"ResourcePolicyList": [
{
"PolicyId": "",
"PolicyName": ""
}
]
},
"ExternalName": "马**",
"Properties": [
{
"Key": "Role",
"Value": "Student"
}
],
"EnableAdminAccess": false,
"PasswordExpireDays": 0,
"PasswordExpireRestDays": 0
}
]
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。