8.16. OAuth [config.openshift.io/v1]


Description
OAuth は、OAuth に関するクラスター全体の情報を保持します。正規名は cluster です。統合された OAuth サーバーを設定するために使用されます。この設定は、最上位の認証設定のタイプが IntegratedOAuth に設定されている場合にのみ適用されます。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
タイプ
object
必須
  • spec

8.16.1. 仕様

Expand
プロパティータイプ説明

apiVersion

string

APIVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これを更新することはできません。CamelCase詳細については、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

metadata

ObjectMeta_v2

標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。

spec

object

spec 設定についてのユーザーが設定できる値を保持します。

status

object

status クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。

8.16.1.1. .spec

Description
spec 設定についてのユーザーが設定できる値を保持します。
タイプ
object
Expand
プロパティータイプDescription

identityProviders

array

IdentityProviders は、ユーザーが自分自身を識別するための方法の順序付きリストです。このリストが空の場合、ID はユーザーにプロビジョニングされません。

identityProviders[]

object

IdentityProvider は、資格情報を使用して認証するユーザーに ID を提供します

テンプレート

object

テンプレートを使用すると、ログインページなどのページをカスタマイズできます。

tokenConfig

object

tokenConfig には、認証トークンとアクセストークンのオプションが含まれています

8.16.1.2. .spec.identityProviders

Description
IdentityProviders は、ユーザーが自分自身を識別するための方法の順序付きリストです。このリストが空の場合、ID はユーザーにプロビジョニングされません。
タイプ
array

8.16.1.3. .spec.identityProviders[]

Description
IdentityProvider は、資格情報を使用して認証するユーザーに ID を提供します
タイプ
object
Expand
プロパティータイプDescription

basicAuth

object

basicAuth には、BasicAuthIdP の設定オプションが含まれています

github

object

github は、GitHub クレデンシャルを使用したユーザー認証を有効にします

gitlab

object

gitlab は、GitLab クレデンシャルを使用したユーザー認証を有効にします

google

object

google は、Google クレデンシャルを使用したユーザー認証を有効にします

htpasswd

object

htpasswd は、HTPasswd ファイルを使用したユーザー認証を有効にして資格情報を検証します

keystone

object

keystone は、keystone パスワードクレデンシャルを使用したユーザー認証を有効にします

ldap

object

ldap は、LDAP クレデンシャルを使用したユーザー認証を有効にします

mappingMethod

string

mappingMethod は、このプロバイダーからの ID がユーザーにどのようにマップされるかを決定します。デフォルトはクレームです。

name

string

name は、このプロバイダーによって返される ID を修飾するために使用されます。- 一意であり、使用されている他の ID プロバイダーと共有されていない必要があります - 有効なパスセグメントである必要があります。名前は。と等しくすることはできません。または..または/または % または: を含む参照: https://godoc.org/github.com/openshift/origin/pkg/user/apis/user/validation#ValidateIdentityProviderName

openID

object

openID は、OpenID クレデンシャルを使用したユーザー認証を有効にします

requestHeader

object

requestHeader は、リクエストヘッダーのクレデンシャルを使用したユーザー認証を有効にします

type

string

type は、このエントリーの ID プロバイダータイプを識別します。

8.16.1.4. .spec.identityProviders[].basicAuth

Description
basicAuth には、BasicAuthIdP の設定オプションが含まれています
タイプ
object
Expand
プロパティータイプDescription

ca

object

ca は、PEM でエンコードされた CA バンドルを含む名前による設定マップへのオプションの参照です。リモートサーバーによって表示される TLS 証明書を検証するためにトラストアンカーとして使用されます。キー ca.crt は、データを見つけるために使用されます。指定され、設定マップまたは予期されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された ca データが有効でない場合、ID プロバイダーは尊重されません。空の場合、デフォルトのシステムルートが使用されます。この設定マップの namespace は openshift-config です。

tlsClientCert

object

tlsClientCert は、サーバーに接続するときに提示する PEM エンコードされた TLS クライアント証明書を含む名前によるシークレットへのオプションの参照です。キー tls.crt は、データを見つけるために使用されます。指定され、シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された証明書データが有効でない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。

tlsClientKey

object

tlsClientKey は、tlsClientCert で参照されるクライアント証明書の PEM エンコードされた TLS 秘密鍵を含む名前によるシークレットへのオプションの参照です。キー tls.key は、データを見つけるために使用されます。指定され、シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された証明書データが有効でない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。

url

string

url は接続するリモート URL です

8.16.1.5. .spec.identityProviders[].basicAuth.ca

