Listing Associations Between an Application Instance and a User or User Group
Function
This API is used to list associations between an application instance and a user or user group. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.
URI
GET /v1/instances/{instance_id}/application-instances/{application_instance_id}/profiles
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
instance_id |
Yes |
String |
Globally unique ID of an IAM Identity Center instance. |
application_instance_id |
Yes |
String |
Application instance ID. Its prefix is app-ins-. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Security-Token |
No |
String |
Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
applicationProfiles |
Array of ApplicationProfileDto objects |
Application profile. |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Association name. The default value is Default. |
status |
String |
Association status. The default value is ENABLED. |
profile_id |
String |
ID of the association between a principal and an application. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
request_id |
String |
Unique ID of a request. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
request_id |
String |
Unique ID of a request. |
encoded_authorization_message |
String |
Encrypted error message. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
request_id |
String |
Unique ID of a request. |
Example Request
Listing associations between an application instance and a user or user group
GET https://{hostname}/v1/instances/{instance_id}/application-instances/{application_instance_id}/profiles
Example Response
Status code: 200
Successful
{ "application_profiles" : [ { "name" : "Default", "status" : "ENABLED", "profile_id" : "p-dc6434b56c4e5221" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
Successful. |
400 |
Bad request. |
403 |
Forbidden. |
404 |
Not found. |
Error Codes
For details, 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