Employee Identity and Access Management (EIAM) アカウントの詳細情報を取得します。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
GET /v2/{instanceId}/{applicationId}/users/{userId} HTTP/1.1
パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| instanceId |
string |
必須 |
インスタンス ID。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| applicationId |
string |
必須 |
アプリケーション ID。 |
app_mkv7rgt4d7i4u7zqtzev2mxxxx |
| userId |
string |
必須 |
アカウント ID。 |
user_d6sbsuumeta4h66ec3il7yxxxx |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Authorization |
string |
必須 |
認証情報。値は Bearer ${access_token} 形式です。例:Bearer ATxxxx。 |
Bearer AT8csE2seYxxxxxij |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーター。 |
||
| instanceId |
string |
インスタンス ID。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| organizationalUnits |
array<object> |
アカウントが所属する組織単位。 |
|
|
object |
組織単位。 |
||
| organizationalUnitId |
string |
組織単位の ID。 |
ou_wovwffm62xifdziem7an7xxxxx |
| organizationalUnitName |
string |
組織単位の名前。 |
name001 |
| primary |
boolean |
組織単位がプライマリ組織単位であるかどうかを示します。 |
true |
| primaryOrganizationalUnitId |
string |
アカウントのプライマリ組織単位の ID。 |
ou_wovwffm62xifdziem7an7xxxxx |
| customFields |
array<object> |
アカウントの拡張フィールド。 |
|
|
object |
|||
| fieldName |
string |
拡張フィールドの名前。 |
xxxx |
| fieldValue |
string |
拡張フィールドの値。フィールドのデータ型に関係なく、フィールド値は文字列として返されます。たとえば、ブール値フィールドの場合、true または false が返されます。 |
字段数据值 |
| userId |
string |
アカウント ID。 |
user_d6sbsuumeta4h66ec3il7yxxxx |
| username |
string |
アカウントのユーザー名。 |
name001 |
| displayName |
string |
アカウントの表示名。 |
display_name001 |
| passwordSet |
boolean |
パスワードが設定されているかどうかを示します。 |
true |
| phoneRegion |
string |
携帯電話番号の国別コード。例:中国の国別コードは 00 や + を含まない 86 です。 |
86 |
| phoneNumber |
string |
アカウント所有者の携帯電話番号。 |
156xxxxxxx |
| phoneNumberVerified |
boolean |
携帯電話番号が検証済みかどうかを示します。true の場合、ユーザーによる検証済み、または管理者によって検証済みステータスに設定済みであることを意味します。false の場合、携帯電話番号が未検証であることを意味します。 |
true |
|
string |
ユーザーのメールアドレス。 |
example@example.com |
|
| emailVerified |
boolean |
メールアドレスが検証済みかどうかを示します。true の場合、ユーザーによる検証済み、または管理者によって検証済みステータスに設定済みであることを意味します。false の場合、メールアドレスが未検証であることを意味します。 |
true |
| userExternalId |
string |
アカウントの外部 ID。外部 ID は、ID as a Service (IDaaS) の EIAM 内のアカウントデータと外部データをマップするために使用できます。デフォルトでは、外部 ID はアカウント ID です。 注:同一のソースタイプおよびソース ID を持つアカウントの場合、各アカウントには一意の外部 ID が割り当てられます。 |
user_d6sbsuumeta4h66ec3il7yxxxx |
| userSourceType |
string |
アカウントのソースタイプ。有効な値:
|
build_in |
| userSourceId |
string |
アカウントのソース ID。 IDaaS で作成されたアカウントの場合、そのソース ID は IDaaS インスタンスの ID です。インポートされたアカウントの場合、そのソース ID はソース側の企業 ID です。たとえば、DingTalk からインポートされたアカウントの場合、そのソース ID は DingTalk 内の企業の corpId 値です。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| status |
string |
アカウントのステータス。有効な値:enabled、disabled |
enabled |
| accountExpireTime |
integer |
アカウントの有効期限。この値は UNIX タイムスタンプであり、協定世界時 (UTC) 1970 年 1 月 1 日 00:00:00 からの経過ミリ秒数を表します。 |
1652085686179 |
| registerTime |
integer |
アカウントの登録日時。この値は UNIX タイムスタンプであり、協定世界時 (UTC) 1970 年 1 月 1 日 00:00:00 からの経過ミリ秒数を表します。 |
1652085686179 |
| lockExpireTime |
integer |
アカウントロックの有効期限。この値は UNIX タイムスタンプであり、協定世界時 (UTC) 1970 年 1 月 1 日 00:00:00 からの経過ミリ秒数を表します。 |
1652085686179 |
| createTime |
integer |
アカウントの作成日時。この値は UNIX タイムスタンプであり、協定世界時 (UTC) 1970 年 1 月 1 日 00:00:00 からの経過ミリ秒数を表します。 |
1652085686179 |
| updateTime |
integer |
アカウントの最終更新日時。この値は UNIX タイムスタンプであり、協定世界時 (UTC) 1970 年 1 月 1 日 00:00:00 からの経過ミリ秒数を表します。 |
1652085686179 |
| description |
string |
アカウントの説明。 |
测试账户 |
| groups |
array<object> |
アカウントが所属するグループ。 |
|
|
object |
アカウントが所属するグループの情報。 |
||
| groupId |
string |
グループ ID。 |
group_ufdsasn35ea5lmthk267xxxxx |
| groupName |
string |
グループ名。 |
name_test |
| description |
string |
グループの説明。 |
description_demo |
例
成功レスポンス
JSONJSON
{
"instanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
"organizationalUnits": [
{
"organizationalUnitId": "ou_wovwffm62xifdziem7an7xxxxx",
"organizationalUnitName": "name001",
"primary": true
}
],
"primaryOrganizationalUnitId": "ou_wovwffm62xifdziem7an7xxxxx",
"customFields": [
{
"fieldName": "xxxx",
"fieldValue": "字段数据值"
}
],
"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": "测试账户",
"groups": [
{
"groupId": "group_ufdsasn35ea5lmthk267xxxxx",
"groupName": "name_test",
"description": "description_demo"
}
]
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。