Creating a Permission Set_Permission Set Management_API_API Reference

Function

This API is used to create a permission set in a specified IAM Identity Center instance. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.

URI

POST /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.

Request Parameters

**Table 2** 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

**Table 3** Parameters in the request body
Parameter	Mandatory	Type	Description
description	No	String	Description of a permission set. Minimum length: 0 Maximum length: 1024
name	Yes	String	Name of a permission set. Minimum length: 1 Maximum length: 32
relay_state	No	String	Redirection of users within an application during the federated authentication. Minimum length: 0 Maximum length: 240
session_duration	No	String	Length of time that the application user sessions are valid for in the ISO 8601 standard. Minimum length: 1 Maximum length: 100
tags	No	Array of objects	Tags to be attached to a permission set. Array length: 0 - 50

**Table 4** tags
Parameter	Mandatory	Type	Description
key	Yes	String	Tag key. Minimum length: 1 Maximum length: 128
value	Yes	String	Tag value, which can be empty but cannot be null. Minimum length: 0 Maximum length: 255

Response Parameters

Status code: 200

**Table 5** Parameters in the response body
Parameter	Type	Description
permission_set	Object	Permission set details.

**Table 6** permission_set
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.

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.

Status code: 409

**Table 9** 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

Creating a permission set in a specified IAM Identity Center instance

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

{
  "description" : "Create an example permission set",
  "name" : "Create a permission set",
  "relay_state" : "",
  "session_duration" : "PT8H",
  "tags" : [ {
    "key" : "tag_k",
    "value" : "tag_v"
  } ]
}

Example Response

Status code: 200

Successful

{
  "permission_set" : {
    "created_date" : 1677175760379,
    "description" : "Create an example permission set",
    "name" : "Create a permission set",
    "permission_set_id" : "ps-8603aaaaaaaa14bd",
    "relay_state" : "",
    "session_duration" : "PT1H",
    "permission_urn" : "IdentityCenter::system:permissionSet:ps-8603aaaaaaaa14bd"
  }
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Creating a Permission Set