Listing Permission Sets_Permission Set Management_API_API Reference

Function

This API is used to list the permission sets of a specified instance. 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

**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
permission_set_id	No	String	Globally unique ID of a permission set.
permission_urn	No	String	Global unique URN of a permission set.
name	No	String	Name of a 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
permission_sets	Array of objects	Permission set list.
page_info	Object	Pagination information.

**Table 5** permission_sets
Parameter	Type	Description
created_date	Long	Time when a permission set is created.
description	String	Description of a permission set. Minimum length: 1 Maximum length: 700
name	String	Name of a permission set. Minimum length: 1 Maximum length: 32
permission_set_id	String	Unique ID of a permission set.
relay_state	String	Redirection of users within an application during the federated authentication. Minimum length: 1 Maximum length: 240
session_duration	String	Length of time that the application user sessions are valid for in the ISO 8601 standard. Minimum length: 1 Maximum length: 100
permission_urn	String	URN of a permission set.

**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.
encoded_authorization_message	String	Encrypted error message.

Example Request

Listing the permission sets of a specified instance

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

Example Response

Status code: 200

Successful

{
  "permission_sets" : [ {
    "created_date" : 1677175760379,
"description": " Example permission set 1",
    "name" : "test_ps_1",
    "permission_set_id" : "ps-8603aaaaaaaa14bd",
    "relay_state" : "",
    "session_duration" : "PT4H",
    "permission_urn" : "IdentityCenter::system:permissionSet:ps-8603aaaaaaaa14bd"
  } ],
  "page_info" : {
    "next_marker" : "649040aaaaaaaaaaaa3e3050",
    "current_count" : 1
  }
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Listing Permission Sets