Create permission set

The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.

Available in Classic and VPC

Create permission sets. By adding the System Managed and User Created policies of the Sub Account service to a permission set, the admin can create a bundle of permissions as desired.

Request

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

Method	URI
POST	/api/v1/permission-sets

Request headers

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

Request body

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

Field	Type	Required	Description
`permissionSetName`	String	Required	Permission set name Enter 2-30 characters by combining English letters, numbers, and special characters "-" and "_" It must start with an English letter It can't be changed after creation
`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 POST 'https://sso.apigw.ntruss.com/api/v1/permission-sets' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "permissionSetName": "permissionset000",
    "description": "description",
    "systemManagedPolicyIds": [
        "3b773a30-****-****-****-246e96592200",
        "3b75b390-****-****-****-246e96592200"
    ],
    "userCreatedPolicyNames": [
        "policy000"
    ]
}'

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
`nrn`	String	-	NAVER Cloud Platform resource identification value for permission set
`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",
    "nrn": "nrn:PUB:SSO::*******:PermissionSet/23ab7cb3-****-****-****-0b2222cb93e5",
    "success": true
}