Help Center/ IAM Identity Center/ API Reference/ API/ Permission Set Management/ Listing Accounts Associated with a Permission Set
Updated on 2025-08-21 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Listing Accounts Associated with a Permission Set

Function

This API is used to list the accounts associated with a specified permission set. 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}/permission-sets/{permission_set_id}/accounts

Table 1 Path parameters

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Globally unique ID of an IAM Identity Center instance.

permission_set_id

Yes

String

Globally unique ID of a permission set.
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

provisioning_status

No

String

Provisioning status of a permission set.

Enumerated value:

  • LATEST_PERMISSION_SET_PROVISIONED
  • LATEST_PERMISSION_SET_NOT_PROVISIONED

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_ids

Array of strings

Account ID list.

page_info

Object

Pagination information.
Table 5 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 6 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.

encoded_authorization_message

String

Encrypted error message.

Status code: 403

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.

encoded_authorization_message

String

Encrypted error message.

Example Request

Listing the accounts associated with a specified permission set

GET https://{hostname}/v1/instances/{instance_id}/permission-sets/{permission_set_id}/accounts

Example Response

Status code: 200

Successful

{
  "account_ids" : [ "9ced4bf2b81c086cf24fd70c3932f84f" ],
  "page_info" : {
    "next_marker" : null,
    "current_count" : 1
  }
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.