TokenReview [authentication.k8s.io/v1] - 授权API | API 参考 | OpenShift Container Platform 4.17

规范
API端点
- /apis/oauth.openshift.io/v1/tokenreviews
- /apis/authentication.k8s.io/v1/tokenreviews

描述

TokenReview尝试将令牌验证到已知用户。注意：TokenReview请求可能被kube-apiserver中的webhook令牌身份验证插件缓存。

类型

对象

必需

spec

规范

属性类型描述

属性	类型	描述
`apiVersion`	`字符串`	APIVersion定义了对象的此表示的版本化模式。服务器应将识别的模式转换为最新的内部值，并可能拒绝无法识别的值。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	Kind是一个字符串值，表示此对象表示的REST资源。服务器可以从客户端提交请求的端点推断出这一点。不能更新。使用驼峰式命名法。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	标准对象的元数据。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`	TokenReviewSpec是对令牌身份验证请求的描述。
`status`	`对象`	TokenReviewStatus是令牌身份验证请求的结果。

apiVersion

字符串

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

kind

字符串

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

metadata

ObjectMeta

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

spec

对象

TokenReviewSpec是对令牌身份验证请求的描述。

status

对象

TokenReviewStatus是令牌身份验证请求的结果。

.spec

描述: TokenReviewSpec是对令牌身份验证请求的描述。
类型: 对象

属性类型描述

属性	类型	描述
`audiences`	`数组 (字符串)`	Audiences是资源服务器使用令牌标识的标识符列表。了解受众的令牌身份验证器将验证令牌是否至少适用于此列表中的一个受众。如果未提供任何受众，则受众将默认为Kubernetes apiserver的受众。
`token`	`字符串`	Token是不透明的承载令牌。

audiences

数组 (字符串)

Audiences是资源服务器使用令牌标识的标识符列表。了解受众的令牌身份验证器将验证令牌是否至少适用于此列表中的一个受众。如果未提供任何受众，则受众将默认为Kubernetes apiserver的受众。

token

字符串

Token是不透明的承载令牌。

.status

描述: TokenReviewStatus是令牌身份验证请求的结果。
类型: 对象

属性类型描述

属性	类型	描述
`audiences`	`数组 (字符串)`	Audiences是由身份验证器选择的、与TokenReview和令牌都兼容的受众标识符。标识符是TokenReviewSpec受众和令牌受众交集中的任何标识符。设置spec.audiences字段的TokenReview API客户端应验证status.audiences字段中是否返回了兼容的受众标识符，以确保TokenReview服务器了解受众。如果TokenReview返回一个空的status.audience字段，其中status.authenticated为“true”，则该令牌对Kubernetes API服务器的受众有效。
`authenticated`	`布尔值`	Authenticated指示令牌是否与已知用户关联。
`error`	`字符串`	错误指示令牌无法检查。
`用户`	`对象`	UserInfo 包含实现 user.Info 接口所需的用户相关信息。

audiences

数组 (字符串)

Audiences是由身份验证器选择的、与TokenReview和令牌都兼容的受众标识符。标识符是TokenReviewSpec受众和令牌受众交集中的任何标识符。设置spec.audiences字段的TokenReview API客户端应验证status.audiences字段中是否返回了兼容的受众标识符，以确保TokenReview服务器了解受众。如果TokenReview返回一个空的status.audience字段，其中status.authenticated为“true”，则该令牌对Kubernetes API服务器的受众有效。

authenticated

布尔值

Authenticated指示令牌是否与已知用户关联。

error

字符串

错误指示令牌无法检查。

用户

对象

UserInfo 包含实现 user.Info 接口所需的用户相关信息。

.status.user

描述: UserInfo 包含实现 user.Info 接口所需的用户相关信息。
类型: 对象

属性类型描述

属性	类型	描述
`额外信息`	`对象`	身份验证器提供的任何附加信息。
`extra{}`	`数组 (字符串)`
`组`	`数组 (字符串)`	此用户所属的组名称。
`用户ID (UID)`	`字符串`	一个唯一值，用于跨时间标识此用户。如果此用户被删除，并且添加了另一个同名用户，则它们将具有不同的 UID。
`用户名`	`字符串`	在所有活动用户中唯一标识此用户的名称。

额外信息

对象

身份验证器提供的任何附加信息。

extra{}

数组 (字符串)

组

数组 (字符串)

此用户所属的组名称。

用户ID (UID)

字符串

一个唯一值，用于跨时间标识此用户。如果此用户被删除，并且添加了另一个同名用户，则它们将具有不同的 UID。

用户名

字符串

在所有活动用户中唯一标识此用户的名称。

.status.user.extra

描述: 身份验证器提供的任何附加信息。
类型: 对象

API 端点

以下 API 端点可用

/apis/oauth.openshift.io/v1/tokenreviews
- POST：创建 TokenReview
/apis/authentication.k8s.io/v1/tokenreviews
- POST：创建 TokenReview

/apis/oauth.openshift.io/v1/tokenreviews

表 1. 全局查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为从对象中删除的每个未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果从对象中删除任何未知字段，或者存在任何重复字段，则这将使用 BadRequest 错误使请求失败。服务器返回的错误将包含遇到的所有未知和重复字段。

HTTP 方法: POST
描述: 创建 TokenReview

表 2. 请求体参数
参数	类型	描述
`请求体 (body)`	`TokenReview` 模式

表 3. HTTP 响应
HTTP 代码	响应体
200 - OK	`TokenReview` 模式
201 - 已创建	`TokenReview` 模式
202 - 已接受	`TokenReview` 模式
401 - 未授权	空

/apis/authentication.k8s.io/v1/tokenreviews

表 4. 全局查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为从对象中删除的每个未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果从对象中删除任何未知字段，或者存在任何重复字段，则这将使用 BadRequest 错误使请求失败。服务器返回的错误将包含遇到的所有未知和重复字段。

HTTP 方法: POST
描述: 创建 TokenReview

表 5. 请求体参数
参数	类型	描述
`请求体 (body)`	`TokenReview` 模式

表 6. HTTP 响应
HTTP 代码	响应体
200 - OK	`TokenReview` 模式
201 - 已创建	`TokenReview` 模式
202 - 已接受	`TokenReview` 模式
401 - 未授权	空