ユーザーIDに基づいたユーザーの取得
get
/iam/governance/selfservice/api/v1/users/{uuid}
ターゲット・ユーザーIDのユーザー属性を返します。ユーザー定義フィールド(UDF)を含むユーザーのすべての属性は、レスポンス・ペイロードの一部として返されます。レスポンス・ペイロードは、"fields"問合せパラメータで必要な属性を指定することにより管理できます。指定されたユーザーについて、すべてのロール(割当て済/保留中)、アカウントおよび権限を取得します。割当て済ロールの取得: /iam/governance/selfservice/api/v1/users/{uuid}?roles=assigned 保留中ロールの取得: /iam/governance/selfservice/api/v1/users/{uuid}?roles=pending 割当て済ロールと保留中ロールの取得: /iam/governance/selfservice/api/v1/users/{uuid}?roles=all アカウントの取得: /iam/governance/selfservice/api/v1/users/{uuid}?accounts=all 権限の取得: /iam/governance/selfservice/api/v1/users/{uuid}?entitlements=all
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
- uuid: string
ターゲット・ユーザーID
問合せパラメータ
- accounts(optional): string
ユーザーのアカウントをすべて取得します。
- entitlements(optional): string
ユーザーの権限をすべて取得します。
- fields(optional): string
結果に返される属性。カンマ区切り属性を受け入れます。属性のサンプル値は、"First Name、Middle Name、Last Name、Organization、Email、User Login、Employee Number、Department Number"などです。"Supervisor First Name"、"Organization Name"などの参照オブジェクトの属性は指定できません。
- roles(optional): string
ユーザーのロールをすべて取得します。値として、assigned、pendingまたはallを指定できます。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
成功
ヘッダー
- ResponseTime: string
リクエストの処理にかかった時間(ミリ秒)を取得します。
ネストされたスキーマ: BulkAccountGetResponseInstance
型:
ソースを表示
object
- accountData(optional):
- accountDescription(optional): string
- accountType(optional): string
- appinstance(optional): object EntityReference
- id(optional): string
- links(optional): array links
- name(optional): string
- normalizeData(optional):
- policyKey(optional): string
- processInstanceKey(optional): string
- provisionedBy(optional): object EntityReference
- provisionedByMechanism(optional): string
- provisionedOnDate(optional): string
- requestId(optional): object EntityReference
- riskSummary(optional): string
- status(optional): string
- userId(optional): string
- validFromDate(optional): string
ネストされたスキーマ: EntitlementData
型:
ソースを表示
object
- accountKey(optional): integer
- chidlFormName(optional): string
- childFormValues(optional): string
- childTablePrimaryKey(optional): integer
- entListKey(optional): integer
- id(optional): string
- normalizedData(optional): string
- policyKey(optional): integer
- processInstanceKey(optional): integer
- provisionedBy(optional): string
- provisionedMechanism(optional): string
- provisionedOn(optional): string
- requestKey(optional): string
- serialVersionUid(optional): integer
- startDate(optional): string
- status(optional): string
- userKey(optional): integer
401レスポンス
未認可
404レスポンス
リクエスト・エンティティが見つからない
500レスポンス
内部サーバー・エラー
例
ここでは、指定されたユーザーを取得します。返されるフィールドは、Display Name、First Name、User Login、Department NumberおよびMiddle Nameでフィルタされます。ここに示す情報は、擬似システムを使用した場合のものであり、プロトタイプとして提供しています。
cURLの例
curl -H "Content-Type: application/json" -X GET -u username:password "https://pseudo.com/iam/governance/selfservice/api/v1/users/23?fields=Display Name,First Name,User Login,Department Number,Middle Name"
ユーザーを取得するGETレスポンス本文の例
JSON形式のレスポンス本文のコンテンツの例を次に示します。
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/users/23"
}
],
"fields": [
{
"name": "Display Name",
"value": {
"base": "Beatrix Kiddo"
}
},
{
"name": "First Name",
"value": "Beatrix"
},
{
"name": "usr_key",
"value": 23
},
{
"name": "User Login",
"value": "BKIDDO"
}
]
}
ロールを取得するGETレスポンス本文の例
JSON形式のレスポンス本文のコンテンツの例を次に示します。
{ "links": [ { "rel": "self", "href": "https://pseudo.com/iam/governance/selfservice/api/v1/users/82" } ], "fields": [ { "name": "ObjectGUID", "value": "0" }, { "name": "Last Successful Login Date", "value": "2019-07-24T20:46:46Z" }, { "name": "usr_createby", "value": 1 }, { "name": "Status", "value": "Active" }, { "name": "Organization Name", "value": "Vision" }, { "name": "Last Failed Login Date", "value": "2019-06-18T22:41:12Z" }, { "name": "usr_manager_key", "value": 17 }, { "name": "Manager Display Name", "value": "Ajay Arora" }, { "name": "Last Name", "value": "dtran20190614" }, { "name": "Manager Login", "value": "AARORA" }, { "name": "usr_pwd_reset_attempts_ctr", "value": 0 }, { "name": "usr_change_pwd_at_next_logon", "value": "0" }, { "name": "usr_pwd_creation_date", "value": "2019-06-19T16:53:09Z" }, { "name": "usr_pwd_expired", "value": "0" }, { "name": "Xellerate Type", "value": "End-User" }, { "name": "Lockout Duration", "value": 0 }, { "name": "Manager Last Name", "value": "Arora" }, { "name": "usr_create", "value": "2019-06-14T17:22:25Z" }, { "name": "usr_login_attempts_ctr", "value": 0 }, { "name": "usr_provisioned_date", "value": "2019-06-14T17:22:25Z" }, { "name": "Full Name", "value": { "base": null } }, { "name": "act_key", "value": 15 }, { "name": "usr_locked", "value": "0" }, { "name": "Common Name Generated", "value": 0 }, { "name": "usr_pwd_warn_date", "value": "2019-10-10T16:53:09Z" }, { "name": "User Login", "value": "DTRAN20190614" }, { "name": "Role", "value": "Consultant" }, { "name": "usr_pwd_expire_date", "value": "2019-10-17T16:53:09Z" }, { "name": "Manager First Name", "value": "Ajay" }, { "name": "usr_update", "value": "2019-06-21T17:40:01Z" }, { "name": "usr_key", "value": 82 }, { "name": "Display Name", "value": { "base": "dtran20190614" } }, { "name": "usr_disabled", "value": "0" }, { "name": "usr_updateby", "value": 1 } ], "roles": [ { "links": [ { "rel": "self", "href": "https://pseudo.com/iam/governance/selfservice/api/v1/roles/3" } ], "id": "3", "fields": [ { "name": "Role Description", "value": "Default role for all users" }, { "name": "Role Name", "value": "ALL USERS" }, { "name": "ugp_update", "value": 1560453999000 }, { "name": "ugp_createby", "value": 1 }, { "name": "Role Key", "value": "3" }, { "name": "ugp_create", "value": 1560453999000 }, { "name": "Role Display Name", "value": "ALL USERS" }, { "name": "ugp_updateby", "value": 1 }, { "name": "Role Unique Name", "value": "ALL USERS" }, { "name": "Role Category Key", "value": 2 }, { "name": "Role Owner Key", "value": 1 }, { "name": "Role Namespace", "value": "Default" }, { "name": "ugp_data_level", "value": 1 } ] }, { "links": [ { "rel": "self", "href": "https://pseudo.com/iam/governance/selfservice/api/v1/roles/10" } ], "id": "10", "fields": [ { "name": "Role Name", "value": "Fraud Supervisor" }, { "name": "ugp_update", "value": 1560458919000 }, { "name": "ugp_createby", "value": 1 }, { "name": "Role Key", "value": "10" }, { "name": "ugp_create", "value": 1560458919000 }, { "name": "Role Display Name", "value": "Fraud Supervisor" }, { "name": "ugp_updateby", "value": 1 }, { "name": "Role Unique Name", "value": "Fraud Supervisor" }, { "name": "Role Category Key", "value": 1 }, { "name": "Role Owner Key", "value": 1 }, { "name": "Role Namespace", "value": "Default" } ] }, { "links": [ { "rel": "self", "href": "https://pseudo.com/iam/governance/selfservice/api/v1/roles/11" } ], "id": "11", "fields": [ { "name": "Role Description", "value": "chargeback description" }, { "name": "Role Name", "value": "Chargeback Supervisor" }, { "name": "ugp_update", "value": 1560790913000 }, { "name": "ugp_createby", "value": 1 }, { "name": "Role Key", "value": "11" }, { "name": "ugp_create", "value": 1560458920000 }, { "name": "Role Display Name", "value": "Chargeback Supervisor" }, { "name": "ugp_updateby", "value": 83 }, { "name": "Role Unique Name", "value": "Chargeback Supervisor" }, { "name": "Role Category Key", "value": 1 }, { "name": "Role Owner Key", "value": 1 }, { "name": "Role Namespace", "value": "Default" } ] } ], "pendingRoles": [ { "roleId": "8", "userId": "82", "roleGrantAttributes": [ { "name": "prg_update", "value": 1564001175000 }, { "name": "prov_by", "value": 6001 }, { "name": "prov_mechanism", "value": "Request" }, { "name": "ugp_key", "value": 8 }, { "name": "usr_key", "value": 82 }, { "name": "request_id", "value": "6001" }, { "name": "startDate", "value": 1564642800000 }, { "name": "request_key", "value": 6001 }, { "name": "prg_create", "value": 1564001175000 }, { "name": "Role Name", "value": "Fraud Analyst" }, { "name": "Role Description" } ] } ] }
ユーザーのすべてのロール、アカウント、権限を取得する例
この例では、ユーザーのロール、アカウントおよび権限をすべて取得します。ここに示す情報は、擬似システムを使用した場合のものであり、プロトタイプとして提供しています。
curl -H "Content-Type: application/json" -X GET -u username:password "https://pseudo.com/iam/governance/selfservice/api/v1/users/82?roles=all&accounts=all&entitlements=all
GETレスポンス本文の例
JSON形式のレスポンス本文のコンテンツの例を次に示します。
{ "links": [ { "rel": "self", "href": "https://pseudo.com/iam/governance/selfservice/api/v1/users/82" } ], "fields": [ { "name": "ObjectGUID", "value": "0" }, { "name": "Last Successful Login Date", "value": "2019-07-24T21:04:37Z" }, { "name": "usr_createby", "value": 1 }, { "name": "Status", "value": "Active" }, { "name": "Organization Name", "value": "Vision" }, { "name": "Last Failed Login Date", "value": "2019-06-18T22:41:12Z" }, { "name": "usr_manager_key", "value": 17 }, { "name": "Manager Display Name", "value": "Ajay Arora" }, { "name": "Last Name", "value": "dtran20190614" }, { "name": "Manager Login", "value": "AARORA" }, { "name": "usr_pwd_reset_attempts_ctr", "value": 0 }, { "name": "usr_change_pwd_at_next_logon", "value": "0" }, { "name": "usr_pwd_creation_date", "value": "2019-06-19T16:53:09Z" }, { "name": "usr_pwd_expired", "value": "0" }, { "name": "Xellerate Type", "value": "End-User" }, { "name": "Lockout Duration", "value": 0 }, { "name": "Manager Last Name", "value": "Arora" }, { "name": "usr_create", "value": "2019-06-14T17:22:25Z" }, { "name": "usr_login_attempts_ctr", "value": 0 }, { "name": "usr_provisioned_date", "value": "2019-06-14T17:22:25Z" }, { "name": "Full Name", "value": { "base": null } }, { "name": "act_key", "value": 15 }, { "name": "usr_locked", "value": "0" }, { "name": "Common Name Generated", "value": 0 }, { "name": "usr_pwd_warn_date", "value": "2019-10-10T16:53:09Z" }, { "name": "User Login", "value": "DTRAN20190614" }, { "name": "Role", "value": "Consultant" }, { "name": "usr_pwd_expire_date", "value": "2019-10-17T16:53:09Z" }, { "name": "Manager First Name", "value": "Ajay" }, { "name": "usr_update", "value": "2019-06-21T17:40:01Z" }, { "name": "usr_key", "value": 82 }, { "name": "Display Name", "value": { "base": "dtran20190614" } }, { "name": "usr_disabled", "value": "0" }, { "name": "usr_updateby", "value": 1 } ], "roles": [ { "links": [ { "rel": "self", "href": "https://pseudo.com/iam/governance/selfservice/api/v1/roles/3" } ], "id": "3", "fields": [ { "name": "Role Description", "value": "Default role for all users" }, { "name": "Role Name", "value": "ALL USERS" }, { "name": "ugp_update", "value": 1560453999000 }, { "name": "ugp_createby", "value": 1 }, { "name": "Role Key", "value": "3" }, { "name": "ugp_create", "value": 1560453999000 }, { "name": "Role Display Name", "value": "ALL USERS" }, { "name": "ugp_updateby", "value": 1 }, { "name": "Role Unique Name", "value": "ALL USERS" }, { "name": "Role Category Key", "value": 2 }, { "name": "Role Owner Key", "value": 1 }, { "name": "Role Namespace", "value": "Default" }, { "name": "ugp_data_level", "value": 1 } ] }, { "links": [ { "rel": "self", "href": "https://pseudo.com/iam/governance/selfservice/api/v1/roles/10" } ], "id": "10", "fields": [ { "name": "Role Name", "value": "Fraud Supervisor" }, { "name": "ugp_update", "value": 1560458919000 }, { "name": "ugp_createby", "value": 1 }, { "name": "Role Key", "value": "10" }, { "name": "ugp_create", "value": 1560458919000 }, { "name": "Role Display Name", "value": "Fraud Supervisor" }, { "name": "ugp_updateby", "value": 1 }, { "name": "Role Unique Name", "value": "Fraud Supervisor" }, { "name": "Role Category Key", "value": 1 }, { "name": "Role Owner Key", "value": 1 }, { "name": "Role Namespace", "value": "Default" } ] }, { "links": [ { "rel": "self", "href": "https://pseudo.com/iam/governance/selfservice/api/v1/roles/11" } ], "id": "11", "fields": [ { "name": "Role Description", "value": "chargeback description" }, { "name": "Role Name", "value": "Chargeback Supervisor" }, { "name": "ugp_update", "value": 1560790913000 }, { "name": "ugp_createby", "value": 1 }, { "name": "Role Key", "value": "11" }, { "name": "ugp_create", "value": 1560458920000 }, { "name": "Role Display Name", "value": "Chargeback Supervisor" }, { "name": "ugp_updateby", "value": 83 }, { "name": "Role Unique Name", "value": "Chargeback Supervisor" }, { "name": "Role Category Key", "value": 1 }, { "name": "Role Owner Key", "value": 1 }, { "name": "Role Namespace", "value": "Default" } ] } ], "pendingRoles": [ { "roleId": "8", "userId": "82", "roleGrantAttributes": [ { "name": "prg_update", "value": 1564001175000 }, { "name": "prov_by", "value": 6001 }, { "name": "prov_mechanism", "value": "Request" }, { "name": "ugp_key", "value": 8 }, { "name": "usr_key", "value": 82 }, { "name": "request_id", "value": "6001" }, { "name": "startDate", "value": 1564642800000 }, { "name": "request_key", "value": 6001 }, { "name": "prg_create", "value": 1564001175000 }, { "name": "Role Name", "value": "Fraud Analyst" }, { "name": "Role Description" } ] } ], "accounts": [ { "id": "1", "name": "dtran20190614", "userId": "82", "appInstanceId": "1", "requestId": "", "fields": [ { "name": "Status", "value": "Enabled" }, { "name": "Policy Key", "value": "" }, { "name": "Provisioned By", "value": "1" }, { "name": "Risk Summary", "value": 0 }, { "name": "Account Data", "value": [] }, { "name": "Provisioned-On Date", "value": "2019-06-14T17:24:08Z" }, { "name": "Process Instance Key", "value": "200" }, { "name": "Valid From Date", "value": "2019-06-14T17:24:08Z" }, { "name": "Account Description", "value": "dtran20190614" }, { "name": "Account Type", "value": "Primary" }, { "name": "Normalize Data", "value": [] } ] }, { "id": "23", "name": "dtran20190614c", "userId": "82", "appInstanceId": "1", "requestId": "", "fields": [ { "name": "Status", "value": "Provisioning" }, { "name": "Policy Key", "value": "" }, { "name": "Provisioned By", "value": "83" }, { "name": "Risk Summary", "value": 0 }, { "name": "Account Data", "value": [] }, { "name": "Provisioned-On Date", "value": "2019-06-17T16:52:14Z" }, { "name": "Valid To Date", "value": "2019-07-21T16:56:00Z" }, { "name": "Process Instance Key", "value": "223" }, { "name": "Valid From Date", "value": "2019-06-21T16:51:21Z" }, { "name": "Account Description", "value": "dtran20190614c" }, { "name": "Account Type", "value": "Unknown" }, { "name": "Normalize Data", "value": [] } ] }, { "id": "22", "name": "dtran20190614b", "userId": "82", "appInstanceId": "1", "requestId": "", "fields": [ { "name": "Status", "value": "Provisioning" }, { "name": "Policy Key", "value": "" }, { "name": "Provisioned By", "value": "83" }, { "name": "Risk Summary", "value": 0 }, { "name": "Account Data", "value": [] }, { "name": "Provisioned-On Date", "value": "2019-06-17T16:50:25Z" }, { "name": "Process Instance Key", "value": "222" }, { "name": "Valid From Date", "value": "2019-06-17T16:50:25Z" }, { "name": "Account Description", "value": "dtran20190614b" }, { "name": "Account Type", "value": "Unknown" }, { "name": "Normalize Data", "value": [] } ] }, { "id": "21", "name": "dtran20190614a", "userId": "82", "appInstanceId": "1", "requestId": "", "fields": [ { "name": "Status", "value": "Provisioning" }, { "name": "Policy Key", "value": "" }, { "name": "Provisioned By", "value": "83" }, { "name": "Risk Summary", "value": 0 }, { "name": "Account Data", "value": [] }, { "name": "Provisioned-On Date", "value": "2019-06-17T16:47:14Z" }, { "name": "Process Instance Key", "value": "221" }, { "name": "Valid From Date", "value": "2019-06-17T16:47:13Z" }, { "name": "Account Description", "value": "dtran20190614a" }, { "name": "Account Type", "value": "Unknown" }, { "name": "Normalize Data", "value": [] } ] }, { "id": "25", "name": "225", "userId": "82", "appInstanceId": "21", "requestId": "", "fields": [ { "name": "Status", "value": "Provisioned" }, { "name": "Policy Key", "value": "" }, { "name": "Provisioned By", "value": "83" }, { "name": "Risk Summary", "value": 0 }, { "name": "Account Data", "value": [] }, { "name": "Provisioned-On Date", "value": "2019-06-21T17:35:53Z" }, { "name": "Valid To Date", "value": "2019-07-25T18:30:00Z" }, { "name": "Process Instance Key", "value": "225" }, { "name": "Valid From Date", "value": "2019-06-21T17:35:53Z" }, { "name": "Account Description", "value": "225" }, { "name": "Account Type", "value": "Primary" }, { "name": "Normalize Data", "value": [] } ] }, { "id": "24", "name": "224", "userId": "82", "appInstanceId": "21", "requestId": "", "fields": [ { "name": "Status", "value": "Provisioned" }, { "name": "Policy Key", "value": "" }, { "name": "Provisioned By", "value": "83" }, { "name": "Risk Summary", "value": 0 }, { "name": "Account Data", "value": [] }, { "name": "Provisioned-On Date", "value": "2019-06-21T17:32:15Z" }, { "name": "Valid To Date", "value": "2019-07-25T18:30:00Z" }, { "name": "Process Instance Key", "value": "224" }, { "name": "Valid From Date", "value": "2019-06-25T18:30:00Z" }, { "name": "Account Description", "value": "224" }, "name": "Account Type", "value": "Other" }, { "name": "Normalize Data", "value": [] } ] } ], "entitlements": [ { "id": "1", "name": "CN=ADGroup_AGJ,OU=MainOrg_TRU,OU=Vision,DC=adlrg12c,DC=us,DC=pseudo,DC=com", "description": "", "itResourseName": "Vision Employees Domain Resource", "applicationInstanceName": { "name": "applicationInstance", "value": "VisionEmployeesDomain" }, "formName": "UD_ADUSRC", "status": "Provisioned", "entListKey": 265, "provisionedOn": 1560533082000, "startDate": "2019-06-14T17:24:41Z", "requestKey": "5", "provisionedMechanism": "REQUEST", "provisionedBy": "5", "processInstanceKey": 200, "policyKey": 0, "accountKey": 1, "userKey": 82, "serialVersionUid": 2, "chidlFormName": "UD_ADUSRC", "childFormValues": { "UD_ADUSRC_GROUPNAME": "8~CN=ADGroup_AGJ,OU=MainOrg_TRU,OU=Vision,DC=adlrg12c,DC=us,DC=pseudo,DC=com" }, "normalizedData": { "Group Name": [ "8~CN=ADGroup_AGJ,OU=MainOrg_TRU,OU=Vision,DC=adlrg12c,DC=us,DC=pseudo,DC=com" ] }, "childTablePrimaryKey": 1 }, { "id": "2", "name": "CN=ADGroup_ADV,OU=MainOrg_FKX,OU=Vision,DC=adlrg12c,DC=us,DC=pseudo,DC=com", "description": "", "itResourseName": "Vision Employees Domain Resource", "applicationInstanceName": { "name": "applicationInstance", "value": "VisionEmployeesDomain" }, "formName": "UD_ADUSRC", "status": "Provisioned", "entListKey": 276, "provisionedOn": 1560533083000, "startDate": "2019-06-14T17:24:43Z", "requestKey": "6", "provisionedMechanism": "REQUEST", "provisionedBy": "6", "processInstanceKey": 200, "policyKey": 0, "accountKey": 1, "userKey": 82, "serialVersionUid": 2, "chidlFormName": "UD_ADUSRC", "childFormValues": { "UD_ADUSRC_GROUPNAME": "8~CN=ADGroup_ADV,OU=MainOrg_FKX,OU=Vision,DC=adlrg12c,DC=us,DC=pseudo,DC=com" }, "normalizedData": { "Group Name": [ "8~CN=ADGroup_ADV,OU=MainOrg_FKX,OU=Vision,DC=adlrg12c,DC=us,DC=pseudo,DC=com" ] }, "childTablePrimaryKey": 2 }, { "id": "3", "name": "CN=ADGroup_AHB,OU=MainOrg_WJR,OU=Vision,DC=adlrg12c,DC=us,DC=pseudo,DC=com", "description": "", "itResourseName": "Vision Employees Domain Resource", "applicationInstanceName": { "name": "applicationInstance", "value": "VisionEmployeesDomain" }, "formName": "UD_ADUSRC", "status": "Provisioned", "entListKey": 719, "provisionedOn": 1560533084000, "startDate": "2019-06-14T17:24:44Z", "requestKey": "7", "provisionedMechanism": "REQUEST", "provisionedBy": "7", "processInstanceKey": 200, "policyKey": 0, "accountKey": 1, "userKey": 82, "serialVersionUid": 2, "chidlFormName": "UD_ADUSRC", "childFormValues": { "UD_ADUSRC_GROUPNAME": "8~CN=ADGroup_AHB,OU=MainOrg_WJR,OU=Vision,DC=adlrg12c,DC=us,DC=pseudo,DC=com" }, "normalizedData": { "Group Name": [ "8~CN=ADGroup_AHB,OU=MainOrg_WJR,OU=Vision,DC=adlrg12c,DC=us,DC=pseudo,DC=com" ] }, "childTablePrimaryKey": 3 } ] }