Description
ca は、PEM でエンコードされた CA バンドルを含む名前による設定マップへのオプションの参照です。リモートサーバーによって表示される TLS 証明書を検証するためにトラストアンカーとして使用されます。キー ca.crt は、データを見つけるために使用されます。指定され、設定マップまたは予期されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された ca データが有効でない場合、ID プロバイダーは尊重されません。空の場合、デフォルトのシステムルートが使用されます。この設定マップの namespace は openshift-config です。
タイプ
object
必須
  • name
Expand
プロパティータイプ説明

name

string

name は、参照される設定マップの metadata.name です。

8.16.1.6. .spec.identityProviders[].basicAuth.tlsClientCert

Description
tlsClientCert は、サーバーに接続するときに提示する PEM エンコードされた TLS クライアント証明書を含む名前によるシークレットへのオプションの参照です。キー tls.crt は、データを見つけるために使用されます。指定され、シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された証明書データが有効でない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。
タイプ
object
必須
  • name
Expand
プロパティータイプ説明

name

string

name は、参照されるシークレットの metadata.name です。

8.16.1.7. .spec.identityProviders[].basicAuth.tlsClientKey

Description
tlsClientKey は、tlsClientCert で参照されるクライアント証明書の PEM エンコードされた TLS 秘密鍵を含む名前によるシークレットへのオプションの参照です。キー tls.key は、データを見つけるために使用されます。指定され、シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された証明書データが有効でない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。
タイプ
object
必須
  • name
Expand
プロパティータイプ説明

name

string

name は、参照されるシークレットの metadata.name です。

8.16.1.8. .spec.identityProviders[].github

Description
github は、GitHub クレデンシャルを使用したユーザー認証を有効にします
タイプ
object
Expand
プロパティータイプDescription

ca

object

ca は、PEM でエンコードされた CA バンドルを含む名前による設定マップへのオプションの参照です。リモートサーバーによって表示される TLS 証明書を検証するためにトラストアンカーとして使用されます。キー ca.crt は、データを見つけるために使用されます。指定され、設定マップまたは予期されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された ca データが有効でない場合、ID プロバイダーは尊重されません。空の場合、デフォルトのシステムルートが使用されます。これは、ホスト名が空でない値に設定されている場合にのみ設定できます。この設定マップの namespace は openshift-config です。

clientID

string

clientID は oauth クライアント ID です

clientSecret

object

clientSecret は、oauth クライアントシークレットを含む名前によるシークレットへの必須の参照です。キー clientSecret は、データを見つけるために使用されます。シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。

hostname

string

hostname は、GitHub Enterprise のホストされたインスタンスで使用するためのオプションのドメイン (mycompany.com など) です。/setup/settings#hostname で設定されている GitHubEnterprise 設定値と一致する必要があります。

組織

array (string)

組織は、オプションで、ログインを許可する組織を制限します

teams

array (string)

チームは、オプションで、ログインを許可するチームを制限します。形式は <org>/<team> です。

8.16.1.9. .spec.identityProviders[].github.ca

Description
ca は、PEM でエンコードされた CA バンドルを含む名前による設定マップへのオプションの参照です。リモートサーバーによって表示される TLS 証明書を検証するためにトラストアンカーとして使用されます。キー ca.crt は、データを見つけるために使用されます。指定され、設定マップまたは予期されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された ca データが有効でない場合、ID プロバイダーは尊重されません。空の場合、デフォルトのシステムルートが使用されます。これは、ホスト名が空でない値に設定されている場合にのみ設定できます。この設定マップの namespace は openshift-config です。
タイプ
object
必須
  • name
Expand
プロパティータイプ説明

name

string

name は、参照される設定マップの metadata.name です。

8.16.1.10. .spec.identityProviders[].github.clientSecret

Description
clientSecret は、oauth クライアントシークレットを含む名前によるシークレットへの必須の参照です。キー clientSecret は、データを見つけるために使用されます。シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。
タイプ
object
必須
  • name
Expand
プロパティータイプ説明

name

string

name は、参照されるシークレットの metadata.name です。

8.16.1.11. .spec.identityProviders[].gitlab

Description
gitlab は、GitLab クレデンシャルを使用したユーザー認証を有効にします
タイプ
object
Expand
プロパティータイプDescription

ca

object

ca は、PEM でエンコードされた CA バンドルを含む名前による設定マップへのオプションの参照です。リモートサーバーによって表示される TLS 証明書を検証するためにトラストアンカーとして使用されます。キー ca.crt は、データを見つけるために使用されます。指定され、設定マップまたは予期されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された ca データが有効でない場合、ID プロバイダーは尊重されません。空の場合、デフォルトのシステムルートが使用されます。この設定マップの namespace は openshift-config です。

