Cluster OIDCの照会

Prev Next

VPC環境で利用できます。

特定のクラスタの OIDC設定情報を照会します。

リクエスト

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

メソッド URI
GET /clusters/{uuid}/oidc

リクエストヘッダ

Ncloud Kubernetes Service APIリクエストで共通して使用されるヘッダの詳細は、Ncloud Kubernetes Serviceの共通リクエストヘッダをご参照ください。

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

パラメータの説明は次の通りです。

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

リクエスト例

リクエストのサンプルコードは次の通りです。

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}' \

レスポンス

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

レスポンス構文

レスポンス構文は次の通りです。

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
clientId String - OIDCプロバイダの Client ID
groupsClaim String - ユーザーの groupsとして使用する JWT Claim
groupsPrefix String - groupsClaimの先頭に追加する接頭辞
  • 既存のグループとの衝突を防止するために使用
issuserURL String - OIDCプロバイダの URL
requiredClaim String - IDトークンに必須 claimを指定する key=valueの対
status Boolean -
  • true | false
usernameClaim String - ユーザーの usernameとして使用する Claim
usernamePrefix String - usernameClaimの先頭に追加する接頭辞
  • 既存のユーザー名との衝突を防止するために使用

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

Ncloud Kubernetes Service APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Kubernetes Serviceのレスポンスステータスコードをご参照ください。

レスポンス例

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

{
     "status": false
}

または

{
    "status": true,
    "clientId": "****52578605-08hva51gs5dbuoocv3e2ml5jh5dp****.apps.googleusercontent.com",
    "issuerURL": "https://accounts.google.com",
    "groupsClaim": "",
    "groupsPrefix": "",
    "usernameClaim": "",
    "usernamePrefix": ""
}