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


描述
OAuth 包含有关 OAuth 的集群范围信息。规范名称为 cluster。它用于配置集成的 OAuth 服务器。只有在顶级身份验证配置将类型设置为 IntegratedOAuth 时,才会实现此配置。兼容性级别 1:在主发行版本中至少提供 12 个月或 3 个次版本(以更长的时间为准)。
类型
对象
必填
  • spec

8.16.1. 规格

Expand
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

字符串

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

对象

spec 包含用户配置可设置值

status

对象

status 包含从集群中观察到的值。它们可能无法覆盖。

8.16.1.1. .spec

描述
spec 包含用户配置可设置值
类型
对象
Expand
属性类型描述

identityProviders

array

identityProviders 是用户标识自身的方法列表。当此列表为空时,不会为用户置备任何身份。

identityProviders[]

对象

IdentityProvider 为使用凭证进行身份验证的用户提供身份

templates

对象

模板允许您自定义登录页面等页面。

tokenConfig

对象

tokenConfig 包含授权和访问令牌的选项

8.16.1.2. .spec.identityProviders

描述
identityProviders 是用户标识自身的方法列表。当此列表为空时,不会为用户置备任何身份。
类型
array

8.16.1.3. .spec.identityProviders[]

描述
IdentityProvider 为使用凭证进行身份验证的用户提供身份
类型
对象
Expand
属性类型描述

basicAuth

对象

BasicAuth IdP 的配置选项

github

对象

GitHub 使用 GitHub 凭证启用用户身份验证

gitlab

对象

GitLab 使用 GitLab 凭证启用用户身份验证

google

对象

Google 使用 Google 凭证启用用户身份验证

htpasswd

对象

htpasswd 允许使用 HTPasswd 文件验证凭证进行用户身份验证

Keystone

对象

Keystone 使用 keystone 密码凭证启用用户身份验证

ldap

对象

LDAP 使用 LDAP 凭证启用用户身份验证

mappingMethod

字符串

mappingMethod 决定此提供程序的身份如何映射到用户默认值 "claim"

name

字符串

名称用于证明此提供程序返回的身份。- 它必须是唯一的,不由所使用的任何其他身份提供程序共享 - 它必须是有效的路径片段:名称不能等于 "." 或 "..",或包含 "/" 或 "%" 或 ":" Ref: https://godoc.org/github.com/openshift/origin/pkg/user/apis/user/validation#ValidateIdentityProviderName

openID

对象

OpenID 使用 OpenID 凭证启用用户身份验证

requestHeader

对象

RequestHeader 使用请求标头凭证启用用户身份验证

type

字符串

type 标识此条目的身份提供程序类型。

8.16.1.4. .spec.identityProviders[].basicAuth

描述
BasicAuth IdP 的配置选项
类型
对象
Expand
属性类型描述

ca

对象

CA 是基于包含 PEM 编码的 CA 捆绑包的名称对配置映射的可选引用。它被用作信任锚,以验证远程服务器提供的 TLS 证书。密钥 "ca.crt" 用于定位数据。如果没有指定且未找到配置映射或预期键,则不会遵守身份提供程序。如果指定的 ca 数据无效,则不会遵守身份提供程序。若为空,则使用默认的系统根证书。此配置映射的命名空间是 openshift-config。

tlsClientCert

对象

tlsClientCert 是一个根据名称对 secret 的可选引用,其中包含连接到服务器时要存在的 PEM 编码 TLS 客户端证书。密钥 "tls.crt" 用于定位数据。如果没有指定且未找到 secret 或预期的密钥,则不会遵守身份提供程序。如果指定的证书数据无效,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。

tlsClientKey

对象

tlsClientKey 是一个根据名称对 secret 的可选引用,其中包含 tlsClientCert 中引用的客户端证书的 PEM 编码 TLS 私钥。密钥 "tls.key" 用于定位数据。如果没有指定且未找到 secret 或预期的密钥,则不会遵守身份提供程序。如果指定的证书数据无效,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。

url

字符串

URL 是要连接到的远程 URL

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

