---
title: "Cluster OIDCの設定"
slug: "nks-patchoidc"
updated: 2026-09-17T09:57:47Z
published: 2026-09-17T09:57:47Z
canonical: "api.ncloud-docs.com/nks-patchoidc"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Cluster OIDCの設定

VPC環境で利用できます。

OpenID Connect(OIDC)は、OpenIDを利用して OpenID認証をサポートする様々なプラットフォームでユーザー認証を手軽に実装できる機能です。 OIDCプロバイダを設定してクラスタに OIDC認証機能を追加します。

## リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

| メソッド | URI |
| --- | --- |
| PATCH | /vnks/v2/clusters/{uuid}/oidc (韓国リージョン) |
| PATCH | /vnks/sgn-v2/clusters/{uuid}/oidc (シンガポールリージョン) |
| PATCH | /vnks/jpn-v2/clusters/{uuid}/oidc (日本リージョン) |

### リクエストヘッダ

Ncloud Kubernetes Service APIリクエストで共通して使用されるヘッダの詳細は、[Ncloud Kubernetes Serviceのリクエストヘッダ](/docs/ja/compute-vpckubernetesservice#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

### リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `uuid` | String | Required | クラスタの UUID - [クラスタリストの照会](/docs/ja/nks-getclusterlist)を参照 |

### リクエスト構文

リクエスト構文は次の通りです。

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

### リクエストボディ

リクエストボディの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `status` | Boolean | Required | OIDC認証を有効化するかどうか - `true` \| `false` |
| `clientId` | String | Required | OIDCプロバイダの Client ID |
| `issuerURL` | 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.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"
}'
```

## レスポンス

レスポンス形式を説明します。

### レスポンスボディ

レスポンスボディの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `uuid` | String | - | クラスタの UUID |

### レスポンスステータスコード

Ncloud Kubernetes Service APIで共通して使用されるレスポンスステータスコードの詳細は、[Ncloud Kubernetes Serviceのレスポンスステータスコード](/docs/ja/compute-vpckubernetesservice#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

レスポンスのサンプルコードは次の通りです。

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