Set cluster OIDC

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in VPC

OpenID Connect (OIDC) is a feature that allows you to easily implement user authentication across multiple platforms that accept OpenID authentication using a single OpenID.
Add the OIDC authentication feature to a cluster by setting up an OIDC provider.

Requests

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

Method	URI
PATCH	/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.

Field	Type	Required	Description
`uuid`	String	Required	Cluster's UUID Check through View cluster list

Request syntax

The request syntax is as follows.

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

Request body

The following describes the request body.

Field	Type	Required	Description
`status`	Boolean	Required	Whether OIDC authentication is enabled `true` \| `false`
`clientId`	String	Required	Client ID of the OIDC provider
`issuserURL`	String	Required	URL of the OIDC provider
`groupsClaim`	String	Optional	JWT Claim to use as the user's groups
`groupsPrefix`	String	Optional	Prefix to add before `groupsClaim` Use to avoid conflicts with existing groups
`usernameClaim`	String	Optional	Claim to use as the user's username
`usernamePrefix`	String	Optional	Prefix to add before `usernameClaim` Use to avoid conflicts with existing usernames
`requiredClaim`	String	Optional	Key=value pairs that specify a required claim in the ID token

Request example

The following is a sample request.

curl --location --request PATCH '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}' \
--data '{
    "clientId": "String",
    "issuerURL": "String",
    "status": "true",
    "groupsClaim": "String",
    "groupsPrefix": "String",
    "usernameClaim": "String",
    "usernamePrefix": "String",
    "requiredClaim": "String"
}'

Responses

The following describes the response format.

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

{
    "uuid": "0000a20e-e0fb-4dc9-af1b-97fd3f8d0000"
}

Was this article helpful?

What's Next

View cluster OIDC

Table of contents

Requests
Responses