clientID

string

clientID は oauth クライアント ID です

clientSecret

object

clientSecret は、oauth クライアントシークレットを含む名前によるシークレットへの必須の参照です。キー clientSecret は、データを見つけるために使用されます。シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。

url

string

url は oauth サーバーのベース URL です

8.16.1.12. .spec.identityProviders[].gitlab.ca

Description
ca は、PEM でエンコードされた CA バンドルを含む名前による設定マップへのオプションの参照です。リモートサーバーによって表示される TLS 証明書を検証するためにトラストアンカーとして使用されます。キー ca.crt は、データを見つけるために使用されます。指定され、設定マップまたは予期されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された ca データが有効でない場合、ID プロバイダーは尊重されません。空の場合、デフォルトのシステムルートが使用されます。この設定マップの namespace は openshift-config です。
タイプ
object
必須
  • name
Expand
プロパティータイプ説明

name

string

name は、参照される設定マップの metadata.name です。

8.16.1.13. .spec.identityProviders[].gitlab.clientSecret

Description
clientSecret は、oauth クライアントシークレットを含む名前によるシークレットへの必須の参照です。キー clientSecret は、データを見つけるために使用されます。シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。
タイプ
object
必須
  • name
Expand
プロパティータイプ説明

name

string

name は、参照されるシークレットの metadata.name です。

8.16.1.14. .spec.identityProviders[].google

Description
google は、Google クレデンシャルを使用したユーザー認証を有効にします
タイプ
object
Expand
プロパティータイプDescription

clientID

string

clientID は oauth クライアント ID です

clientSecret

object

clientSecret は、oauth クライアントシークレットを含む名前によるシークレットへの必須の参照です。キー clientSecret は、データを見つけるために使用されます。シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。

hostedDomain

string

hostedDomain は、ログインを制限するオプションの Google アプリドメイン (mycompany.com など) です。

8.16.1.15. .spec.identityProviders[].google.clientSecret

Description
clientSecret は、oauth クライアントシークレットを含む名前によるシークレットへの必須の参照です。キー clientSecret は、データを見つけるために使用されます。シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。
タイプ
object
必須
  • name
Expand
プロパティータイプ説明

name

string

name は、参照されるシークレットの metadata.name です。

8.16.1.16. .spec.identityProviders[].htpasswd

Description
htpasswd は、HTPasswd ファイルを使用したユーザー認証を有効にして資格情報を検証します
タイプ
object
Expand
プロパティータイプDescription

fileData

object

fileData は、htpasswd ファイルとして使用するデータを含む名前によるシークレットへの必須の参照です。キー htpasswd は、データを見つけるために使用されます。シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された htpasswd データが有効でない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。

8.16.1.17. .spec.identityProviders[].htpasswd.fileData

Description
fileData は、htpasswd ファイルとして使用するデータを含む名前によるシークレットへの必須の参照です。キー htpasswd は、データを見つけるために使用されます。シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された htpasswd データが有効でない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。
タイプ
object
必須
  • name
Expand
プロパティータイプ説明

name

string

name は、参照されるシークレットの metadata.name です。

8.16.1.18. .spec.identityProviders[].keystone

Description
keystone は、keystone パスワードクレデンシャルを使用したユーザー認証を有効にします
タイプ
object
Expand
プロパティータイプDescription

ca

object

ca は、PEM でエンコードされた CA バンドルを含む名前による設定マップへのオプションの参照です。リモートサーバーによって表示される TLS 証明書を検証するためにトラストアンカーとして使用されます。キー ca.crt は、データを見つけるために使用されます。指定され、設定マップまたは予期されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された ca データが有効でない場合、ID プロバイダーは尊重されません。空の場合、デフォルトのシステムルートが使用されます。この設定マップの namespace は openshift-config です。

domainName

string

keystonev3 には domainName が必要です

tlsClientCert

object

tlsClientCert は、サーバーに接続するときに提示する PEM エンコードされた TLS クライアント証明書を含む名前によるシークレットへのオプションの参照です。キー tls.crt は、データを見つけるために使用されます。指定され、シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された証明書データが有効でない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。

tlsClientKey

object

tlsClientKey は、tlsClientCert で参照されるクライアント証明書の PEM エンコードされた TLS 秘密鍵を含む名前によるシークレットへのオプションの参照です。キー tls.key は、データを見つけるために使用されます。指定され、シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された証明書データが有効でない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。

url

string

url は接続するリモート URL です

8.16.1.19. .spec.identityProviders[].keystone.ca