描述
CA 是基于包含 PEM 编码的 CA 捆绑包的名称对配置映射的可选引用。它被用作信任锚,以验证远程服务器提供的 TLS 证书。密钥 "ca.crt" 用于定位数据。如果没有指定且未找到配置映射或预期键,则不会遵守身份提供程序。如果指定的 ca 数据无效,则不会遵守身份提供程序。若为空,则使用默认的系统根证书。此配置映射的命名空间是 openshift-config。
类型
对象
必填
  • name
Expand
属性类型描述

name

字符串

name 是引用的配置映射的 metadata.name

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

描述
tlsClientCert 是一个根据名称对 secret 的可选引用,其中包含连接到服务器时要存在的 PEM 编码 TLS 客户端证书。密钥 "tls.crt" 用于定位数据。如果没有指定且未找到 secret 或预期的密钥,则不会遵守身份提供程序。如果指定的证书数据无效,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。
类型
对象
必填
  • name
Expand
属性类型描述

name

字符串

name 是引用的 secret 的 metadata.name

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

描述
tlsClientKey 是一个根据名称对 secret 的可选引用,其中包含 tlsClientCert 中引用的客户端证书的 PEM 编码 TLS 私钥。密钥 "tls.key" 用于定位数据。如果没有指定且未找到 secret 或预期的密钥,则不会遵守身份提供程序。如果指定的证书数据无效,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。
类型
对象
必填
  • name
Expand
属性类型描述

name

字符串

name 是引用的 secret 的 metadata.name

8.16.1.8. .spec.identityProviders[].github

描述
GitHub 使用 GitHub 凭证启用用户身份验证
类型
对象
Expand
属性类型描述

ca

对象

CA 是基于包含 PEM 编码的 CA 捆绑包的名称对配置映射的可选引用。它被用作信任锚,以验证远程服务器提供的 TLS 证书。密钥 "ca.crt" 用于定位数据。如果没有指定且未找到配置映射或预期键,则不会遵守身份提供程序。如果指定的 ca 数据无效,则不会遵守身份提供程序。若为空,则使用默认的系统根证书。这只能在主机名设置为非空值时进行配置。此配置映射的命名空间是 openshift-config。

clientID

字符串

clientId 是 oauth 客户端 ID

clientSecret

对象

clientSecret 是包含 oauth 客户端 secret 的名称对 secret 的必要引用。密钥 "clientSecret" 用于定位数据。如果没有找到 secret 或预期的密钥,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。

主机名

字符串

hostname 是可选域(如 "mycompany.com"),用于托管 GitHub Enterprise 实例。它必须与在 /setup/settings thehostname 中配置的 GitHub Enterprise 设置值匹配。

机构

数组(字符串)

机构有选择限制允许哪些机构登录

团队

数组(字符串)

团队(team)限制允许哪些团队登录。格式为 <org>/<team>。

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

描述
CA 是基于包含 PEM 编码的 CA 捆绑包的名称对配置映射的可选引用。它被用作信任锚,以验证远程服务器提供的 TLS 证书。密钥 "ca.crt" 用于定位数据。如果没有指定且未找到配置映射或预期键,则不会遵守身份提供程序。如果指定的 ca 数据无效,则不会遵守身份提供程序。若为空,则使用默认的系统根证书。这只能在主机名设置为非空值时进行配置。此配置映射的命名空间是 openshift-config。
类型
对象
必填
  • name
Expand
属性类型描述

name

字符串

name 是引用的配置映射的 metadata.name

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

描述
clientSecret 是包含 oauth 客户端 secret 的名称对 secret 的必要引用。密钥 "clientSecret" 用于定位数据。如果没有找到 secret 或预期的密钥,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。
类型
对象
必填
  • name
Expand
属性类型描述

name

字符串

name 是引用的 secret 的 metadata.name

8.16.1.11. .spec.identityProviders[].gitlab

描述
GitLab 使用 GitLab 凭证启用用户身份验证
类型
对象
Expand
属性类型描述

ca

对象

