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

Adding a System-defined Policy

Function

This API is used to add a system-defined policy to a specified permission set.

URI

POST /v1/instances/{instance_id}/permission-sets/{permission_set_id}/attach-managed-role

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

managed_role_id

Yes

String

Unique ID of the IAM system-defined policy

managed_role_name

No

String

Name of the IAM system-defined policy

Minimum length: 1

Maximum length: 128

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

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

Status code: 409

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

Example Request

Adding a system-defined policy to a specified permission set

POST https://{hostname}/v1/instances/{instance_id}/permission-sets/{permission_set_id}/attach-managed-roles

{
  "managed_role_id" : "ba5146848aaaaaaaaaaaa03de60620a5",
  "managed_role_name" : "role_example_456"
}

Example Response

None

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.