Help Center/ IAM Identity Center/ API Reference/ API/ Account Assignment Management/ Listing Users or Groups Associated with an Account and a Permission Set

Updated on 2024-04-10 GMT+08:00

Online Debugging

CLI Examples

View PDF

Listing Users or Groups Associated with an Account and a Permission Set

Function

This API is used to list the users or groups associated with a specified account and a specified permission set.

URI

GET /v1/instances/{instance_id}/account-assignments

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
instance_id	Yes	String	Globally unique ID of an IAM Identity Center instance

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Maximum number of results returned for each request Minimum value: 1 Maximum value: 100 Default value: 100
marker	No	String	Pagination marker Minimum length: 24 Maximum length: 24
account_id	Yes	String	Unique ID of a specified account
permission_set_id	No	String	Unique ID of a specified permission set

Request Parameters

**Table 3** Parameters in the request header
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. Maximum length: 2048

Response Parameters

Status code: 200

**Table 4** Parameters in the response body
Parameter	Type	Description
account_assignments	Array of objects	Listed account assignments
page_info	Object	Pagination information

**Table 5** account_assignments
Parameter	Type	Description
account_id	String	Unique ID of an account
permission_set_id	String	Unique ID of a permission set
principal_id	String	Unique ID of a principal (for example, a user or group) in IAM Identity Center
principal_type	String	Associated principal type Enumerated value: USER GROUP

**Table 6** page_info
Parameter	Type	Description
next_marker	String	If present, it indicates that the available output is more than the output contained in the current response. Use this value in the marker request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this operation until the next_marker response returns null.
current_count	Integer	Number of records returned on this page

Status code: 400

**Table 7** Parameters in the response body
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message
request_id	String	Unique ID of a request

Status code: 403

**Table 8** Parameters in the response body
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message
request_id	String	Unique ID of a request

Example Request

Listing the users or groups associated with a specified account and a specified permission set

GET https://{hostname}/v1/instances/{instance_id}/account-assignments

Example Response

Status code: 200

Successful

{
  "account_assignments" : [ {
    "account_id" : "5146d03d8aaaaaaaaaaaabbae60620a5",
    "permission_set_id" : "ps-8603aaaaaaaa14bd",
    "principal_id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9",
    "principal_type" : "USER"
  } ],
  "page_info" : {
    "next_marker" : null,
    "current_count" : 1
  }
}