Cluster OIDC 설정

VPC 환경에서 이용 가능합니다.

OIDC(OpenID Connect)는 하나의 OpenID를 이용하여 OpenID 인증을 허용하는 여러 플랫폼에서 사용자 인증을 손쉽게 구현할 수 있는 기능입니다.
OIDC 제공자를 설정하여 클러스터에 OIDC 인증 기능을 추가합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
PATCH	/clusters/{uuid}/oidc

요청 헤더

Ncloud Kubernetes Service API에서 공통으로 사용하는 헤더에 대한 자세한 내용은 Ncloud Kubernetes Service 공통 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`uuid`	String	Required	클러스터의 UUID 클러스터 목록 조회를 통해 확인

요청 구문

요청 구문은 다음과 같습니다.

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

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`status`	Boolean	Required	`true` \| `false`
`clientId`	String	Required	OIDC 제공자의 Client ID
`issuserURL`	String	Required	OIDC 제공자의 URL
`groupsClaim`	String	Optional	사용자의 groups로 사용할 JWT Claim
`groupsPrefix`	String	Optional	`groupsClaim` 앞에 추가할 접두사 기존 그룹과 충돌을 방지하기 위해 사용
`usernameClaim`	String	Optional	사용자의 username으로 사용할 Claim
`usernamePrefix`	String	Optional	`usernameClaim` 앞에 추가할 접두사 기존 사용자 이름과 충돌을 방지하기 위해 사용
`requiredClaim`	String	Optional	ID 토큰에 필수 claim을 지정하는 key=value 쌍

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request PATCH 'https://nks.apigw.gov-ntruss.com/vnks/v2/clusters/****a20e-e0fb-4dc9-af1b-97fd3f8d****/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"
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`uuid`	String	-	클러스터의 UUID

응답 상태 코드

Ncloud Kubernetes Service API에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 Ncloud Kubernetes Service 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "uuid": "****a20e-e0fb-4dc9-af1b-97fd3f8d****"
}