Cluster OIDCの設定
- 印刷する
- PDF
Cluster OIDCの設定
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
VPC環境で利用できます。
OpenID Connect(OIDC)は、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 | OIDC認証を有効化するかどうか
|
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.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のレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"uuid": "0000a20e-e0fb-4dc9-af1b-97fd3f8d0000"
}
この記事は役に立ちましたか?