CA 是基于包含 PEM 编码的 CA 捆绑包的名称对配置映射的可选引用。它被用作信任锚,以验证远程服务器提供的 TLS 证书。密钥 "ca.crt" 用于定位数据。如果没有指定且未找到配置映射或预期键,则不会遵守身份提供程序。如果指定的 ca 数据无效,则不会遵守身份提供程序。若为空,则使用默认的系统根证书。此配置映射的命名空间是 openshift-config。

clientID

字符串

clientId 是 oauth 客户端 ID

clientSecret

对象

clientSecret 是包含 oauth 客户端 secret 的名称对 secret 的必要引用。密钥 "clientSecret" 用于定位数据。如果没有找到 secret 或预期的密钥,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。

url

字符串

URL 是 oauth 服务器基本 URL

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

描述
CA 是基于包含 PEM 编码的 CA 捆绑包的名称对配置映射的可选引用。它被用作信任锚,以验证远程服务器提供的 TLS 证书。密钥 "ca.crt" 用于定位数据。如果没有指定且未找到配置映射或预期键,则不会遵守身份提供程序。如果指定的 ca 数据无效,则不会遵守身份提供程序。若为空,则使用默认的系统根证书。此配置映射的命名空间是 openshift-config。
类型
对象
必填
  • name
Expand
属性类型描述

name

字符串

name 是引用的配置映射的 metadata.name

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

描述
clientSecret 是包含 oauth 客户端 secret 的名称对 secret 的必要引用。密钥 "clientSecret" 用于定位数据。如果没有找到 secret 或预期的密钥,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。
类型
对象
必填
  • name
Expand
属性类型描述

name

字符串

name 是引用的 secret 的 metadata.name

8.16.1.14. .spec.identityProviders[].google

描述
Google 使用 Google 凭证启用用户身份验证
类型
对象
Expand
属性类型描述

clientID

字符串

clientId 是 oauth 客户端 ID

clientSecret

对象

clientSecret 是包含 oauth 客户端 secret 的名称对 secret 的必要引用。密钥 "clientSecret" 用于定位数据。如果没有找到 secret 或预期的密钥,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。

hostedDomain

字符串

hostedDomain 是可选的 Google App 域(如 "mycompany.com")来限制登录

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

描述
clientSecret 是包含 oauth 客户端 secret 的名称对 secret 的必要引用。密钥 "clientSecret" 用于定位数据。如果没有找到 secret 或预期的密钥,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。
类型
对象
必填
  • name
Expand
属性类型描述

name

字符串

name 是引用的 secret 的 metadata.name

8.16.1.16. .spec.identityProviders[].htpasswd

描述
htpasswd 允许使用 HTPasswd 文件验证凭证进行用户身份验证
类型
对象
Expand
属性类型描述

fileData

对象

fileData 是 secret 的必需引用,按名称包含要用作 htpasswd 文件的数据。密钥 "htpasswd" 用于定位数据。如果没有找到 secret 或预期的密钥,则不会遵守身份提供程序。如果指定的 htpasswd 数据无效,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。

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

描述
fileData 是 secret 的必需引用,按名称包含要用作 htpasswd 文件的数据。密钥 "htpasswd" 用于定位数据。如果没有找到 secret 或预期的密钥,则不会遵守身份提供程序。如果指定的 htpasswd 数据无效,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。
类型
对象
必填
  • name
Expand
属性类型描述

name

字符串

name 是引用的 secret 的 metadata.name

8.16.1.18. .spec.identityProviders[].keystone

描述
Keystone 使用 keystone 密码凭证启用用户身份验证
类型
对象
Expand
属性类型描述

ca

对象

CA 是基于包含 PEM 编码的 CA 捆绑包的名称对配置映射的可选引用。它被用作信任锚,以验证远程服务器提供的 TLS 证书。密钥 "ca.crt" 用于定位数据。如果没有指定且未找到配置映射或预期键,则不会遵守身份提供程序。如果指定的 ca 数据无效,则不会遵守身份提供程序。若为空,则使用默认的系统根证书。此配置映射的命名空间是 openshift-config。

domainName

字符串

keystone v3 需要 domainName