Description
ca は、PEM でエンコードされた CA バンドルを含む名前による設定マップへのオプションの参照です。リモートサーバーによって表示される TLS 証明書を検証するためにトラストアンカーとして使用されます。キー ca.crt は、データを見つけるために使用されます。指定され、設定マップまたは予期されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された ca データが有効でない場合、ID プロバイダーは尊重されません。空の場合、デフォルトのシステムルートが使用されます。この設定マップの namespace は openshift-config です。
タイプ
object
必須
  • name
Expand
プロパティータイプ説明

name

string

name は、参照される設定マップの metadata.name です。

8.16.1.20. .spec.identityProviders[].keystone.tlsClientCert

Description
tlsClientCert は、サーバーに接続するときに提示する PEM エンコードされた TLS クライアント証明書を含む名前によるシークレットへのオプションの参照です。キー tls.crt は、データを見つけるために使用されます。指定され、シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された証明書データが有効でない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。
タイプ
object
必須
  • name
Expand
プロパティータイプ説明

name

string

name は、参照されるシークレットの metadata.name です。

8.16.1.21. .spec.identityProviders[].keystone.tlsClientKey

Description
tlsClientKey は、tlsClientCert で参照されるクライアント証明書の PEM エンコードされた TLS 秘密鍵を含む名前によるシークレットへのオプションの参照です。キー tls.key は、データを見つけるために使用されます。指定され、シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された証明書データが有効でない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。
タイプ
object
必須
  • name
Expand
プロパティータイプ説明

name

string

name は、参照されるシークレットの metadata.name です。

8.16.1.22. .spec.identityProviders[].ldap

Description
ldap は、LDAP クレデンシャルを使用したユーザー認証を有効にします
タイプ
object
Expand
プロパティータイプDescription

attributes

object

属性は LDAP 属性を ID にマップします

bindDN

string

bindDN は、検索フェーズ中にバインドするオプションの DN です。

bindPassword

object

bindPassword は、検索フェーズ中にバインドするパスワードを含む名前によるシークレットへのオプションの参照です。キー bindPassword は、データを見つけるために使用されます。指定され、シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。

ca

object

ca は、PEM でエンコードされた CA バンドルを含む名前による設定マップへのオプションの参照です。リモートサーバーによって表示される TLS 証明書を検証するためにトラストアンカーとして使用されます。キー ca.crt は、データを見つけるために使用されます。指定され、設定マップまたは予期されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された ca データが有効でない場合、ID プロバイダーは尊重されません。空の場合、デフォルトのシステムルートが使用されます。この設定マップの namespace は openshift-config です。

insecure

ブール値

insecure は、true の場合、接続で TLS を使用しないことを示します警告:ldaps://URL は、insecure が設定されている場合でも、常に TLS を使用して接続を試みるため、URL スキーム ldaps://で true に設定しないでください。to true true の場合、ldap://URL は安全に接続されません。false の場合、ldap://URL は、https://tools.ietf.org/html/rfc2830 で指定されている StartTLS を使用して TLS 接続にアップグレードされます。

url

string

url は、使用する LDAP 検索パラメーターを指定する RFC2255URL です。URL の構文は次のとおりです。ldap://host:port/basedn?attribute?scope?filter

8.16.1.23. .spec.identityProviders[].ldap.attributes

Description
属性は LDAP 属性を ID にマップします
タイプ
object
Expand
プロパティータイプDescription

email

array (string)

email は、値を電子メールアドレスとして使用する必要がある属性のリストです。任意。指定しない場合、ID に電子メールは設定されません

id

array (string)

id は、値をユーザー ID として使用する必要がある属性のリストです。必須。最初の空でない属性が使用されます。少なくとも 1 つの属性が必要です。一覧表示される属性のいずれにも値がない場合、認証は失敗します。LDAP 標準 ID 属性は dn です

name

array (string)

表示名として使用する必要がある値を持つ属性の一覧 (文字列) です。任意。指定しない場合、IDLDAP 標準表示名属性の表示名は cn に設定されません。

preferredUsername

array (string)

priorityUsername は、優先ユーザー名として値を使用する必要がある属性のリストです。LDAP 標準ログイン属性は uid です

8.16.1.24. .spec.identityProviders[].ldap.bindPassword

Description
bindPassword は、検索フェーズ中にバインドするパスワードを含む名前によるシークレットへのオプションの参照です。キー bindPassword は、データを見つけるために使用されます。指定され、シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。
タイプ
object
必須
  • name
Expand
プロパティータイプ説明

name

string

name は、参照されるシークレットの metadata.name です。

8.16.1.25. .spec.identityProviders[].ldap.ca

