Create cluster IAM access

Article summary

Did you find this summary helpful?

Thank you for your feedback

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	/clusters/{uuid}/access-entries

Request headers

For headers common to all Ncloud Kubernetes Service APIs, see Ncloud Kubernetes Service common 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[].type`	String	Conditional	Policy type Required when entering `policies[]` `NKSClusterAdminPolicy` `NKSAdminPolicy` `NKSEditPolicy` `NKSViewPolicy`
`policies[].scope`	String	Conditional	Policy scope Required when entering `policies[]` `cluster` `namespace`
`policies[].namespaces`	Array	Conditional	Namespace Required when the `policies[].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 response 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****"
}

Was this article helpful?

What's Next

Edit cluster IAM access

Table of contents

Request
Response