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

OAuthAccessToken [oauth.openshift.io/v1]

描述

OAuthAccessToken 描述 OAuth 访问令牌。令牌名称必须以sha256~ 字符串为前缀，不得包含“/”或“%”字符，并且长度至少为 32 个字符。

令牌的名称由实际令牌构造，方法是对其进行 sha256 哈希处理，然后对哈希结果使用 URL 安全的未填充 base64 编码（如 RFC4648 中所述）。

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

类型

对象

规格

属性 类型 描述

apiVersion

字符串

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

authorizeToken

字符串

AuthorizeToken 包含授权此令牌的令牌

clientName

字符串

ClientName 引用创建此令牌的客户端。

expiresIn

整数

ExpiresIn 是此令牌过期前自 CreationTime 起的秒数。

inactivityTimeoutSeconds

整数

InactivityTimeoutSeconds 是自 CreationTimestamp 起的秒数值，在此之后此令牌将无法再使用。使用令牌时，该值会自动递增。

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

redirectURI

字符串

RedirectURI 是与令牌关联的重定向。

refreshToken

字符串

RefreshToken 是可以通过其更新此令牌的值。可以为空。

scopes

数组（字符串）

Scopes 是请求的范围的数组。

userName

字符串

UserName 是与此令牌关联的用户名

userUID

字符串

UserUID 是与此令牌关联的唯一 UID

API 端点

提供以下 API 端点

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

    • DELETE：删除 OAuthAccessToken 集合

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

    • POST：创建 OAuthAccessToken

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

    • GET：监视 OAuthAccessToken 列表的单个更改。已弃用：改为使用列表操作中的“watch”参数。

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

    • DELETE：删除 OAuthAccessToken

    • GET：读取指定的 OAuthAccessToken

    • PATCH：部分更新指定的 OAuthAccessToken

    • PUT：替换指定的 OAuthAccessToken

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

    • GET：监视 OAuthAccessToken 类型对象的更改。已弃用：改为使用列表操作中的“watch”参数，并使用“fieldSelector”参数将其过滤为单个项目。

/apis/oauth.openshift.io/v1/oauthaccesstokens

HTTP 方法

DELETE

描述

删除 OAuthAccessToken 集合

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

dryRun

字符串

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

200 - OK

Status_v6 模式

401 - 未授权

空
HTTP 方法

GET

描述

列出或监视 OAuthAccessToken 类型对象

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

200 - OK

OAuthAccessTokenList 模式

401 - 未授权

空
HTTP 方法

POST

描述

创建 OAuthAccessToken

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

dryRun

字符串

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

fieldValidation

字符串

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

body

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

200 - OK

OAuthAccessToken 模式

201 - 已创建

OAuthAccessToken 模式

202 - 已接受

OAuthAccessToken 模式

401 - 未授权

空

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

HTTP 方法

GET

描述

监控 OAuthAccessToken 列表的单个更改。已弃用：请改用列表操作中的“watch”参数。

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

200 - OK

WatchEvent 模式

401 - 未授权

空

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

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

name

字符串

OAuthAccessToken 的名称
HTTP 方法

DELETE

描述

删除 OAuthAccessToken

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

dryRun

字符串

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

200 - OK

OAuthAccessToken 模式

202 - 已接受

OAuthAccessToken 模式

401 - 未授权

空
HTTP 方法

GET

描述

读取指定的 OAuthAccessToken

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

200 - OK

OAuthAccessToken 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 OAuthAccessToken

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

OAuthAccessToken 模式

201 - 已创建

OAuthAccessToken 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 OAuthAccessToken

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

dryRun

字符串

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

fieldValidation

字符串

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

body

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

200 - OK

OAuthAccessToken 模式

201 - 已创建

OAuthAccessToken 模式

401 - 未授权

空

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

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

name

字符串

OAuthAccessToken 的名称
HTTP 方法

GET

描述

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

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

200 - OK

WatchEvent 模式

401 - 未授权

空