tlsClientCert

对象

tlsClientCert 是一个根据名称对 secret 的可选引用,其中包含连接到服务器时要存在的 PEM 编码 TLS 客户端证书。密钥 "tls.crt" 用于定位数据。如果没有指定且未找到 secret 或预期的密钥,则不会遵守身份提供程序。如果指定的证书数据无效,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。

tlsClientKey

对象

tlsClientKey 是一个根据名称对 secret 的可选引用,其中包含 tlsClientCert 中引用的客户端证书的 PEM 编码 TLS 私钥。密钥 "tls.key" 用于定位数据。如果没有指定且未找到 secret 或预期的密钥,则不会遵守身份提供程序。如果指定的证书数据无效,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。

url

字符串

URL 是要连接到的远程 URL

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

描述
CA 是基于包含 PEM 编码的 CA 捆绑包的名称对配置映射的可选引用。它被用作信任锚,以验证远程服务器提供的 TLS 证书。密钥 "ca.crt" 用于定位数据。如果没有指定且未找到配置映射或预期键,则不会遵守身份提供程序。如果指定的 ca 数据无效,则不会遵守身份提供程序。若为空,则使用默认的系统根证书。此配置映射的命名空间是 openshift-config。
类型
对象
必填
  • name
Expand
属性类型描述

name

字符串

name 是引用的配置映射的 metadata.name

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

描述
tlsClientCert 是一个根据名称对 secret 的可选引用,其中包含连接到服务器时要存在的 PEM 编码 TLS 客户端证书。密钥 "tls.crt" 用于定位数据。如果没有指定且未找到 secret 或预期的密钥,则不会遵守身份提供程序。如果指定的证书数据无效,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。
类型
对象
必填
  • name
Expand
属性类型描述

name

字符串

name 是引用的 secret 的 metadata.name

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

描述
tlsClientKey 是一个根据名称对 secret 的可选引用,其中包含 tlsClientCert 中引用的客户端证书的 PEM 编码 TLS 私钥。密钥 "tls.key" 用于定位数据。如果没有指定且未找到 secret 或预期的密钥,则不会遵守身份提供程序。如果指定的证书数据无效,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。
类型
对象
必填
  • name
Expand
属性类型描述

name

字符串

name 是引用的 secret 的 metadata.name

8.16.1.22. .spec.identityProviders[].ldap

描述
LDAP 使用 LDAP 凭证启用用户身份验证
类型
对象
Expand
属性类型描述

属性

对象

属性将 LDAP 属性映射到身份

bindDN

字符串

bindDN 是要在搜索阶段绑定的可选 DN。

bindPassword

对象

bindPassword 是一个可选的对 secret 的引用,按名称包含要在搜索阶段绑定的密码。密钥 "bindPassword" 用于定位数据。如果没有指定且未找到 secret 或预期的密钥,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。

ca

对象

CA 是基于包含 PEM 编码的 CA 捆绑包的名称对配置映射的可选引用。它被用作信任锚,以验证远程服务器提供的 TLS 证书。密钥 "ca.crt" 用于定位数据。如果没有指定且未找到配置映射或预期键,则不会遵守身份提供程序。如果指定的 ca 数据无效,则不会遵守身份提供程序。若为空,则使用默认的系统根证书。此配置映射的命名空间是 openshift-config。

insecure

布尔值

insecure (如果为 true )表示连接不应使用 TLS 警告:如果 URL 方案 "ldaps://",因为 "ldaps://" URL 始终尝试使用 TLS 进行连接,即使 不安全 设置为 true ,"ldap://"URLS 也连接不安全。为 false 时,使用 https://tools.ietf.org/html/rfc2830 中指定的 StartTLS 将 "ldap://" URL 升级到 TLS 连接。

url

字符串

URL 是一个 RFC 2255 URL,指定要使用的 LDAP 搜索参数。URL 的语法为: ldap://host:port/basedn?attribute?scope?filter

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

描述
属性将 LDAP 属性映射到身份
类型
对象
Expand
属性类型描述

email

数组(字符串)

