MENU
      View cluster OIDC
        • PDF

        View cluster OIDC

        • PDF

        Article summary

        Available in VPC

        View OIDC configuration information for a specific cluster.

        Requests

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

        MethodURI
        GET/clusters/{uuid}/oidc

        Request headers

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

        Request path parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        uuidStringRequiredCluster's UUID

        Request example

        The following is a sample request.

        curl --location --request GET 'https://nks.apigw.ntruss.com/vnks/v2/clusters/0000a20e-e0fb-4dc9-af1b-97fd3f8d0000/oidc' \
        --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}' \
        Curl

        Responses

        The following describes the response format.

        Response syntax

        The response syntax is as follows.

        {
          "clientId": "String",
          "groupsClaim": "String",
          "groupsPrefix": "String",
          "issuerURL": "String",
          "requiredClaim": "String",
          "status": "Boolean",
          "usernameClaim": "String",
          "usernamePrefix": "String"
        }
        JSON

        Response body

        The following describes the response body.

        FieldTypeRequiredDescription
        clientIdString-Client ID of the OIDC provider
        groupsClaimString-JWT Claim to use as the user's groups
        groupsPrefixString-Prefix to add before groupsClaim
        • Use to avoid conflicts with existing groups
        issuserURLString-URL of the OIDC provider
        requiredClaimString-Key=value pairs that specify a required claim in the ID token
        statusBoolean-
        • true | false
        usernameClaimString-Claim to use as the user's username
        usernamePrefixString-Prefix to add before usernameClaim
        • Use to avoid conflicts with existing usernames

        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 response.

        {
             "status": false
        }
        JSON

        or

        {
            "status": true,
            "clientId": "****52578605-08hva51gs5dbuoocv3e2ml5jh5dp****.apps.googleusercontent.com",
            "issuerURL": "https://accounts.google.com",
            "groupsClaim": "",
            "groupsPrefix": "",
            "usernameClaim": "",
            "usernamePrefix": ""
        }
        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.