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

OAuthClientAuthorization [oauth.openshift.io/v1]

描述

OAuthClientAuthorization描述了由OAuth客户端创建的授权

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

类型

对象

规格

属性 类型 描述

apiVersion

字符串

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

clientName

字符串

ClientName引用创建此授权的客户端

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

scopes

数组（字符串）

Scopes是已授予范围的数组。

userName

字符串

UserName是授权此客户端的用户名称

userUID

字符串

UserUID是与此授权关联的唯一UID。UserUID和UserName必须都匹配，此授权才有效。

API端点

提供以下API端点

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

    • DELETE：删除OAuthClientAuthorization集合

    • GET：列出或监视OAuthClientAuthorization类型的对象

    • POST：创建一个OAuthClientAuthorization

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

    • GET：监视对OAuthClientAuthorization列表的单个更改。已弃用：请改用列表操作的“watch”参数。

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

    • DELETE：删除OAuthClientAuthorization

    • GET：读取指定的OAuthClientAuthorization

    • PATCH：部分更新指定的OAuthClientAuthorization

    • PUT：替换指定的OAuthClientAuthorization

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

    • GET：观察 OAuthClientAuthorization 对象的更改。已弃用：请改用列表操作中的“watch”参数，并使用“fieldSelector”参数将其过滤为单个项目。

/apis/oauth.openshift.io/v1/oauthclientauthorizations

HTTP 方法

DELETE

描述

删除 OAuthClientAuthorization 集合

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

dryRun

字符串

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

200 - OK

Status_v6 模式

401 - 未授权

空
HTTP 方法

GET

描述

列出或观察 OAuthClientAuthorization 对象

表 3. HTTP 响应
HTTP 代码 响应正文

200 - OK

OAuthClientAuthorizationList 模式

401 - 未授权

空
HTTP 方法

POST

描述

创建 OAuthClientAuthorization

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

dryRun

字符串

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

fieldValidation

字符串

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

body

OAuthClientAuthorization 模式
表 6. HTTP 响应
HTTP 代码 响应正文

200 - OK

OAuthClientAuthorization 模式

201 - 已创建

OAuthClientAuthorization 模式

202 - 已接受

OAuthClientAuthorization 模式

401 - 未授权

空

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

HTTP 方法

GET

描述

观察 OAuthClientAuthorization 列表的单个更改。已弃用：请改用列表操作中的“watch”参数。

表 7. HTTP 响应
HTTP 代码 响应正文

200 - OK

WatchEvent 模式

401 - 未授权

空

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

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

name

字符串

OAuthClientAuthorization 的名称
HTTP 方法

DELETE

描述

删除 OAuthClientAuthorization

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

dryRun

字符串

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

200 - OK

Status_v6 模式

202 - 已接受

Status_v6 模式

401 - 未授权

空
HTTP 方法

GET

描述

读取指定的 OAuthClientAuthorization

表 11. HTTP 响应
HTTP 代码 响应正文

200 - OK

OAuthClientAuthorization 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 OAuthClientAuthorization

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

OAuthClientAuthorization 模式

201 - 已创建

OAuthClientAuthorization 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 OAuthClientAuthorization

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

dryRun

字符串

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

fieldValidation

字符串

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

body

OAuthClientAuthorization 模式
表 16. HTTP 响应
HTTP 代码 响应正文

200 - OK

OAuthClientAuthorization 模式

201 - 已创建

OAuthClientAuthorization 模式

401 - 未授权

空

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

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

name

字符串

OAuthClientAuthorization 的名称
HTTP 方法

GET

描述

观察 OAuthClientAuthorization 对象的更改。已弃用：请改用列表操作中的“watch”参数，并使用“fieldSelector”参数将其过滤为单个项目。

表 18. HTTP 响应
HTTP 代码 响应正文

200 - OK

WatchEvent 模式

401 - 未授权

空