email 是值应用作电子邮件地址的属性列表。可选。如果未指定,则不会为身份设置电子邮件

id

数组(字符串)

ID 是值应用作用户 ID 的属性列表。必需。使用第一个非空属性。至少需要一个属性。如果列出的属性都没有值,身份验证会失败。LDAP 标准身份属性为 "dn"

name

数组(字符串)

name 是值应用作显示名称的属性列表。可选。如果未指定,则不会为身份 LDAP 标准显示名称设置"cn"的显示名称

preferredUsername

数组(字符串)

preferredUsername 是值应用作首选用户名的属性列表。LDAP 标准登录属性为 "uid"

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

描述
bindPassword 是一个可选的对 secret 的引用,按名称包含要在搜索阶段绑定的密码。密钥 "bindPassword" 用于定位数据。如果没有指定且未找到 secret 或预期的密钥,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。
类型
对象
必填
  • name
Expand
属性类型描述

name

字符串

name 是引用的 secret 的 metadata.name

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

描述
CA 是基于包含 PEM 编码的 CA 捆绑包的名称对配置映射的可选引用。它被用作信任锚,以验证远程服务器提供的 TLS 证书。密钥 "ca.crt" 用于定位数据。如果没有指定且未找到配置映射或预期键,则不会遵守身份提供程序。如果指定的 ca 数据无效,则不会遵守身份提供程序。若为空,则使用默认的系统根证书。此配置映射的命名空间是 openshift-config。
类型
对象
必填
  • name
Expand
属性类型描述

name

字符串

name 是引用的配置映射的 metadata.name

8.16.1.26. .spec.identityProviders[].openID

描述
OpenID 使用 OpenID 凭证启用用户身份验证
类型
对象
Expand
属性类型描述

ca

对象

CA 是基于包含 PEM 编码的 CA 捆绑包的名称对配置映射的可选引用。它被用作信任锚,以验证远程服务器提供的 TLS 证书。密钥 "ca.crt" 用于定位数据。如果没有指定且未找到配置映射或预期键,则不会遵守身份提供程序。如果指定的 ca 数据无效,则不会遵守身份提供程序。若为空,则使用默认的系统根证书。此配置映射的命名空间是 openshift-config。

声明

对象

声明映射

clientID

字符串

clientId 是 oauth 客户端 ID

clientSecret

对象

clientSecret 是包含 oauth 客户端 secret 的名称对 secret 的必要引用。密钥 "clientSecret" 用于定位数据。如果没有找到 secret 或预期的密钥,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。

extraAuthorizeParameters

对象(字符串)

extraAuthorizeParameters 是添加到授权请求的任何自定义参数。

extraScopes

数组(字符串)

extraScopes 也是除了标准"openid"范围外请求的任何范围。

issuer

字符串

issuer 是 OpenID 提供程序断言为其 Issuer 标识符的 URL。它必须使用 https,没有查询或分段组件。

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

描述
CA 是基于包含 PEM 编码的 CA 捆绑包的名称对配置映射的可选引用。它被用作信任锚,以验证远程服务器提供的 TLS 证书。密钥 "ca.crt" 用于定位数据。如果没有指定且未找到配置映射或预期键,则不会遵守身份提供程序。如果指定的 ca 数据无效,则不会遵守身份提供程序。若为空,则使用默认的系统根证书。此配置映射的命名空间是 openshift-config。
类型
对象
必填
  • name
Expand
属性类型描述

name

字符串

name 是引用的配置映射的 metadata.name

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

描述
声明映射
类型
对象
Expand
属性类型描述

email

数组(字符串)

email 是其值应用作电子邮件地址的声明列表。可选。如果未指定,则不会为身份设置电子邮件

groups

数组(字符串)

groups 是声明值列表,应该用于为用户将 OIDC 供应商中的组同步到 OpenShift。如果指定了多个声明,则使用第一个带有非空值的声明。

name

数组(字符串)

name 是值应用作显示名称的声明列表。可选。如果未指定,则不会为身份设置显示名称

preferredUsername

数组(字符串)

preferredUsername 是值应用作首选用户名的声明列表。如果未指定,首选用户名由子声明的值决定

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

