Listing Applications Associated with a User or User Group
Function
This API is used to list applications associated with 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-assignments-for-principals
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
instance_id |
Yes |
String |
Globally unique ID of an IAM Identity Center instance. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
principal_id |
Yes |
String |
Globally unique ID of a principal. |
|
principal_type |
Yes |
String |
Principal type. The value can be USER or GROUP. |
|
limit |
No |
Integer |
Maximum number of results returned for each request. |
|
marker |
No |
String |
Pagination marker. |
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 |
|---|---|---|
|
application_assignments |
Array of ApplicationAssignmentDto objects |
Principal assigned with an application. |
|
page_info |
PageInfoDto object |
Pagination information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
application_urn |
String |
Application URN. |
|
principal_id |
String |
Principal ID. |
|
principal_type |
String |
Principal type. |
|
Parameter |
Type |
Description |
|---|---|---|
|
next_marker |
String |
If present, more output is available than that included in the current response. To get the next part of the output, use this value in the request parameter in a subsequent call to the same API. You should repeat calling until the next_marker parameter is null in a response. |
|
current_count |
Integer |
Number of items returned on this page. |
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. |
Example Request
Listing applications associated with a user or user group
GET https://{hostname}/v1/instances/{instance_id}/application-assignments-for-principals
Example Response
Status code: 200
Successful
{
"application_assignments" : [ {
"application_urn" : "IdentityCenter::8c1eef3a241945f69c3d3a6b0xxxxx:application:ins-36218e5b4cxxxx/apl-83142f08178ce359",
"principal_id" : "4b969bc6-e8ed-47ce-b62b-936319e2bcb1",
"principal_type" : "USER"
}, {
"application_urn" : "IdentityCenter::8c1eef3a241945f69c3d3a6b02xxx:application:ins-36218e5b4c2cxxx/apl-83142f08178ce349",
"principal_id" : "4b969bc6-e8ed-47ce-b62b-936319e2bcb1",
"principal_type" : "USER"
} ],
"page_info" : {
"next_marker" : null,
"current_count" : 2
}
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Successful. |
|
400 |
Bad request. |
|
403 |
Forbidden. |
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.