OpenShift 文档正在迁移，很快将仅在 docs.redhat.com（所有 Red Hat 产品文档的所在地）提供。立即体验 新的文档体验。
  1. 文档
    2. history bug_report picture_as_pdf
×

OAuthClient [oauth.openshift.io/v1]

描述

OAuthClient 描述了一个 OAuth 客户端

兼容性级别 1：在主要版本中至少稳定 12 个月或 3 个次要版本（以较长者为准）。

类型

对象

规格

属性 类型 描述

accessTokenInactivityTimeoutSeconds

整数

AccessTokenInactivityTimeoutSeconds 覆盖授予此客户端的令牌的默认令牌非活动超时。该值表示连续使用令牌之间可以发生的最大时间量。如果令牌在此时间窗口内未使用，则令牌将失效。令牌超时后，用户需要获取新令牌才能重新获得访问权限。只有当配置中设置的默认值不适合此客户端时，才需要设置此值。有效值为：- 0：此客户端的令牌永不过期 - X：如果 X 秒内没有活动，则令牌过期。当前允许的 X 的最小值为 300（5 分钟）

警告：更改此值不会影响现有令牌的超时（降低）。

accessTokenMaxAgeSeconds

整数

AccessTokenMaxAgeSeconds 覆盖授予此客户端的令牌的默认访问令牌最大期限。0 表示永不过期。

additionalSecrets

数组（字符串）

AdditionalSecrets 保存可用于识别客户端的其他密钥。这对于轮换和服务帐户令牌验证非常有用。

apiVersion

字符串

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

grantMethod

字符串

GrantMethod 是一个必填字段，用于确定如何处理此客户端的授权。有效的授权处理方法是：- auto：始终批准授权请求，适用于受信任的客户端 - prompt：提示最终用户批准授权请求，适用于第三方客户端

kind

字符串

Kind 是一个字符串值，表示此对象表示的 REST 资源。服务器可以从客户端提交请求的端点推断出这一点。无法更新。采用驼峰式命名法。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta_v2

metadata 是标准对象的元数据。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

redirectURIs

数组（字符串）

RedirectURIs 是与客户端关联的有效重定向 URI。

respondWithChallenges

布尔值

RespondWithChallenges 指示客户端是否希望以挑战的形式而不是重定向的形式进行身份验证所需的响应。

scopeRestrictions

数组

ScopeRestrictions 描述此客户端可以请求的范围。每个请求的范围都将针对每个限制进行检查。如果任何限制匹配，则允许该范围。如果没有限制匹配，则拒绝该范围。

scopeRestrictions[]

对象

ScopeRestriction 描述范围的一个限制。必须只有一个选项非空。

secret

字符串

Secret 是与客户端关联的唯一密钥。

.scopeRestrictions

描述

ScopeRestrictions 描述此客户端可以请求的范围。每个请求的范围都将针对每个限制进行检查。如果任何限制匹配，则允许该范围。如果没有限制匹配，则拒绝该范围。

类型

数组

.scopeRestrictions[]

描述

ScopeRestriction 描述范围的一个限制。必须只有一个选项非空。

类型

对象

属性 类型 描述

clusterRole

对象

ClusterRoleScopeRestriction 描述了对集群角色范围的限制。

literals

数组（字符串）

ExactValues 表示范围必须与特定字符串集完全匹配。

.scopeRestrictions[].clusterRole

描述

ClusterRoleScopeRestriction 描述了对集群角色范围的限制。

类型

对象

必需

  • roleNames

  • namespaces

  • allowEscalation

属性 类型 描述

allowEscalation

布尔值

AllowEscalation 指示您是否可以请求角色及其升级的资源。

namespaces

数组（字符串）

Namespaces 是可以引用的命名空间列表。* 表示任何命名空间（包括 *）。

roleNames

数组（字符串）

RoleNames 是可以引用的集群角色列表。* 代表任何角色。

API 端点

以下 API 端点可用：

  • /apis/oauth.openshift.io/v1/oauthclients

    • DELETE：删除 OAuthClient 集合。

    • GET：列出或监听 OAuthClient 对象。

    • POST：创建一个 OAuthClient。

  • /apis/oauth.openshift.io/v1/watch/oauthclients

    • GET：监听 OAuthClient 列表的单个变更。已弃用：请改用列表操作中的 'watch' 参数。

  • /apis/oauth.openshift.io/v1/oauthclients/{name}

    • DELETE：删除一个 OAuthClient。

    • GET：读取指定的 OAuthClient。

    • PATCH：部分更新指定的 OAuthClient。

    • PUT：替换指定的 OAuthClient。

  • /apis/oauth.openshift.io/v1/watch/oauthclients/{name}

    • GET：监听 OAuthClient 对象的变更。已弃用：请改用列表操作中的 'watch' 参数，并使用 'fieldSelector' 参数过滤为单个项目。