描述
clientSecret 是包含 oauth 客户端 secret 的名称对 secret 的必要引用。密钥 "clientSecret" 用于定位数据。如果没有找到 secret 或预期的密钥,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。
类型
对象
必填
  • name
Expand
属性类型描述

name

字符串

name 是引用的 secret 的 metadata.name

8.16.1.30. .spec.identityProviders[].requestHeader

描述
RequestHeader 使用请求标头凭证启用用户身份验证
类型
对象
Expand
属性类型描述

ca

对象

CA 是包含 PEM 编码 CA 捆绑包的名称对配置映射的必需引用。它被用作信任锚,以验证远程服务器提供的 TLS 证书。具体来说,它允许验证传入请求以防止标头欺骗。密钥 "ca.crt" 用于定位数据。如果没有找到配置映射或预期密钥,则不会遵守身份提供程序。如果指定的 ca 数据无效,则不会遵守身份提供程序。此配置映射的命名空间是 openshift-config。

challengeURL

字符串

challengeURL 是一个 URL,用于将未经身份验证的 /authorize 请求重定向到来自 OAuth 客户端的未验证请求,该请求希望此处的 WWW-Authenticate 质询被重新定向到当前的 URL。${url} 替换为在查询参数 https://www.example.com/sso-login?then=${url} ${query} 中安全使用当前的查询字符串 https://www.example.com/auth-proxy/oauth/authorize?${query} 替换。

clientCommonNames

数组(字符串)

clientCommonNames 是需要与之匹配的常用名称的可选列表。如果为空,则针对 clientCA 捆绑包验证的任何客户端证书都被视为权威。

emailHeaders

数组(字符串)

emailHeaders 是检查电子邮件地址的标头集合

标头

数组(字符串)

标头是用来检查身份信息的标头集合

loginURL

字符串

loginURL 是一个 URL,用于将未经身份验证的 /authorize 请求重定向到来自 OAuth 客户端的未验证请求,这个请求希望在此处重定向交互式登录,用当前的 URL 替换转义以在查询参数 https://www.example.com/sso-login?then=${url} ${query} 中被替换为当前查询字符串 https://www.example.com/auth-proxy/oauth/authorize?${query}

nameHeaders

数组(字符串)

nameHeaders 是检查显示名称的标头集合

preferredUsernameHeaders

数组(字符串)

preferredUsernameHeaders 是一组用于检查首选用户名的标头

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

描述
CA 是包含 PEM 编码 CA 捆绑包的名称对配置映射的必需引用。它被用作信任锚,以验证远程服务器提供的 TLS 证书。具体来说,它允许验证传入请求以防止标头欺骗。密钥 "ca.crt" 用于定位数据。如果没有找到配置映射或预期密钥,则不会遵守身份提供程序。如果指定的 ca 数据无效,则不会遵守身份提供程序。此配置映射的命名空间是 openshift-config。
类型
对象
必填
  • name
Expand
属性类型描述

name

字符串

name 是引用的配置映射的 metadata.name

8.16.1.32. .spec.templates

描述
模板允许您自定义登录页面等页面。
类型
对象
Expand
属性类型描述

错误

对象

error 是 secret 的名称,用于指定要在身份验证或授权流期间呈现错误页面的 go 模板。密钥 "errors.html" 用于查找模板数据。如果没有指定且未找到 secret 或预期的键,则使用默认错误页面。如果指定模板无效,则使用默认错误页面。如果未指定,则使用默认错误页面。此 secret 的命名空间是 openshift-config。

login

对象

login 是用于指定用于呈现登录页面的 go 模板的 secret 名称。密钥 "login.html" 用于查找模板数据。如果不指定且未找到 secret 或预期密钥,则使用默认的登录页面。如果指定模板无效,则使用默认登录页面。如果未指定,则使用默认登录页面。此 secret 的命名空间是 openshift-config。

providerSelection

对象