Description
ca は、PEM でエンコードされた CA バンドルを含む名前による設定マップへのオプションの参照です。リモートサーバーによって表示される TLS 証明書を検証するためにトラストアンカーとして使用されます。キー ca.crt は、データを見つけるために使用されます。指定され、設定マップまたは予期されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された ca データが有効でない場合、ID プロバイダーは尊重されません。空の場合、デフォルトのシステムルートが使用されます。この設定マップの namespace は openshift-config です。
タイプ
object
必須
  • name
Expand
プロパティータイプ説明

name

string

name は、参照される設定マップの metadata.name です。

8.16.1.26. .spec.identityProviders[].openID

Description
openID は、OpenID クレデンシャルを使用したユーザー認証を有効にします
タイプ
object
Expand
プロパティータイプDescription

ca

object

ca は、PEM でエンコードされた CA バンドルを含む名前による設定マップへのオプションの参照です。リモートサーバーによって表示される TLS 証明書を検証するためにトラストアンカーとして使用されます。キー ca.crt は、データを見つけるために使用されます。指定され、設定マップまたは予期されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された ca データが有効でない場合、ID プロバイダーは尊重されません。空の場合、デフォルトのシステムルートが使用されます。この設定マップの namespace は openshift-config です。

請求

object

クレームマッピング

clientID

string

clientID は oauth クライアント ID です

clientSecret

object

clientSecret は、oauth クライアントシークレットを含む名前によるシークレットへの必須の参照です。キー clientSecret は、データを見つけるために使用されます。シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。

extraAuthorizeParameters

object (string)

extraAuthorizeParameters は、承認リクエストに追加するカスタムパラメーターです。

extraScopes

array (string)

extraScopes は、標準の openid スコープに加えて要求するスコープです。

issuer

string

発行者は、OpenID プロバイダーが発行者識別子としてアサートする URL です。クエリーまたはフラグメントコンポーネントのない https スキームを使用する必要があります。

8.16.1.27. .spec.identityProviders[].openID.ca

Description
ca は、PEM でエンコードされた CA バンドルを含む名前による設定マップへのオプションの参照です。リモートサーバーによって表示される TLS 証明書を検証するためにトラストアンカーとして使用されます。キー ca.crt は、データを見つけるために使用されます。指定され、設定マップまたは予期されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された ca データが有効でない場合、ID プロバイダーは尊重されません。空の場合、デフォルトのシステムルートが使用されます。この設定マップの namespace は openshift-config です。
タイプ
object
必須
  • name
Expand
プロパティータイプ説明

name

string

name は、参照される設定マップの metadata.name です。

8.16.1.28. .spec.identityProviders[].openID.claims

Description
クレームマッピング
タイプ
object
Expand
プロパティータイプDescription

email

array (string)

email は、値を電子メールアドレスとして使用する必要があるクレームのリストです。任意。指定しない場合、ID に電子メールは設定されません

groups

array (string)

groups は、OIDC プロバイダーからユーザーの OpenShift にグループを同期するために使用する必要があるクレーム値のリストです。複数の要求が指定されている場合は、値が入力されている最初の要求が使用されます。

name

array (string)

name は、表示名として値を使用する必要があるクレームのリストです。任意。指定しない場合、ID の表示名は設定されません

preferredUsername

array (string)

priorityUsername は、優先ユーザー名として値を使用する必要があるクレームのリストです。指定しない場合、優先ユーザー名はサブクレームの値から決定されます

8.16.1.29. .spec.identityProviders[].openID.clientSecret

Description
clientSecret は、oauth クライアントシークレットを含む名前によるシークレットへの必須の参照です。キー clientSecret は、データを見つけるために使用されます。シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。
タイプ
object
必須
  • name
Expand
プロパティータイプ説明

name

string

name は、参照されるシークレットの metadata.name です。

8.16.1.30. .spec.identityProviders[].requestHeader

Description
requestHeader は、リクエストヘッダーのクレデンシャルを使用したユーザー認証を有効にします
タイプ
object
Expand
プロパティータイプDescription

ca

object

ca は、PEM でエンコードされた CA バンドルを含む名前による設定マップへの必須の参照です。リモートサーバーによって表示される TLS 証明書を検証するためにトラストアンカーとして使用されます。具体的には、着信要求を検証してヘッダーのなりすましを防ぐことができます。キー ca.crt は、データを見つけるために使用されます。設定マップまたは予期されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された ca データが有効でない場合、ID プロバイダーは尊重されません。この設定マップの namespace は openshift-config です。

challengeURL

string