/apis/oauth.openshift.io/v1/oauthclients

HTTP 方法

DELETE

描述

删除 OAuthClient 集合

表 1. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段。
表 2. HTTP 响应
HTTP 代码 响应体

200 - OK

Status_v6 模式

401 - 未授权

空
HTTP 方法

GET

描述

列出或监听 OAuthClient 对象

表 3. HTTP 响应
HTTP 代码 响应体

200 - OK

OAuthClientList 模式

401 - 未授权

空
HTTP 方法

POST

描述

创建一个 OAuthClient

表 4. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段。

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象静默丢弃的未知字段，并将忽略解码器遇到的所有重复字段（仅保留最后一个）。这是 v1.23 之前的默认行为。- Warn：对于对象中被丢弃的每个未知字段和遇到的每个重复字段，这将通过标准警告响应头发送警告。如果没有任何其他错误，请求仍将成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值。- Strict：如果任何未知字段将被从对象中删除，或者如果存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 5. 请求体参数
参数 类型 描述

body

OAuthClient 模式
表 6. HTTP 响应
HTTP 代码 响应体

200 - OK

OAuthClient 模式

201 - 已创建

OAuthClient 模式

202 - 已接受

OAuthClient 模式

401 - 未授权

空

/apis/oauth.openshift.io/v1/watch/oauthclients

HTTP 方法

GET

描述

监听 OAuthClient 列表的单个变更。已弃用：请改用列表操作中的 'watch' 参数。

表 7. HTTP 响应
HTTP 代码 响应体

200 - OK

WatchEvent 模式

401 - 未授权

空

/apis/oauth.openshift.io/v1/oauthclients/{name}

表 8. 全局路径参数
参数 类型 描述

name

字符串

OAuthClient 的名称
HTTP 方法

DELETE

描述

删除一个 OAuthClient

表 9. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段。
表 10. HTTP 响应
HTTP 代码 响应体

200 - OK

Status_v6 模式

202 - 已接受

Status_v6 模式

401 - 未授权

空
HTTP 方法

GET

描述

读取指定的 OAuthClient

表 11. HTTP 响应
HTTP 代码 响应体

200 - OK

OAuthClient 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 OAuthClient

表 12. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段。

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象静默丢弃的未知字段，并将忽略解码器遇到的所有重复字段（仅保留最后一个）。这是 v1.23 之前的默认行为。- Warn：对于对象中被丢弃的每个未知字段和遇到的每个重复字段，这将通过标准警告响应头发送警告。如果没有任何其他错误，请求仍将成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值。- Strict：如果任何未知字段将被从对象中删除，或者如果存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 13. HTTP 响应
HTTP 代码 响应体

200 - OK

OAuthClient 模式

201 - 已创建

OAuthClient 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 OAuthClient

表 14. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段。

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象静默丢弃的未知字段，并将忽略解码器遇到的所有重复字段（仅保留最后一个）。这是 v1.23 之前的默认行为。- Warn：对于对象中被丢弃的每个未知字段和遇到的每个重复字段，这将通过标准警告响应头发送警告。如果没有任何其他错误，请求仍将成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值。- Strict：如果任何未知字段将被从对象中删除，或者如果存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 15. 请求体参数
参数 类型 描述

body

OAuthClient 模式
表 16. HTTP 响应
HTTP 代码 响应体

200 - OK

OAuthClient 模式

201 - 已创建

OAuthClient 模式

401 - 未授权

空

/apis/oauth.openshift.io/v1/watch/oauthclients/{name}

表 17. 全局路径参数
参数 类型 描述

name

字符串

OAuthClient 的名称
HTTP 方法

GET

描述

监听 OAuthClient 对象的变更。已弃用：请改用列表操作中的 'watch' 参数，并使用 'fieldSelector' 参数过滤为单个项目。

表 18. HTTP 响应
HTTP 代码 响应体

200 - OK

WatchEvent 模式

401 - 未授权

空