---
api_metadata:
apiVersion: "authentication.k8s.io/v1"
import: "k8s.io/api/authentication/v1"
kind: "TokenReview"
content_type: "api_reference"
description: "TokenReview 尝试通过验证令牌来确认已知用户。"
title: "TokenReview"
weight: 3
auto_generated: true
---
`apiVersion: authentication.k8s.io/v1`
`import "k8s.io/api/authentication/v1"`
## TokenReview {#TokenReview}
TokenReview 尝试通过验证令牌来确认已知用户。
注意:TokenReview 请求可能会被 kube-apiserver 中的 webhook 令牌验证器插件缓存。
- **apiVersion**: authentication.k8s.io/v1
- **kind**: TokenReview
- **metadata** (}}">ObjectMeta)
标准对象的元数据,更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (}}">TokenReviewSpec), required
spec 保存有关正在评估的请求的信息
- **status** (}}">TokenReviewStatus)
status 由服务器填写,指示请求是否可以通过身份验证。
## TokenReviewSpec {#TokenReviewSpec}
TokenReviewPec 是对令牌身份验证请求的描述。
- **audiences** ([]string)
audiences 是带有令牌的资源服务器标识为受众的标识符列表。
受众感知令牌身份验证器将验证令牌是否适用于此列表中的至少一个受众。
如果未提供受众,受众将默认为 Kubernetes API 服务器的受众。
- **token** (string)
token 是不透明的持有者令牌(Bearer Token)。
## TokenReviewStatus {#TokenReviewStatus}
TokenReviewStatus 是令牌认证请求的结果。
- **audiences** ([]string)
audiences 是身份验证者选择的与 TokenReview 和令牌兼容的受众标识符。标识符是
TokenReviewSpec 受众和令牌受众的交集中的任何标识符。设置 spec.audiences
字段的 TokenReview API 的客户端应验证在 status.audiences 字段中返回了兼容的受众标识符,
以确保 TokenReview 服务器能够识别受众。如果 TokenReview
返回一个空的 status.audience 字段,其中 status.authenticated 为 “true”,
则该令牌对 Kubernetes API 服务器的受众有效。
- **authenticated** (boolean)
authenticated 表示令牌与已知用户相关联。
- **error** (string)
error 表示无法检查令牌
- **user** (UserInfo)
user 是与提供的令牌关联的 UserInfo。
**UserInfo 保存实现 user.Info 接口所需的用户信息**
- **user.extra** (map[string][]string)
验证者提供的任何附加信息。
- **user.groups** ([]string)
此用户所属的组的名称。
- **user.uid** (string)
跨时间标识此用户的唯一值。如果删除此用户并添加另一个同名用户,他们将拥有不同的 UID。
- **user.username** (string)
在所有活跃用户中唯一标识此用户的名称。
## 操作 {#Operations}
### `create` 创建一个TokenReview
#### HTTP 请求
POST /apis/authentication.k8s.io/v1/tokenreviews
#### 参数
- **body**: }}">TokenReview, 必需
- **dryRun** (*in query*): string
}}">dryRun
- **fieldManager** (*in query*): string
}}">fieldManager
- **fieldValidation** (*in query*): string
}}">fieldValidation
- **pretty** (*in query*): string
}}">pretty
#### 响应
200 (}}">TokenReview): OK
201 (}}">TokenReview): Created
202 (}}">TokenReview): Accepted
401: Unauthorized