ChallengeURL は、認証されていない/承認されたリクエストを、WWW-Authenticate チャレンジがここにリダイレクトされることを期待する OAuth クライアントからの認証されていないリクエストにリダイレクトするための URL です。$ {url}は現在の URL に置き換えられ、クエリーパラメーターで安全のためにエスケープされます https://www.example.com/sso-login?then=${url}${query} は現在のクエリー文字列に置き換えられます https://www.example.com/auth-proxy/oauth/authorize?${query} チャレンジが true に設定されている場合に必要です。

clientCommonNames

array (string)

clientCommonNames は、一致を要求する一般名のオプションのリストです。空の場合、clientCA バンドルに対して検証されたクライアント証明書はすべて信頼できると見なされます。

emailHeaders

array (string)

emailHeaders は、メールアドレスを確認するためのヘッダーのセットです。

ヘッダー

array (string)

headers は、ID 情報を確認するためのヘッダーのセットです。

loginURL

string

loginURL は認証されていない /authorize リクエストをリダイレクトする URL です。 対話式ログインを期待する OAuth クライアントからの認証されていないリクエストはここにリダイレクトされます ${url} は現在の URL に置き換えられ、クエリーパラメーターとして安全なようにエスケープされます https://www.example.com/sso-login?then=${url} ${query} は現在のクエリー文字列に置き換えられます https://www.example.com/auth-proxy/oauth/authorize?${query}。login が true に設定されている場合は必須です。

nameHeaders

array (string)

nameHeaders は、表示名を確認するためのヘッダーのセットです。

preferredUsernameHeaders

array (string)

priorityUsernameHeaders は、優先ユーザー名を確認するためのヘッダーのセットです。

8.16.1.31. .spec.identityProviders[].requestHeader.ca

Description
ca は、PEM でエンコードされた CA バンドルを含む名前による設定マップへの必須の参照です。リモートサーバーによって表示される TLS 証明書を検証するためにトラストアンカーとして使用されます。具体的には、着信要求を検証してヘッダーのなりすましを防ぐことができます。キー ca.crt は、データを見つけるために使用されます。設定マップまたは予期されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された ca データが有効でない場合、ID プロバイダーは尊重されません。この設定マップの namespace は openshift-config です。
タイプ
object
必須
  • name
Expand
プロパティータイプ説明

name

string

name は、参照される設定マップの metadata.name です。

8.16.1.32. .spec.templates

Description
テンプレートを使用すると、ログインページなどのページをカスタマイズできます。
タイプ
object
Expand
プロパティータイプDescription

error

object

error は、認証または許可フロー中にエラーページをレンダリングするために使用する go テンプレートを指定するシークレットの名前です。キー errors.html は、テンプレートデータを見つけるために使用されます。指定され、秘密鍵または予期される鍵が見つからない場合は、デフォルトのエラーページが使用されます。指定されたテンプレートが無効な場合は、デフォルトのエラーページが使用されます。指定しない場合、デフォルトのエラーページが使用されます。このシークレットの名前空間は openshift-config です。

login

object

login は、ログインページのレンダリングに使用する go テンプレートを指定するシークレットの名前です。キー login.html は、テンプレートデータを見つけるために使用されます。指定され、秘密鍵または予期される鍵が見つからない場合は、デフォルトのログインページが使用されます。指定されたテンプレートが無効な場合は、デフォルトのログインページが使用されます。指定しない場合、デフォルトのログインページが使用されます。このシークレットの名前空間は openshift-config です。

providerSelection

object

ProviderSelection は、プロバイダー選択ページのレンダリングに使用する go テンプレートを指定するシークレットの名前です。キー providers.html は、テンプレートデータを見つけるために使用されます。指定され、秘密鍵または予期される鍵が見つからない場合は、デフォルトのプロバイダー選択ページが使用されます。指定されたテンプレートが無効な場合は、デフォルトのプロバイダー選択ページが使用されます。指定されていない場合、デフォルトのプロバイダー選択ページが使用されます。このシークレットの名前空間は openshift-config です。

8.16.1.33. .spec.templates.error

Description
error は、認証または許可フロー中にエラーページをレンダリングするために使用する go テンプレートを指定するシークレットの名前です。キー errors.html は、テンプレートデータを見つけるために使用されます。指定され、秘密鍵または予期される鍵が見つからない場合は、デフォルトのエラーページが使用されます。指定されたテンプレートが無効な場合は、デフォルトのエラーページが使用されます。指定しない場合、デフォルトのエラーページが使用されます。このシークレットの名前空間は openshift-config です。
タイプ
object
必須
  • name
Expand
プロパティータイプ説明

name

string

name は、参照されるシークレットの metadata.name です。

