Edit cluster IAM access

Available in VPC

Edit IAM access information for a created cluster.

Request

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

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

Request headers

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

Request path parameters

You can use the following path parameters with your request:

Field	Type	Required	Description
`uuid`	String	Required	Cluster's UUID See Get cluster list
`entryUuid`	String	Required	IAM access entry UUID See Get IAM access list

Request syntax

The request syntax is as follows.

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

Request body

The following describes the request body.

Field	Type	Required	Description
`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 PUT 'https://nks.apigw.ntruss.com/vnks/v2/clusters/****a20e-e0fb-4dc9-af1b-97fd3f8d****/access-entries/****a20e-e0fb-4dc9-af1b-97fd3f8d****' \
--header 'x-ncp-apigw-timestamp: {timestamp}' \
--header 'x-ncp-iam-access-key: {access key}' \
--header 'x-ncp-apigw-signature-v2: {API gateway signature}' \
--data '{
  "policies": [
    {
      "type": "NKSClusterAdminPolicy",
      "entryUuid": "cluster"
    }
  ]
}'

Response

The following describes the response format.

Response syntax

The response syntax is as follows.

{
    "uuid": "string",
    "entryUuid": "string"
}

Response body

The following describes the response body.

Field	Type	Required	Description
`uuid`	String	-	UUID of the cluster
`entryUuid`	String	-	IAM access entry UUID

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****",
    "entryUuid": "****a20e-e0fb-4dc9-af1b-97fd3f8d****"
}