providerSelection 是用于指定用于呈现供应商选择页面的 go 模板的 secret 名称。密钥 "providers.html" 用于查找模板数据。如果没有指定且未找到 secret 或预期的键,则使用默认供应商选择页面。如果指定模板无效,则使用默认供应商选择页面。如果未指定,则使用默认供应商选择页面。此 secret 的命名空间是 openshift-config。

8.16.1.33. .spec.templates.error

描述
error 是 secret 的名称,用于指定要在身份验证或授权流期间呈现错误页面的 go 模板。密钥 "errors.html" 用于查找模板数据。如果没有指定且未找到 secret 或预期的键,则使用默认错误页面。如果指定模板无效,则使用默认错误页面。如果未指定,则使用默认错误页面。此 secret 的命名空间是 openshift-config。
类型
对象
必填
  • name
Expand
属性类型描述

name

字符串

name 是引用的 secret 的 metadata.name

8.16.1.34. .spec.templates.login

描述
login 是用于指定用于呈现登录页面的 go 模板的 secret 名称。密钥 "login.html" 用于查找模板数据。如果不指定且未找到 secret 或预期密钥,则使用默认的登录页面。如果指定模板无效,则使用默认登录页面。如果未指定,则使用默认登录页面。此 secret 的命名空间是 openshift-config。
类型
对象
必填
  • name
Expand
属性类型描述

name

字符串

name 是引用的 secret 的 metadata.name

8.16.1.35. .spec.templates.providerSelection

描述
providerSelection 是用于指定用于呈现供应商选择页面的 go 模板的 secret 名称。密钥 "providers.html" 用于查找模板数据。如果没有指定且未找到 secret 或预期的键,则使用默认供应商选择页面。如果指定模板无效,则使用默认供应商选择页面。如果未指定,则使用默认供应商选择页面。此 secret 的命名空间是 openshift-config。
类型
对象
必填
  • name
Expand
属性类型描述

name

字符串

name 是引用的 secret 的 metadata.name

8.16.1.36. .spec.tokenConfig

描述
tokenConfig 包含授权和访问令牌的选项
类型
对象
Expand
属性类型描述

accessTokenInactivityTimeout

字符串

accessTokenInactivityTimeout 为任何客户端授予的令牌定义令牌不活跃超时。该值表示连续使用令牌之间可发生的最长时间。如果没有在此时间窗口中使用令牌,则令牌无效。当令牌超时后,用户需要获取新的令牌来重新获得访问。使用有效的持续时间字符串,如 "5m", "1.5h" 或 "2h45m"。持续时间允许的最小值为 300s (5 分钟)。如果每个客户端配置了超时,则该值将具有优先权。如果没有指定超时值,且客户端不会覆盖该值,则令牌有效,直到其生命周期为止。警告:通过更改此值,现有令牌的超时不会受到影响(降低)

accessTokenInactivityTimeoutSeconds

整数

accessTokenInactivityTimeoutSeconds - DEPRECATED: 设置此字段无效。

accessTokenMaxAgeSeconds

整数

accessTokenMaxAgeSeconds 定义访问令牌的最长年龄

8.16.1.37. .status

描述
status 包含从集群中观察到的值。它们可能无法覆盖。
类型
对象

8.16.2. API 端点

可用的 API 端点如下:

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

    • DELETE :删除 OAuth 的集合
    • GET :列出 OAuth 类型的对象
    • POST :创建 OAuth
  • /apis/config.openshift.io/v1/oauths/{name}

    • DELETE :删除 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

字符串

如果 'true',则输出被用户友善。

HTTP 方法
DELETE
描述
删除 OAuth 的集合
Expand
表 8.426. 查询参数
参数类型描述

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。

继续

字符串

从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。

当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。

fieldSelector

字符串

用于限制返回的对象列表的选择器。默认为任何内容。

labelSelector

字符串

通过标签限制返回的对象列表的选择器。默认为任何内容。

limit

整数

限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 continue 字段为空,客户端可能会假设没有更多可用的结果。如果 watch 为 true,则不支持此字段。

服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象,则返回第一次列表结果时存在的对象版本。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。

watch

布尔值

观察对描述的资源的更改,并将其作为添加、更新和删除通知流返回。指定 resourceVersion。

