View cluster OIDC
- Print
- PDF
View cluster OIDC
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
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.
| Method | URI |
|---|---|
| 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.
| Field | Type | Required | Description |
|---|---|---|---|
uuid | String | Required | Cluster'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}' \
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"
}
Response body
The following describes the response body.
| Field | Type | Required | Description |
|---|---|---|---|
clientId | String | - | Client ID of the OIDC provider |
groupsClaim | String | - | JWT Claim to use as the user's groups |
groupsPrefix | String | - | Prefix to add before groupsClaim
|
issuserURL | String | - | URL of the OIDC provider |
requiredClaim | String | - | Key=value pairs that specify a required claim in the ID token |
status | Boolean | - |
|
usernameClaim | String | - | Claim to use as the user's username |
usernamePrefix | String | - | Prefix to add before usernameClaim
|
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
}
or
{
"status": true,
"clientId": "****52578605-08hva51gs5dbuoocv3e2ml5jh5dp****.apps.googleusercontent.com",
"issuerURL": "https://accounts.google.com",
"groupsClaim": "",
"groupsPrefix": "",
"usernameClaim": "",
"usernamePrefix": ""
}
Was this article helpful?