Updating a Permission Set

Function

This API is used to update the attributes of a specified permission set according to the permission set ID. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.

URI

PUT /v1/instances/{instance_id}/permission-sets/{permission_set_id}

**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.

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
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

Response Parameters

Status code: 400

**Table 4** 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 5** 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: 404

**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.

Example Request

Updating the attributes of a specified permission set according to the permission set ID

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

{
  "description" : "Update an example permission set",
  "relay_state" : "",
  "session_duration" : "PT8H"
}