Expand
表 8.427. HTTP 响应
HTTP 代码响应正文

200 - OK

Status_v2 模式

401 - Unauthorized

HTTP 方法
GET
描述
列出 OAuth 类型的对象
Expand
表 8.428. 查询参数
参数类型描述

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。

继续

字符串

从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。

当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。

fieldSelector

字符串

用于限制返回的对象列表的选择器。默认为任何内容。

labelSelector

字符串

通过标签限制返回的对象列表的选择器。默认为任何内容。

limit

整数

限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 continue 字段为空,客户端可能会假设没有更多可用的结果。如果 watch 为 true,则不支持此字段。

服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象,则返回第一次列表结果时存在的对象版本。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。

watch

布尔值

观察对描述的资源的更改,并将其作为添加、更新和删除通知流返回。指定 resourceVersion。

Expand
表 8.429. HTTP 响应
HTTP 代码响应正文

200 - OK

OAuthList 模式

401 - Unauthorized

HTTP 方法
POST
描述
创建 OAuth
Expand
表 8.430. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 8.431. 主体参数
参数类型描述

正文(body)

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

字符串

OAuth 的名称

Expand
表 8.434. 全局查询参数
参数类型描述

pretty

字符串

如果 'true',则输出被用户友善。

HTTP 方法
DELETE
描述
删除 OAuth
Expand
表 8.435. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

gracePeriodSeconds

整数

应该删除对象前的持续时间(以秒为单位)。值必须是非负整数。值零表示立即删除。如果这个值是 nil,则使用指定类型的默认宽限期。如果没有指定,则默认为每个对象值。零表示立即删除。

orphanDependents

布尔值

弃用:请使用 PropagationPolicy,此字段将在 1.7 中被弃用。应该依赖的对象被孤立。如果为 true/false,"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy,但不能同时设置两者。

propagationPolicy

字符串

是否以及是否执行垃圾回收。此字段或 OrphanDependents 可以设置,但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值为: 'Orphan' - 孤立依赖; 'Background' - 允许垃圾收集器在后台删除依赖的依赖关系; 'Foreground' - 一个删除前台所有依赖的级联策略。

Expand
表 8.436. 主体参数
参数类型描述

正文(body)

DeleteOptions_v2 schema

 
Expand
表 8.437. HTTP 响应
HTTP 代码响应正文

200 - OK

Status_v2 模式

202 - Accepted

Status_v2 模式

401 - Unauthorized

HTTP 方法
GET
描述
读取指定的 OAuth
Expand
表 8.438. 查询参数
参数类型描述

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

Expand
表 8.439. HTTP 响应
HTTP 代码响应正文

200 - OK

OAuth 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
部分更新指定的 OAuth
Expand
表 8.440. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 8.441. 主体参数
参数类型描述

正文(body)

Patch 模式

 
Expand
表 8.442. HTTP 响应
HTTP 代码响应正文

200 - OK

OAuth 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定的 OAuth
Expand
表 8.443. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 8.444. 主体参数
参数类型描述

正文(body)

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

字符串

OAuth 的名称

Expand
表 8.447. 全局查询参数
参数类型描述

pretty

字符串

如果 'true',则输出被用户友善。

HTTP 方法
GET
描述
指定 OAuth 的读取状态
Expand
表 8.448. 查询参数
参数类型描述

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

Expand
表 8.449. HTTP 响应
HTTP 代码响应正文

200 - OK

OAuth 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
指定 OAuth 的部分更新状态
Expand
表 8.450. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 8.451. 主体参数
参数类型描述

正文(body)

Patch 模式

 
Expand
表 8.452. HTTP 响应
HTTP 代码响应正文

200 - OK

OAuth 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定 OAuth 的状态
Expand
表 8.453. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 8.454. 主体参数
参数类型描述

正文(body)

OAuth 模式

 
Expand
表 8.455. HTTP 响应
HTTP 代码响应正文

200 - OK

OAuth 模式

201 - Created

OAuth 模式

401 - Unauthorized

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2025 Red Hat