MENU
      Edit cluster IAM access

        Edit cluster IAM access


        Article summary

        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:

        MethodURI
        PUT/clusters/{uuid}/access-entries/{entryUuid}

        Request headers

        For headers common to all Ncloud Kubernetes Service APIs, see Ncloud Kubernetes Service common headers.

        Request path parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        uuidStringRequiredCluster's UUID
        entryUuidStringRequiredIAM access entry UUID

        Request syntax

        The request syntax is as follows.

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

        Request body

        The following describes the request body.

        FieldTypeRequiredDescription
        groups[]ArrayOptionalGroup name
        policies[]ArrayOptionalList of policies to add
        policies[].typeStringConditionalPolicy type
        • Required when entering policies[]
        • NKSClusterAdminPolicy
        • NKSAdminPolicy
        • NKSEditPolicy
        • NKSViewPolicy
        policies[].scopeStringConditionalPolicy scope
        • Required when entering policies[]
        • cluster
        • namespace
        policies[].namespacesArrayConditionalNamespace
        • Required when the policies[].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"
            }
          ]
        }'
        Curl

        Response

        The following describes the response format.

        Response syntax

        The response syntax is as follows.

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

        Response body

        The following describes the response body.

        FieldTypeRequiredDescription
        uuidString-UUID of the cluster
        entryUuidString-IAM access entry UUID

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

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.