Create cluster IAM access

Available in VPC

Create IAM access for a created cluster based on the entered information.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method	URI
POST	/vnks/v2/clusters/{uuid}/access-entries (Korea Region)
POST	/vnks/sgn-v2/clusters/{uuid}/access-entries (Singapore Region)
POST	/vnks/jpn-v2/clusters/{uuid}/access-entries (Japan Region)

Request headers

For information about the headers common to all Ncloud Kubernetes Service APIs, see Ncloud Kubernetes Service request headers.

Request syntax

The request syntax is as follows.

{
  "type": "string",
  "entry": "string",
  "groups": [
    "string"
  ],
  "policies": [
    {
      "type": "string",
      "scope": "string",
      "namespaces": [
        "string"
      ]
    }
  ]
}

Request body

The following describes the request body.

Field	Type	Required	Description
`type`	String	Required	IAM access type `USER` `ROLE`
`entry`	String	Required	NRN information by IAM USER, ROLE
`groups`	Array	Optional	Group name
`policies`	Array	Optional	List of policies to add: policies

`policies`

The following describes policies.

Field	Type	Required	Description
`type`	String	Conditional	Policy type Required when entering `policies` `NKSClusterAdminPolicy` `NKSAdminPolicy` `NKSEditPolicy` `NKSViewPolicy`
`scope`	String	Conditional	Policy scope Required when entering `policies` `cluster` `namespace`
`namespaces`	Array	Conditional	Namespace Required when the `scope` setting is `namespace`

Request example

The following is a sample request.

curl --location --request POST 'https://nks.apigw.ntruss.com/vnks/v2/clusters/****a20e-e0fb-4dc9-af1b-97fd3f8d****/access-entries' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'
--data '{
  "type": "USER",
  "entry": "string",
  "groups": [
    "string"
  ],
  "policies": [
    {
      "type": "string",
      "scope": "string",
      "namespaces": [
        "string"
      ]
    }
  ]
}'

Response

The following describes the response format.

Response syntax

The response syntax is as follows.

{
    "uuid": "string"
}

Response body

The following describes the response body.

Field	Type	Required	Description
`uuid`	String	-	UUID of the cluster

Response status codes

For information about the HTTP status codes common to all Ncloud Kubernetes Service APIs, see Ncloud Kubernetes Service response status codes.

Response example

The following is a sample example.

{
    "uuid": "****a20e-e0fb-4dc9-af1b-97fd3f8d****"
}