Querying IAM Identity Center Users
Function
This API is used to query the information about IAM Identity Center users.
URI
GET https://{endpoint}/v1/landing-zone/identity-center
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
identity_store_id |
String |
ID of the IAM Identity Center directory. |
user_portal_url |
String |
Login URL of the IAM Identity Center. |
permission_sets |
Array of PermissionSet objects |
IAM Identity Center permission set. |
groups |
Array of IdentityCenterGroup objects |
IAM Identity Center user group. |
Parameter |
Type |
Description |
---|---|---|
permission_set_id |
String |
ID of a permission set. |
permission_set_name |
String |
Name of a permission set. |
description |
String |
Description of a permission set. |
Parameter |
Type |
Description |
---|---|---|
group_id |
String |
ID of a user group in IAM Identity Center. |
group_name |
String |
Name of a user group. |
description |
String |
Information about a user group in IAM Identity Center. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
request_id |
String |
Unique ID of the request. |
encoded_authorization_message |
String |
Encrypted error message. |
details |
Array of ForbiddenErrorDetail objects |
Error message indicating no permissions for cross-service invoking. |
Example Requests
Querying the information about IAM Identity Center users
GET https://{endpoint}/v1/landing-zone/identity-center
Example Responses
Status code: 200
Request succeeded.
{ "identity_store_id" : "string", "user_portal_url" : "string", "permission_sets" : [ { "permission_set_id" : "string", "permission_set_name" : "string", "description" : "string" } ], "groups" : [ { "group_id" : "string", "group_name" : "string", "description" : "string" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
Request succeeded. |
403 |
No permissions. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot