ListUsers API によるページネーション付き EIAM ユーザーの一覧表示 - IDaaS - Alibaba Cloud -

EIAM アカウント情報をページングクエリで取得します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエスト構文

GET /v2/{instanceId}/{applicationId}/users HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
instanceId	string	必須	インスタンス ID。	idaas_ue2jvisn35ea5lmthk267xxxxx
applicationId	string	必須	アプリケーション ID。	app_mkv7rgt4d7i4u7zqtzev2mxxxx

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Authorization	string	必須	認証情報。フォーマット：Bearer ${access_token}。例：Bearer ATxxxx。	Bearer AT8csE2seYxxxxxij
organizationalUnitId	string	任意	組織 ID。	ou_wovwffm62xifdziem7an7xxxxx
pageNumber	integer	任意	ページ番号。デフォルト値は 1 です。	1
pageSize	integer	任意	各ページで返されるレコード数。デフォルト値は 20 です。有効値の範囲は 1～100 です。	20

レスポンスフィールド

フィールド	型	説明	例
	object	応答オブジェクト。
totalCount	integer	レコードの総数。	1000
data	array<object>	返されたデータオブジェクトのリスト。
	object	返されたデータオブジェクト。
instanceId	string	インスタンス ID。	idaas_ue2jvisn35ea5lmthk267xxxxx
userId	string	アカウント ID。	user_d6sbsuumeta4h66ec3il7yxxxx
username	string	アカウント名。	name001
displayName	string	アカウントの表示名。	display_name001
passwordSet	boolean	パスワードが設定されているかどうかを示します。	true
phoneRegion	string	携帯電話番号の市外局番。例えば、中国本土の携帯電話番号の市外局番は 86 です。00 やプラス記号 (+) は追加しないでください。	86
phoneNumber	string	アカウントの携帯電話番号。	156xxxxxxx
phoneNumberVerified	boolean	携帯電話番号が検証済みであるかを示します。true の値は、携帯電話番号がユーザーによって検証されたか、管理者によって検証済みに設定されたことを示します。false の値は、携帯電話番号が検証されていないことを示します。	true
email	string	アカウントのメールアドレス。	example@example.com
emailVerified	boolean	メールアドレスが検証済みであるかを示します。true の値は、メールアドレスがユーザーによって検証されたか、管理者によって検証済みに設定されたことを示します。false の値は、メールアドレスが検証されていないことを示します。	true
userExternalId	string	アカウントの外部 ID。この ID は、外部データを IDaaS アカウントにマッピングするために使用されます。デフォルトでは、このパラメーターは IDaaS アカウント ID と同じです。注意：外部 ID は、同じソースタイプとソース ID に対して一意である必要があります。	user_d6sbsuumeta4h66ec3il7yxxxx
userSourceType	string	アカウントのソースタイプ。有効値： build_in：アカウントは IDaaS で作成されます。 ding_talk：アカウントは DingTalk からインポートされます。 ad：アカウントは Active Directory (AD) からインポートされます。 ldap：アカウントは LDAP からインポートされます。	build_in
userSourceId	string	アカウントのソース ID。 IDaaS で作成されたアカウントの場合、デフォルト値はインスタンス ID です。他のタイプのアカウントの場合、値はソースからの企業 ID です。例えば、DingTalk のアカウントの場合、値は DingTalk 企業の corpId です。	idaas_ue2jvisn35ea5lmthk267xxxxx
status	string	アカウントのステータス。有効値：enabled：アカウントは有効です。disabled：アカウントは無効です。	enabled
accountExpireTime	integer	アカウントの有効期限が切れる時間。この値は UNIX タイムスタンプです。単位：ミリ秒。	1652085686179
registerTime	integer	アカウントが登録された時間。この値は UNIX タイムスタンプです。単位：ミリ秒。	1652085686179
lockExpireTime	integer	アカウントロックの有効期限が切れる時間。この値は UNIX タイムスタンプです。単位：ミリ秒。	1652085686179
createTime	integer	アカウントが作成された時間。この値は UNIX タイムスタンプです。単位：ミリ秒。	1652085686179
updateTime	integer	アカウントが最後に更新された時間。この値は UNIX タイムスタンプです。単位：ミリ秒。	1652085686179
description	string	アカウントの説明。	测试账户

例

成功レスポンス

JSONJSON

{
  "totalCount": 1000,
  "data": [
    {
      "instanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
      "userId": "user_d6sbsuumeta4h66ec3il7yxxxx",
      "username": "name001",
      "displayName": "display_name001",
      "passwordSet": true,
      "phoneRegion": "86",
      "phoneNumber": "156xxxxxxx",
      "phoneNumberVerified": true,
      "email": "example@example.com",
      "emailVerified": true,
      "userExternalId": "user_d6sbsuumeta4h66ec3il7yxxxx",
      "userSourceType": "build_in",
      "userSourceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
      "status": "enabled",
      "accountExpireTime": 1652085686179,
      "registerTime": 1652085686179,
      "lockExpireTime": 1652085686179,
      "createTime": 1652085686179,
      "updateTime": 1652085686179,
      "description": "测试账户"
    }
  ]
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。