8.16.1.34. .spec.templates.login

Description
login は、ログインページのレンダリングに使用する go テンプレートを指定するシークレットの名前です。キー login.html は、テンプレートデータを見つけるために使用されます。指定され、秘密鍵または予期される鍵が見つからない場合は、デフォルトのログインページが使用されます。指定されたテンプレートが無効な場合は、デフォルトのログインページが使用されます。指定しない場合、デフォルトのログインページが使用されます。このシークレットの名前空間は openshift-config です。
タイプ
object
必須
  • name
Expand
プロパティータイプ説明

name

string

name は、参照されるシークレットの metadata.name です。

8.16.1.35. .spec.templates.providerSelection

Description
ProviderSelection は、プロバイダー選択ページのレンダリングに使用する go テンプレートを指定するシークレットの名前です。キー providers.html は、テンプレートデータを見つけるために使用されます。指定され、秘密鍵または予期される鍵が見つからない場合は、デフォルトのプロバイダー選択ページが使用されます。指定されたテンプレートが無効な場合は、デフォルトのプロバイダー選択ページが使用されます。指定されていない場合、デフォルトのプロバイダー選択ページが使用されます。このシークレットの名前空間は openshift-config です。
タイプ
object
必須
  • name
Expand
プロパティータイプ説明

name

string

name は、参照されるシークレットの metadata.name です。

8.16.1.36. .spec.tokenConfig

Description
tokenConfig には、認証トークンとアクセストークンのオプションが含まれています
タイプ
object
Expand
プロパティータイプDescription

accessTokenInactivityTimeout

string

accessTokenInactivityTimeout は、任意のクライアントによって付与されたトークンのトークン非アクティブタイムアウトを定義します。この値は、トークンを連続して使用する間に発生する可能性のある最大時間を表します。トークンがこの一時ウィンドウ内で使用されない場合、トークンは無効になります。トークンがタイムアウトしたときにアクセスを回復するには、ユーザーは新しいトークンを取得する必要があります。5m、1.5h、2h45m などの有効な期間文字列を取ります。継続時間の最小許容値は 300 秒 (5 分) です。クライアントごとにタイムアウトが設定されている場合は、その値が優先されます。タイムアウト値が指定されておらず、クライアントが値をオーバーライドしない場合、トークンはその存続期間まで有効です。警告: この値を変更しても、既存のトークンのタイムアウトは影響を受けません (低下します)。

accessTokenInactivityTimeoutSeconds

integer

accessTokenInactivityTimeoutSeconds- 非推奨: このフィールドを設定しても効果はありません。

accessTokenMaxAgeSeconds

integer

accessTokenMaxAgeSeconds は、アクセストークンの最大有効期間を定義します

8.16.1.37. .status

Description
status クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。
タイプ
object

8.16.2. API エンドポイント

以下の API エンドポイントを利用できます。

  • /apis/config.openshift.io/v1/oauths

    • DELETE:OAuth のコレクションを削除します
    • GET: 種類 OAuth のオブジェクトを一覧表示します
    • POST:OAuth を作成します
  • /apis/config.openshift.io/v1/oauths/{name}

    • 削除:OAuth を削除します
    • GET: 指定された OAuth を読み取ります
    • PATCH: 指定された OAuth を部分的に更新します
    • PUT: 指定された OAuth を置き換えます
  • /apis/config.openshift.io/v1/oauths/{name}/status

    • GET: 指定された OAuth のステータスを読み取ります
    • PATCH: 指定された OAuth のステータスを部分的に更新します
    • PUT: 指定された OAuth のステータスを置き換えます

8.16.2.1. /apis/config.openshift.io/v1/oauths

Expand
表8.425 グローバルクエリーパラメーター
パラメータータイプ説明

pretty

string

'true' の場合、出力はきれいに印刷されます。

HTTP メソッド
DELETE
Description
OAuth のコレクションを削除する
Expand
表8.426 クエリーパラメーター
パラメータータイプ説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの裁量で送信されます。クライアントは、ブックマークが特定の間隔で返されると想定したり、サーバーがセッション中に BOOKMARK イベントを送信すると想定したりすることはできません。これが watch でない場合には、このフィールドは無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することを強くお勧めします。詳細については、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

timeoutSeconds

integer

リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。

watch

boolean

説明されているリソースへの変更を監視し、それらを追加、更新、および削除の通知のストリームとして返します。resourceVersion を指定します。

Expand
表8.427 HTTP 応答
HTTP コードレスポンス本文

200 - OK

Status_v2 schema

401 - Unauthorized

空白

