8.16. OAuth [config.openshift.io/v1]
- 描述
-
OAuth 包含有关 OAuth 的集群范围信息。规范名称为
cluster
。它用于配置集成的 OAuth 服务器。只有在顶级身份验证配置将类型设置为 IntegratedOAuth 时,才会实现此配置。兼容性级别 1:在主发行版本中至少提供 12 个月或 3 个次版本(以更长的时间为准)。 - 类型
-
对象
- 必填
-
spec
-
8.16.1. 规格 复制链接链接已复制到粘贴板!
属性 | 类型 | 描述 |
---|---|---|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| 标准对象元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| spec 包含用户配置可设置值 |
|
| status 包含从集群中观察到的值。它们可能无法覆盖。 |
8.16.1.1. .spec 复制链接链接已复制到粘贴板!
- 描述
- spec 包含用户配置可设置值
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| identityProviders 是用户标识自身的方法列表。当此列表为空时,不会为用户置备任何身份。 |
|
| IdentityProvider 为使用凭证进行身份验证的用户提供身份 |
|
| 模板允许您自定义登录页面等页面。 |
|
| tokenConfig 包含授权和访问令牌的选项 |
8.16.1.2. .spec.identityProviders 复制链接链接已复制到粘贴板!
- 描述
- identityProviders 是用户标识自身的方法列表。当此列表为空时,不会为用户置备任何身份。
- 类型
-
array
8.16.1.3. .spec.identityProviders[] 复制链接链接已复制到粘贴板!
- 描述
- IdentityProvider 为使用凭证进行身份验证的用户提供身份
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| BasicAuth IdP 的配置选项 |
|
| GitHub 使用 GitHub 凭证启用用户身份验证 |
|
| GitLab 使用 GitLab 凭证启用用户身份验证 |
|
| Google 使用 Google 凭证启用用户身份验证 |
|
| htpasswd 允许使用 HTPasswd 文件验证凭证进行用户身份验证 |
|
| Keystone 使用 keystone 密码凭证启用用户身份验证 |
|
| LDAP 使用 LDAP 凭证启用用户身份验证 |
|
| mappingMethod 决定此提供程序的身份如何映射到用户默认值 "claim" |
|
| 名称用于证明此提供程序返回的身份。- 它必须是唯一的,不由所使用的任何其他身份提供程序共享 - 它必须是有效的路径片段:名称不能等于 "." 或 "..",或包含 "/" 或 "%" 或 ":" Ref: https://godoc.org/github.com/openshift/origin/pkg/user/apis/user/validation#ValidateIdentityProviderName |
|
| OpenID 使用 OpenID 凭证启用用户身份验证 |
|
| RequestHeader 使用请求标头凭证启用用户身份验证 |
|
| type 标识此条目的身份提供程序类型。 |
8.16.1.4. .spec.identityProviders[].basicAuth 复制链接链接已复制到粘贴板!
- 描述
- BasicAuth IdP 的配置选项
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| CA 是基于包含 PEM 编码的 CA 捆绑包的名称对配置映射的可选引用。它被用作信任锚,以验证远程服务器提供的 TLS 证书。密钥 "ca.crt" 用于定位数据。如果没有指定且未找到配置映射或预期键,则不会遵守身份提供程序。如果指定的 ca 数据无效,则不会遵守身份提供程序。若为空,则使用默认的系统根证书。此配置映射的命名空间是 openshift-config。 |
|
| tlsClientCert 是一个根据名称对 secret 的可选引用,其中包含连接到服务器时要存在的 PEM 编码 TLS 客户端证书。密钥 "tls.crt" 用于定位数据。如果没有指定且未找到 secret 或预期的密钥,则不会遵守身份提供程序。如果指定的证书数据无效,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。 |
|
| tlsClientKey 是一个根据名称对 secret 的可选引用,其中包含 tlsClientCert 中引用的客户端证书的 PEM 编码 TLS 私钥。密钥 "tls.key" 用于定位数据。如果没有指定且未找到 secret 或预期的密钥,则不会遵守身份提供程序。如果指定的证书数据无效,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。 |
|
| URL 是要连接到的远程 URL |
8.16.1.5. .spec.identityProviders[].basicAuth.ca 复制链接链接已复制到粘贴板!
- 描述
- CA 是基于包含 PEM 编码的 CA 捆绑包的名称对配置映射的可选引用。它被用作信任锚,以验证远程服务器提供的 TLS 证书。密钥 "ca.crt" 用于定位数据。如果没有指定且未找到配置映射或预期键,则不会遵守身份提供程序。如果指定的 ca 数据无效,则不会遵守身份提供程序。若为空,则使用默认的系统根证书。此配置映射的命名空间是 openshift-config。
- 类型
-
对象
- 必填
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是引用的配置映射的 metadata.name |
- 描述
- tlsClientCert 是一个根据名称对 secret 的可选引用,其中包含连接到服务器时要存在的 PEM 编码 TLS 客户端证书。密钥 "tls.crt" 用于定位数据。如果没有指定且未找到 secret 或预期的密钥,则不会遵守身份提供程序。如果指定的证书数据无效,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。
- 类型
-
对象
- 必填
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是引用的 secret 的 metadata.name |
- 描述
- tlsClientKey 是一个根据名称对 secret 的可选引用,其中包含 tlsClientCert 中引用的客户端证书的 PEM 编码 TLS 私钥。密钥 "tls.key" 用于定位数据。如果没有指定且未找到 secret 或预期的密钥,则不会遵守身份提供程序。如果指定的证书数据无效,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。
- 类型
-
对象
- 必填
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是引用的 secret 的 metadata.name |
8.16.1.8. .spec.identityProviders[].github 复制链接链接已复制到粘贴板!
- 描述
- GitHub 使用 GitHub 凭证启用用户身份验证
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| CA 是基于包含 PEM 编码的 CA 捆绑包的名称对配置映射的可选引用。它被用作信任锚,以验证远程服务器提供的 TLS 证书。密钥 "ca.crt" 用于定位数据。如果没有指定且未找到配置映射或预期键,则不会遵守身份提供程序。如果指定的 ca 数据无效,则不会遵守身份提供程序。若为空,则使用默认的系统根证书。这只能在主机名设置为非空值时进行配置。此配置映射的命名空间是 openshift-config。 |
|
| clientId 是 oauth 客户端 ID |
|
| 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
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是引用的配置映射的 metadata.name |
8.16.1.10. .spec.identityProviders[].github.clientSecret 复制链接链接已复制到粘贴板!
- 描述
- clientSecret 是包含 oauth 客户端 secret 的名称对 secret 的必要引用。密钥 "clientSecret" 用于定位数据。如果没有找到 secret 或预期的密钥,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。
- 类型
-
对象
- 必填
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是引用的 secret 的 metadata.name |
8.16.1.11. .spec.identityProviders[].gitlab 复制链接链接已复制到粘贴板!
- 描述
- GitLab 使用 GitLab 凭证启用用户身份验证
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| CA 是基于包含 PEM 编码的 CA 捆绑包的名称对配置映射的可选引用。它被用作信任锚,以验证远程服务器提供的 TLS 证书。密钥 "ca.crt" 用于定位数据。如果没有指定且未找到配置映射或预期键,则不会遵守身份提供程序。如果指定的 ca 数据无效,则不会遵守身份提供程序。若为空,则使用默认的系统根证书。此配置映射的命名空间是 openshift-config。 |
|
| clientId 是 oauth 客户端 ID |
|
| clientSecret 是包含 oauth 客户端 secret 的名称对 secret 的必要引用。密钥 "clientSecret" 用于定位数据。如果没有找到 secret 或预期的密钥,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。 |
|
| URL 是 oauth 服务器基本 URL |
8.16.1.12. .spec.identityProviders[].gitlab.ca 复制链接链接已复制到粘贴板!
- 描述
- CA 是基于包含 PEM 编码的 CA 捆绑包的名称对配置映射的可选引用。它被用作信任锚,以验证远程服务器提供的 TLS 证书。密钥 "ca.crt" 用于定位数据。如果没有指定且未找到配置映射或预期键,则不会遵守身份提供程序。如果指定的 ca 数据无效,则不会遵守身份提供程序。若为空,则使用默认的系统根证书。此配置映射的命名空间是 openshift-config。
- 类型
-
对象
- 必填
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是引用的配置映射的 metadata.name |
8.16.1.13. .spec.identityProviders[].gitlab.clientSecret 复制链接链接已复制到粘贴板!
- 描述
- clientSecret 是包含 oauth 客户端 secret 的名称对 secret 的必要引用。密钥 "clientSecret" 用于定位数据。如果没有找到 secret 或预期的密钥,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。
- 类型
-
对象
- 必填
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是引用的 secret 的 metadata.name |
8.16.1.14. .spec.identityProviders[].google 复制链接链接已复制到粘贴板!
- 描述
- Google 使用 Google 凭证启用用户身份验证
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| clientId 是 oauth 客户端 ID |
|
| clientSecret 是包含 oauth 客户端 secret 的名称对 secret 的必要引用。密钥 "clientSecret" 用于定位数据。如果没有找到 secret 或预期的密钥,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。 |
|
| hostedDomain 是可选的 Google App 域(如 "mycompany.com")来限制登录 |
8.16.1.15. .spec.identityProviders[].google.clientSecret 复制链接链接已复制到粘贴板!
- 描述
- clientSecret 是包含 oauth 客户端 secret 的名称对 secret 的必要引用。密钥 "clientSecret" 用于定位数据。如果没有找到 secret 或预期的密钥,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。
- 类型
-
对象
- 必填
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是引用的 secret 的 metadata.name |
8.16.1.16. .spec.identityProviders[].htpasswd 复制链接链接已复制到粘贴板!
- 描述
- htpasswd 允许使用 HTPasswd 文件验证凭证进行用户身份验证
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 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
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是引用的 secret 的 metadata.name |
8.16.1.18. .spec.identityProviders[].keystone 复制链接链接已复制到粘贴板!
- 描述
- Keystone 使用 keystone 密码凭证启用用户身份验证
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| CA 是基于包含 PEM 编码的 CA 捆绑包的名称对配置映射的可选引用。它被用作信任锚,以验证远程服务器提供的 TLS 证书。密钥 "ca.crt" 用于定位数据。如果没有指定且未找到配置映射或预期键,则不会遵守身份提供程序。如果指定的 ca 数据无效,则不会遵守身份提供程序。若为空,则使用默认的系统根证书。此配置映射的命名空间是 openshift-config。 |
|
| keystone v3 需要 domainName |
|
| tlsClientCert 是一个根据名称对 secret 的可选引用,其中包含连接到服务器时要存在的 PEM 编码 TLS 客户端证书。密钥 "tls.crt" 用于定位数据。如果没有指定且未找到 secret 或预期的密钥,则不会遵守身份提供程序。如果指定的证书数据无效,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。 |
|
| tlsClientKey 是一个根据名称对 secret 的可选引用,其中包含 tlsClientCert 中引用的客户端证书的 PEM 编码 TLS 私钥。密钥 "tls.key" 用于定位数据。如果没有指定且未找到 secret 或预期的密钥,则不会遵守身份提供程序。如果指定的证书数据无效,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。 |
|
| URL 是要连接到的远程 URL |
8.16.1.19. .spec.identityProviders[].keystone.ca 复制链接链接已复制到粘贴板!
- 描述
- CA 是基于包含 PEM 编码的 CA 捆绑包的名称对配置映射的可选引用。它被用作信任锚,以验证远程服务器提供的 TLS 证书。密钥 "ca.crt" 用于定位数据。如果没有指定且未找到配置映射或预期键,则不会遵守身份提供程序。如果指定的 ca 数据无效,则不会遵守身份提供程序。若为空,则使用默认的系统根证书。此配置映射的命名空间是 openshift-config。
- 类型
-
对象
- 必填
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是引用的配置映射的 metadata.name |
- 描述
- tlsClientCert 是一个根据名称对 secret 的可选引用,其中包含连接到服务器时要存在的 PEM 编码 TLS 客户端证书。密钥 "tls.crt" 用于定位数据。如果没有指定且未找到 secret 或预期的密钥,则不会遵守身份提供程序。如果指定的证书数据无效,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。
- 类型
-
对象
- 必填
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是引用的 secret 的 metadata.name |
- 描述
- tlsClientKey 是一个根据名称对 secret 的可选引用,其中包含 tlsClientCert 中引用的客户端证书的 PEM 编码 TLS 私钥。密钥 "tls.key" 用于定位数据。如果没有指定且未找到 secret 或预期的密钥,则不会遵守身份提供程序。如果指定的证书数据无效,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。
- 类型
-
对象
- 必填
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是引用的 secret 的 metadata.name |
8.16.1.22. .spec.identityProviders[].ldap 复制链接链接已复制到粘贴板!
- 描述
- LDAP 使用 LDAP 凭证启用用户身份验证
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 属性将 LDAP 属性映射到身份 |
|
| bindDN 是要在搜索阶段绑定的可选 DN。 |
|
| bindPassword 是一个可选的对 secret 的引用,按名称包含要在搜索阶段绑定的密码。密钥 "bindPassword" 用于定位数据。如果没有指定且未找到 secret 或预期的密钥,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。 |
|
| CA 是基于包含 PEM 编码的 CA 捆绑包的名称对配置映射的可选引用。它被用作信任锚,以验证远程服务器提供的 TLS 证书。密钥 "ca.crt" 用于定位数据。如果没有指定且未找到配置映射或预期键,则不会遵守身份提供程序。如果指定的 ca 数据无效,则不会遵守身份提供程序。若为空,则使用默认的系统根证书。此配置映射的命名空间是 openshift-config。 |
|
|
insecure (如果为 |
|
| URL 是一个 RFC 2255 URL,指定要使用的 LDAP 搜索参数。URL 的语法为: ldap://host:port/basedn?attribute?scope?filter |
8.16.1.23. .spec.identityProviders[].ldap.attributes 复制链接链接已复制到粘贴板!
- 描述
- 属性将 LDAP 属性映射到身份
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| email 是值应用作电子邮件地址的属性列表。可选。如果未指定,则不会为身份设置电子邮件 |
|
| ID 是值应用作用户 ID 的属性列表。必需。使用第一个非空属性。至少需要一个属性。如果列出的属性都没有值,身份验证会失败。LDAP 标准身份属性为 "dn" |
|
| name 是值应用作显示名称的属性列表。可选。如果未指定,则不会为身份 LDAP 标准显示名称设置"cn"的显示名称 |
|
| preferredUsername 是值应用作首选用户名的属性列表。LDAP 标准登录属性为 "uid" |
8.16.1.24. .spec.identityProviders[].ldap.bindPassword 复制链接链接已复制到粘贴板!
- 描述
- bindPassword 是一个可选的对 secret 的引用,按名称包含要在搜索阶段绑定的密码。密钥 "bindPassword" 用于定位数据。如果没有指定且未找到 secret 或预期的密钥,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。
- 类型
-
对象
- 必填
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是引用的 secret 的 metadata.name |
8.16.1.25. .spec.identityProviders[].ldap.ca 复制链接链接已复制到粘贴板!
- 描述
- CA 是基于包含 PEM 编码的 CA 捆绑包的名称对配置映射的可选引用。它被用作信任锚,以验证远程服务器提供的 TLS 证书。密钥 "ca.crt" 用于定位数据。如果没有指定且未找到配置映射或预期键,则不会遵守身份提供程序。如果指定的 ca 数据无效,则不会遵守身份提供程序。若为空,则使用默认的系统根证书。此配置映射的命名空间是 openshift-config。
- 类型
-
对象
- 必填
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是引用的配置映射的 metadata.name |
8.16.1.26. .spec.identityProviders[].openID 复制链接链接已复制到粘贴板!
- 描述
- OpenID 使用 OpenID 凭证启用用户身份验证
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| CA 是基于包含 PEM 编码的 CA 捆绑包的名称对配置映射的可选引用。它被用作信任锚,以验证远程服务器提供的 TLS 证书。密钥 "ca.crt" 用于定位数据。如果没有指定且未找到配置映射或预期键,则不会遵守身份提供程序。如果指定的 ca 数据无效,则不会遵守身份提供程序。若为空,则使用默认的系统根证书。此配置映射的命名空间是 openshift-config。 |
|
| 声明映射 |
|
| clientId 是 oauth 客户端 ID |
|
| clientSecret 是包含 oauth 客户端 secret 的名称对 secret 的必要引用。密钥 "clientSecret" 用于定位数据。如果没有找到 secret 或预期的密钥,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。 |
|
| extraAuthorizeParameters 是添加到授权请求的任何自定义参数。 |
|
| extraScopes 也是除了标准"openid"范围外请求的任何范围。 |
|
| issuer 是 OpenID 提供程序断言为其 Issuer 标识符的 URL。它必须使用 https,没有查询或分段组件。 |
8.16.1.27. .spec.identityProviders[].openID.ca 复制链接链接已复制到粘贴板!
- 描述
- CA 是基于包含 PEM 编码的 CA 捆绑包的名称对配置映射的可选引用。它被用作信任锚,以验证远程服务器提供的 TLS 证书。密钥 "ca.crt" 用于定位数据。如果没有指定且未找到配置映射或预期键,则不会遵守身份提供程序。如果指定的 ca 数据无效,则不会遵守身份提供程序。若为空,则使用默认的系统根证书。此配置映射的命名空间是 openshift-config。
- 类型
-
对象
- 必填
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是引用的配置映射的 metadata.name |
8.16.1.28. .spec.identityProviders[].openID.claims 复制链接链接已复制到粘贴板!
- 描述
- 声明映射
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| email 是其值应用作电子邮件地址的声明列表。可选。如果未指定,则不会为身份设置电子邮件 |
|
| groups 是声明值列表,应该用于为用户将 OIDC 供应商中的组同步到 OpenShift。如果指定了多个声明,则使用第一个带有非空值的声明。 |
|
| name 是值应用作显示名称的声明列表。可选。如果未指定,则不会为身份设置显示名称 |
|
| preferredUsername 是值应用作首选用户名的声明列表。如果未指定,首选用户名由子声明的值决定 |
8.16.1.29. .spec.identityProviders[].openID.clientSecret 复制链接链接已复制到粘贴板!
- 描述
- clientSecret 是包含 oauth 客户端 secret 的名称对 secret 的必要引用。密钥 "clientSecret" 用于定位数据。如果没有找到 secret 或预期的密钥,则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。
- 类型
-
对象
- 必填
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是引用的 secret 的 metadata.name |
8.16.1.30. .spec.identityProviders[].requestHeader 复制链接链接已复制到粘贴板!
- 描述
- RequestHeader 使用请求标头凭证启用用户身份验证
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| CA 是包含 PEM 编码 CA 捆绑包的名称对配置映射的必需引用。它被用作信任锚,以验证远程服务器提供的 TLS 证书。具体来说,它允许验证传入请求以防止标头欺骗。密钥 "ca.crt" 用于定位数据。如果没有找到配置映射或预期密钥,则不会遵守身份提供程序。如果指定的 ca 数据无效,则不会遵守身份提供程序。此配置映射的命名空间是 openshift-config。 |
|
| 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 是需要与之匹配的常用名称的可选列表。如果为空,则针对 clientCA 捆绑包验证的任何客户端证书都被视为权威。 |
|
| emailHeaders 是检查电子邮件地址的标头集合 |
|
| 标头是用来检查身份信息的标头集合 |
|
| loginURL 是一个 URL,用于将未经身份验证的 /authorize 请求重定向到来自 OAuth 客户端的未验证请求,这个请求希望在此处重定向交互式登录,用当前的 URL 替换转义以在查询参数 https://www.example.com/sso-login?then=${url} ${query} 中被替换为当前查询字符串 https://www.example.com/auth-proxy/oauth/authorize?${query}。 |
|
| nameHeaders 是检查显示名称的标头集合 |
|
| preferredUsernameHeaders 是一组用于检查首选用户名的标头 |
8.16.1.31. .spec.identityProviders[].requestHeader.ca 复制链接链接已复制到粘贴板!
- 描述
- CA 是包含 PEM 编码 CA 捆绑包的名称对配置映射的必需引用。它被用作信任锚,以验证远程服务器提供的 TLS 证书。具体来说,它允许验证传入请求以防止标头欺骗。密钥 "ca.crt" 用于定位数据。如果没有找到配置映射或预期密钥,则不会遵守身份提供程序。如果指定的 ca 数据无效,则不会遵守身份提供程序。此配置映射的命名空间是 openshift-config。
- 类型
-
对象
- 必填
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是引用的配置映射的 metadata.name |
8.16.1.32. .spec.templates 复制链接链接已复制到粘贴板!
- 描述
- 模板允许您自定义登录页面等页面。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| error 是 secret 的名称,用于指定要在身份验证或授权流期间呈现错误页面的 go 模板。密钥 "errors.html" 用于查找模板数据。如果没有指定且未找到 secret 或预期的键,则使用默认错误页面。如果指定模板无效,则使用默认错误页面。如果未指定,则使用默认错误页面。此 secret 的命名空间是 openshift-config。 |
|
| login 是用于指定用于呈现登录页面的 go 模板的 secret 名称。密钥 "login.html" 用于查找模板数据。如果不指定且未找到 secret 或预期密钥,则使用默认的登录页面。如果指定模板无效,则使用默认登录页面。如果未指定,则使用默认登录页面。此 secret 的命名空间是 openshift-config。 |
|
| 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
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是引用的 secret 的 metadata.name |
8.16.1.34. .spec.templates.login 复制链接链接已复制到粘贴板!
- 描述
- login 是用于指定用于呈现登录页面的 go 模板的 secret 名称。密钥 "login.html" 用于查找模板数据。如果不指定且未找到 secret 或预期密钥,则使用默认的登录页面。如果指定模板无效,则使用默认登录页面。如果未指定,则使用默认登录页面。此 secret 的命名空间是 openshift-config。
- 类型
-
对象
- 必填
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是引用的 secret 的 metadata.name |
8.16.1.35. .spec.templates.providerSelection 复制链接链接已复制到粘贴板!
- 描述
- providerSelection 是用于指定用于呈现供应商选择页面的 go 模板的 secret 名称。密钥 "providers.html" 用于查找模板数据。如果没有指定且未找到 secret 或预期的键,则使用默认供应商选择页面。如果指定模板无效,则使用默认供应商选择页面。如果未指定,则使用默认供应商选择页面。此 secret 的命名空间是 openshift-config。
- 类型
-
对象
- 必填
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是引用的 secret 的 metadata.name |
8.16.1.36. .spec.tokenConfig 复制链接链接已复制到粘贴板!
- 描述
- tokenConfig 包含授权和访问令牌的选项
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| accessTokenInactivityTimeout 为任何客户端授予的令牌定义令牌不活跃超时。该值表示连续使用令牌之间可发生的最长时间。如果没有在此时间窗口中使用令牌,则令牌无效。当令牌超时后,用户需要获取新的令牌来重新获得访问。使用有效的持续时间字符串,如 "5m", "1.5h" 或 "2h45m"。持续时间允许的最小值为 300s (5 分钟)。如果每个客户端配置了超时,则该值将具有优先权。如果没有指定超时值,且客户端不会覆盖该值,则令牌有效,直到其生命周期为止。警告:通过更改此值,现有令牌的超时不会受到影响(降低) |
|
| accessTokenInactivityTimeoutSeconds - DEPRECATED: 设置此字段无效。 |
|
| 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 复制链接链接已复制到粘贴板!
参数 | 类型 | 描述 |
---|---|---|
|
| 如果 'true',则输出被用户友善。 |
- HTTP 方法
-
DELETE
- 描述
- 删除 OAuth 的集合
参数 | 类型 | 描述 |
---|---|---|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。 |
|
| 从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。 当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。 |
|
| 用于限制返回的对象列表的选择器。默认为任何内容。 |
|
| 通过标签限制返回的对象列表的选择器。默认为任何内容。 |
|
| 限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 continue 字段为空,客户端可能会假设没有更多可用的结果。如果 watch 为 true,则不支持此字段。 服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象,则返回第一次列表结果时存在的对象版本。 |
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
| list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。 |
|
| 观察对描述的资源的更改,并将其作为添加、更新和删除通知流返回。指定 resourceVersion。 |
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
- HTTP 方法
-
GET
- 描述
- 列出 OAuth 类型的对象
参数 | 类型 | 描述 |
---|---|---|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。 |
|
| 从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。 当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。 |
|
| 用于限制返回的对象列表的选择器。默认为任何内容。 |
|
| 通过标签限制返回的对象列表的选择器。默认为任何内容。 |
|
| 限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 continue 字段为空,客户端可能会假设没有更多可用的结果。如果 watch 为 true,则不支持此字段。 服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象,则返回第一次列表结果时存在的对象版本。 |
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
| list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。 |
|
| 观察对描述的资源的更改,并将其作为添加、更新和删除通知流返回。指定 resourceVersion。 |
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
- HTTP 方法
-
POST
- 描述
- 创建 OAuth
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
参数 | 类型 | 描述 |
---|---|---|
|
|
8.16.2.2. /apis/config.openshift.io/v1/oauths/{name} 复制链接链接已复制到粘贴板!
参数 | 类型 | 描述 |
---|---|---|
|
| OAuth 的名称 |
参数 | 类型 | 描述 |
---|---|---|
|
| 如果 'true',则输出被用户友善。 |
- HTTP 方法
-
DELETE
- 描述
- 删除 OAuth
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| 应该删除对象前的持续时间(以秒为单位)。值必须是非负整数。值零表示立即删除。如果这个值是 nil,则使用指定类型的默认宽限期。如果没有指定,则默认为每个对象值。零表示立即删除。 |
|
| 弃用:请使用 PropagationPolicy,此字段将在 1.7 中被弃用。应该依赖的对象被孤立。如果为 true/false,"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy,但不能同时设置两者。 |
|
| 是否以及是否执行垃圾回收。此字段或 OrphanDependents 可以设置,但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值为: 'Orphan' - 孤立依赖; 'Background' - 允许垃圾收集器在后台删除依赖的依赖关系; 'Foreground' - 一个删除前台所有依赖的级联策略。 |
参数 | 类型 | 描述 |
---|---|---|
|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | 空 |
- HTTP 方法
-
GET
- 描述
- 读取指定的 OAuth
参数 | 类型 | 描述 |
---|---|---|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH
- 描述
- 部分更新指定的 OAuth
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
参数 | 类型 | 描述 |
---|---|---|
|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
- HTTP 方法
-
PUT
- 描述
- 替换指定的 OAuth
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
参数 | 类型 | 描述 |
---|---|---|
|
|
参数 | 类型 | 描述 |
---|---|---|
|
| OAuth 的名称 |
参数 | 类型 | 描述 |
---|---|---|
|
| 如果 'true',则输出被用户友善。 |
- HTTP 方法
-
GET
- 描述
- 指定 OAuth 的读取状态
参数 | 类型 | 描述 |
---|---|---|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH
- 描述
- 指定 OAuth 的部分更新状态
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
参数 | 类型 | 描述 |
---|---|---|
|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
- HTTP 方法
-
PUT
- 描述
- 替换指定 OAuth 的状态
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
参数 | 类型 | 描述 |
---|---|---|
|
|