ページングを使用して EIAM アカウント情報を照会します。
操作説明
この操作は組織単位の直接権限のみを照会します。これは組織単位に直接割り当てられたアプリケーションです。この操作を呼び出す際に、ApplicationIds パラメーターを使用してアプリケーションをフィルターできます。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| InstanceId |
string |
必須 |
インスタンス ID。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| PageNumber |
integer |
任意 |
ページ番号。デフォルト値: 1。 |
1 |
| PageSize |
integer |
任意 |
1 ページあたりのエントリ数。デフォルト値: 20。最大値: 100。 |
20 |
| UserIds |
array |
任意 |
アカウント ID のリスト。 |
20 |
|
string |
任意 |
アカウント ID。 |
user_d6sbsuumeta4h66ec3il7yxxxx |
|
| UsernameStartsWith |
string |
任意 |
ユーザー名のプレフィックス。前方一致検索が使用されます。 |
name_001 |
| DisplayNameStartsWith |
string |
任意 |
表示名のプレフィックス。前方一致検索が使用されます。 |
name |
| PhoneRegion |
string |
任意 |
電話リージョンコード。例: 中国本土のリージョンコードは 86 で、00 または + プレフィックスは付きません。 |
86 |
| PhoneNumber |
string |
任意 |
アカウントの電話番号。 |
156xxxxxxx |
|
string |
任意 |
アカウントのメールアドレス。 |
user@example.com |
|
| UserExternalId |
string |
任意 |
外部 ID。外部データを IDaaS アカウントに関連付けるために使用されます。 注: 外部 ID は同じソースタイプおよびソース ID 内で一意である必要があります。 |
id_wovwffm62xifdziem7an7xxxxx |
| UserSourceId |
string |
任意 |
アカウントのソース ID。 自己構築アカウントの場合、デフォルト値はインスタンス ID です。その他のタイプの場合、値は対応するソースのエンタープライズ ID に対応します。例えば、DingTalk ソースの場合、値は DingTalk エンタープライズの corpId に対応します。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| UserSourceType |
string |
任意 |
アカウントのソースタイプ。有効な値:
|
build_in |
| Status |
string |
任意 |
アカウントステータス。有効な値:
|
enable |
| OrganizationalUnitId |
string |
任意 |
組織単位 ID。 |
ou_wovwffm62xifdziem7an7xxxxx |
| NextToken |
string |
任意 |
ページネーショントークン。 |
NTxxxxexample |
| MaxResults |
integer |
任意 |
ページングの 1 ページあたりのエントリ数。 |
20 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答パラメーター。 |
||
| RequestId |
string |
リクエスト ID。 |
0441BD79-92F3-53AA-8657-F8CE4A2B912A |
| TotalCount |
integer |
返されたエントリの総数。 |
100 |
| Users |
array<object> |
アカウントデータのリスト。 |
|
|
object |
アカウントデータ。 |
||
| UserId |
string |
アカウント ID。 |
user_d6sbsuumeta4h66ec3il7yxxxx |
| Username |
string |
ユーザー名。 |
name001 |
| DisplayName |
string |
アカウントの表示名。 |
display_name001 |
| PasswordSet |
boolean |
パスワードが設定されているかどうかを示します。 |
false |
| PhoneRegion |
string |
電話リージョンコード。例: 中国本土のリージョンコードは 86 で、00 または + プレフィックスは付きません。 |
86 |
| PhoneNumber |
string |
アカウントの電話番号。 |
156xxxxxxx |
| PhoneNumberVerified |
boolean |
電話番号が検証済みかどうかを示します。true の値は、電話番号がユーザーによって検証されたか、管理者によって検証済みに設定されたことを示します。false の値は、電話番号が検証されていないことを示します。 |
true |
|
string |
アカウントのメールアドレス。 |
user@example.com |
|
| EmailVerified |
boolean |
メールアドレスが検証済みかどうかを示します。true の値は、メールアドレスがユーザーによって検証されたか、管理者によって検証済みに設定されたことを示します。false の値は、メールアドレスが検証されていないことを示します。 |
true |
| UserExternalId |
string |
アカウントの外部 ID。外部データを IDaaS アカウントに関連付けるために使用されます。デフォルト値は IDaaS アカウント ID です。 注: 外部 ID は同じソースタイプおよびソース ID 内で一意である必要があります。 |
user_d6sbsuumeta4h66ec3il7yxxxx |
| UserSourceType |
string |
アカウントのソースタイプ。有効な値:
|
build_in |
| UserSourceId |
string |
アカウントのソース ID。 自己構築アカウントの場合、デフォルト値はインスタンス ID です。その他のタイプの場合、値は対応するソースのエンタープライズ ID に対応します。例えば、DingTalk ソースの場合、値は DingTalk エンタープライズの corpId に対応します。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| Status |
string |
アカウントステータス。有効な値:
|
enabled |
| AccountExpireTime |
integer |
アカウントの有効期限時間。UNIX タイムスタンプフォーマット。単位: ミリ秒。 |
1652085686179 |
| PasswordExpireTime |
integer |
パスワードの有効期限時間。UNIX タイムスタンプフォーマット。単位: ミリ秒。 |
1652085686179 |
| RegisterTime |
integer |
アカウントの登録時間。UNIX タイムスタンプフォーマット。単位: ミリ秒。 |
1652085686179 |
| LockExpireTime |
integer |
アカウントのロック有効期限時間。UNIX タイムスタンプフォーマット。単位: ミリ秒。 |
1652085686179 |
| CreateTime |
integer |
アカウントの作成時間。UNIX タイムスタンプフォーマット。単位: ミリ秒。 |
1652085686179 |
| UpdateTime |
integer |
アカウントの最終更新時間。UNIX タイムスタンプフォーマット。単位: ミリ秒。 |
1652085686179 |
| Description |
string |
アカウントの説明。 |
xxxx |
| InstanceId |
string |
インスタンス ID。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| NextToken |
string |
ページネーショントークン。 |
NTxxxxxexample |
| MaxResults |
integer |
ページングの 1 ページあたりのエントリ数。 |
20 |
例
成功レスポンス
JSONJSON
{
"RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
"TotalCount": 100,
"Users": [
{
"UserId": "user_d6sbsuumeta4h66ec3il7yxxxx",
"Username": "name001",
"DisplayName": "display_name001",
"PasswordSet": false,
"PhoneRegion": "86",
"PhoneNumber": "156xxxxxxx",
"PhoneNumberVerified": true,
"Email": "user@example.com",
"EmailVerified": true,
"UserExternalId": "user_d6sbsuumeta4h66ec3il7yxxxx",
"UserSourceType": "build_in",
"UserSourceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
"Status": "enabled",
"AccountExpireTime": 1652085686179,
"PasswordExpireTime": 1652085686179,
"RegisterTime": 1652085686179,
"LockExpireTime": 1652085686179,
"CreateTime": 1652085686179,
"UpdateTime": 1652085686179,
"Description": "xxxx",
"InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx"
}
],
"NextToken": "NTxxxxxexample",
"MaxResults": 20
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。