HTTP メソッド
GET
Description
OAuth の種類のオブジェクトを一覧表示する
Expand
表8.428 クエリーパラメーター
パラメータータイプ説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの裁量で送信されます。クライアントは、ブックマークが特定の間隔で返されると想定したり、サーバーがセッション中に BOOKMARK イベントを送信すると想定したりすることはできません。これが watch でない場合には、このフィールドは無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することを強くお勧めします。詳細については、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

timeoutSeconds

integer

リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。

watch

boolean

説明されているリソースへの変更を監視し、それらを追加、更新、および削除の通知のストリームとして返します。resourceVersion を指定します。

Expand
表8.429 HTTP 応答
HTTP コードレスポンス本文

200 - OK

OAuthList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
Description
OAuth を作成する
Expand
表8.430 クエリーパラメーター
パラメータータイプ説明

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

Expand
表8.431 ボディパラメーター
パラメータータイプ説明

ボディー

OAuth スキーマ

 
Expand
表8.432 HTTP 応答
HTTP コードレスポンス本文

200 - OK

OAuth スキーマ

201 - Created

OAuth スキーマ

202 - Accepted

OAuth スキーマ

401 - Unauthorized

空白

8.16.2.2. /apis/config.openshift.io/v1/oauths/{name}

Expand
表8.433 グローバルパスパラメーター
パラメータータイプ説明

name

string

OAuth の名前

Expand
表8.434 グローバルクエリーパラメーター
パラメータータイプ説明

pretty

string

'true' の場合、出力はきれいに印刷されます。

HTTP メソッド
DELETE
Description
OAuth を削除する
Expand
表8.435 クエリーパラメーター
パラメータータイプ説明

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

gracePeriodSeconds

integer

オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。

orphanDependents

boolean

非推奨: PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、孤立したファイナライザーがオブジェクトのファイナライザー一覧で追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。

propagationPolicy

string

ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定することはできません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシー。

Expand
表8.436 ボディパラメーター
パラメータータイプ説明

body

DeleteOptions_v2 schema

 
Expand
表8.437 HTTP 応答
HTTP コードレスポンス本文

200 - OK

Status_v2 schema

202 - Accepted

Status_v2 schema

401 - Unauthorized

空白

HTTP メソッド
GET
Description
指定された OAuth を読み取ります
Expand
表8.438 クエリーパラメーター
パラメータータイプ説明

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

Expand
表8.439 HTTP 応答
HTTP コードレスポンス本文

200 - OK

OAuth スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
Description
指定された OAuth を部分的に更新します
Expand
表8.440 クエリーパラメーター
パラメータータイプ説明

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

Expand
表8.441 ボディパラメーター
パラメータータイプ説明

body

Patch schema

 
Expand
表8.442 HTTP 応答
HTTP コードレスポンス本文

200 - OK

OAuth スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
Description
指定された OAuth を置き換えます
Expand
表8.443 クエリーパラメーター
パラメータータイプ説明

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

Expand
表8.444 ボディパラメーター
パラメータータイプ説明

ボディー

OAuth スキーマ

 
Expand
表8.445 HTTP 応答
HTTP コードレスポンス本文

200 - OK

OAuth スキーマ

201 - Created

OAuth スキーマ

401 - Unauthorized

空白

8.16.2.3. /apis/config.openshift.io/v1/oauths/{name}/status

Expand
表8.446 グローバルパスパラメーター
パラメータータイプ説明

name

string

OAuth の名前

Expand
表8.447 グローバルクエリーパラメーター
パラメータータイプ説明

pretty

string

'true' の場合、出力はきれいに印刷されます。

HTTP メソッド
GET
Description
指定された OAuth のステータスを読み取る
Expand
表8.448 クエリーパラメーター
パラメータータイプ説明

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

Expand
表8.449 HTTP 応答
HTTP コードレスポンス本文

200 - OK

OAuth スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
Description
指定された OAuth のステータスを部分的に更新します
Expand
表8.450 クエリーパラメーター
パラメータータイプ説明

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

Expand
表8.451 ボディパラメーター
パラメータータイプ説明

body

Patch schema

 
Expand
表8.452 HTTP 応答
HTTP コードレスポンス本文

200 - OK

OAuth スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
Description
指定された OAuth のステータスを置き換えます
Expand
表8.453 クエリーパラメーター
パラメータータイプ説明

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

Expand
表8.454 ボディパラメーター
パラメータータイプ説明

ボディー

OAuth スキーマ

 
Expand
表8.455 HTTP 応答
HTTP コードレスポンス本文

200 - OK

OAuth スキーマ

201 - Created

OAuth スキーマ

401 - Unauthorized

空白

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat