Edit permission set

Prev Next

Available in Classic and VPC

Edit description and policy of a permission set.

Request

This section describes the request format. The method and URI are as follows:

Method URI
PUT /api/v1/permission-sets/{permissionSetId}

Request headers

For information about the headers common to all Ncloud Single Sign-On APIs, see Ncloud Single Sign-On request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
permissionSetId String Required Permission set ID

Request body

You can include the following data in the body of your request:

Field Type Required Description
description String Optional Permission set description
  • 0-300 characters
systemManagedPolicyIds Array Conditional List of System Managed policy IDs
  • See Get system managed policy list
  • Required when setting a system managed policy
  • One or more system managed policies or user created policies must be entered, and up to 10 can be added in total
userCreatedPolicyNames Array Conditional List of User Created policy names
  • Required when setting a user created policy
  • One or more system managed policies or user created policies must be entered, and up to 10 can be added in total

Request example

The request example is as follows:

curl --location --request PUT 'https://sso.apigw.ntruss.com/api/v1/permission-sets/23ab7cb3-****-****-****-0b2222cb93e5' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "description": "permissionset000 description",
    "systemManagedPolicyIds": [
        "3b773a30-****-****-****-246e96592200"
    ],
    "userCreatedPolicyNames": [
        "policy001"
    ]
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
id String - Permission set ID
success Boolean - API processing result
  • true | false
    • true: succeeded
    • false: failed
message String - Result message
  • Displayed if success is false

Response status codes

For information about the response status codes common to all Ncloud Single Sign-On APIs, see Ncloud Single Sign-On response status codes.

Response example

The response example is as follows:

{
    "id": "23ab7cb3-****-****-****-0b2222cb93e5",
    "success": true
}