簡便アカウントのユーザー名、メールアドレス、備考などの情報を照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ecd:DescribeUsers |
list |
*すべてのリソース。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| MaxResults |
integer |
任意 |
ページングクエリのページングで 1 ページごとに返すエントリ数。
|
10 |
| NextToken |
string |
任意 |
次のクエリのトークン。この操作を初めて呼び出す場合は、このパラメーターを指定する必要はありません。応答にすべての結果が含まれていない場合、返される NextToken は空ではありません。返された NextToken を次のクエリで使用して、残りの結果を取得できます。 |
caeba0bbb2be03f84eb48b699f0a**** |
| Filter |
string |
任意 |
あいまい検索文字列。このパラメーターは、ユーザー名 (EndUserId) およびメールアドレス (Email) の一致検索をサポートします。このフィールドはワイルドカード () をサポートします。たとえば、このフィールドに am を設定すると、ユーザー名またはメールアドレスが a で始まり m で終わるすべての結果が返されます。 |
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 |
任意 |
説明
このパラメーターは一般公開されていません。 |
null |
|
any |
任意 |
キーは以下のいずれかのタイプで、値はブール値タイプです。指定された情報をクエリするには、値を true に設定します。ユーザーが属するユーザーグループと部門はデフォルトで返されます。
|
ResourcesCount: true |
|
| FilterWithAssignedResources |
object |
任意 |
説明
このパラメーターは一般公開されていません。 |
null |
|
boolean |
任意 |
キーは以下のいずれかのタイプで、値はブール値タイプです。指定されたクラウドリソースが割り当てられているユーザーをフィルター処理するには、値を true に設定します。
|
DesktopGroup: true |
|
| IsQueryAllSubOrgs |
boolean |
任意 |
クエリするユーザーの拡張情報。 |
true |
| FilterWithAssignedResource |
object |
任意 |
クラウドリソースが割り当てられているかどうかに基づいてユーザーをフィルター処理します。 |
|
|
string |
任意 |
キーは以下のいずれかのタイプで、値はブール値タイプです。値が true の場合、指定されたクラウドリソースが割り当てられているユーザーをフィルター処理することを指定します。
|
DesktopGroup: true |
|
| Status |
integer |
任意 |
子組織のユーザーをクエリするかどうかを指定します。 |
true |
| ExcludeGroupId |
string |
任意 |
||
| BusinessChannel |
string |
任意 |
ステータス。 |
ENTERPRISE |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答情報。 |
||
| RequestId |
string |
リクエスト ID。 |
1CBAFFAB-B697-4049-A9B1-67E1FC5F**** |
| NextToken |
string |
次のクエリのトークン。NextToken が空の場合、これ以上結果がないことを示します。 |
caeba0bbb2be03f84eb48b699f0a4883 |
| Count |
integer |
クエリ条件を満たすユーザーの総数。 |
|
| Users |
array<object> |
簡便アカウント情報のコレクション。 |
|
|
array<object> |
簡便アカウント情報のコレクション。 |
||
| Id |
integer |
簡便アカウントの ID。 |
4205** |
| EndUserId |
string |
ユーザー名。 |
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 |
簡便アカウントのグローバル一意 ID。 |
41fd1254d8f7**** |
| IsTenantManager |
boolean |
ユーザーがユーザー管理者であるかどうかを示します。作成された簡便アカウントが管理者によるアクティベーションタイプの場合、ユーザー管理者を指定する必要があります。クライアントから送信されるパスワードリセット通知などの通知は、ユーザー管理者のメールアドレスまたはモバイル電話番号に送信されます。詳細については、「簡便アカウントの作成」(~~214472~~) を参照してください。 簡便アカウントの作成 |
true |
| Groups |
array<object> |
簡便アカウントが属するユーザーグループのコレクション。 |
|
|
object |
簡便アカウントが属するユーザーグループのプロパティ。 |
||
| GroupId |
string |
ユーザーグループ ID。 |
ug-12341234**** |
| GroupName |
string |
ユーザーグループ名。 |
User group 1 |
| Orgs |
array<object> |
簡便アカウントが属する部門のコレクション。 |
|
|
object |
簡便アカウントが属する部門のプロパティ。 |
||
| OrgId |
string |
部門 ID。 |
org-4mdgc1cocc59z**** |
| OrgName |
string |
部門名。 |
Department 1 |
| OrgNamePath |
string |
||
| Avatar |
string |
プロフィール画像の URL。 |
https://cdn.***** |
| Address |
string |
ユーザーの勤務先住所。 |
Hangzhou*** |
| NickName |
string |
ユーザーのニックネーム。値は次の順序で取得されます。
|
Li** |
| RealNickName |
string |
ユーザーの表示名。 |
Li** |
| JobNumber |
string |
ユーザーの社員番号。 |
A10000** |
| Extras |
object |
ユーザーの拡張情報。 |
|
| AssignedResourceCount |
object |
割り当てられたクラウドリソースの数。 |
|
|
any |
サポートされているクラウドリソースタイプ:
|
Desktop: 3 |
|
| ResourcePolicyList |
array<object> |
||
|
object |
|||
| PolicyId |
string |
||
| PolicyName |
string |
||
| ExternalName |
string |
外部からインポートされたユーザーの名前。 説明
このフィールドは一般公開されていません。 |
Ma** |
| 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",
"Count": 0,
"Users": [
{
"Id": 0,
"EndUserId": "alice",
"Email": "username@example.com",
"Phone": "1381111****",
"Status": 0,
"OwnerType": "Normal",
"Remark": "テストユーザー",
"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": "Li**",
"RealNickName": "Li**",
"JobNumber": "A10000**",
"Extras": {
"AssignedResourceCount": {
"key": "Desktop: 3"
},
"ResourcePolicyList": [
{
"PolicyId": "",
"PolicyName": ""
}
]
},
"ExternalName": "Ma**",
"Properties": [
{
"Key": "役割",
"Value": "学生"
}
],
"EnableAdminAccess": false,
"PasswordExpireDays": 0,
"PasswordExpireRestDays": 0
}
]
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。