第 4 章 APIToken Service


4.1. 一个 P I Token Service

4.1.1. GenerateToken

POST /v1/apitokens/generate

GenerateToken 为给定用户和角色生成 API 令牌。

4.1.1.1. 描述

4.1.1.2. 参数

4.1.1.2.1. 正文参数
Expand
Name描述必填defaultpattern

正文(body)

V1GenerateTokenRequest

X

  

4.1.1.3. 返回类型

V1GenerateTokenResponse

4.1.1.4. 内容类型

  • application/json

4.1.1.5. 响应

Expand
表 4.1. HTTP 响应代码
代码消息datatype

200

成功响应。

V1GenerateTokenResponse

0

意外错误响应。

GooglerpcStatus

4.1.1.6. Samples

4.1.2. GetAPIToken

GET /v1/apitokens/{id}

GetAPIToken 返回给定 id 的 API 令牌元数据。

4.1.2.1. 描述

4.1.2.2. 参数

4.1.2.2.1. 路径参数
Expand
Name描述必填defaultpattern

id

 

X

null

 

4.1.2.3. 返回类型

StorageTokenMetadata

4.1.2.4. 内容类型

  • application/json

4.1.2.5. 响应

Expand
表 4.2. HTTP 响应代码
代码消息datatype

200

成功响应。

StorageTokenMetadata

0

意外错误响应。

GooglerpcStatus

4.1.2.6. Samples

4.1.3. GetAPITokens

GET /v1/apitokens

GetAPITokens 返回所有 API 令牌。

4.1.3.1. 描述

4.1.3.2. 参数

4.1.3.2.1. 查询参数
Expand
Name描述必填defaultpattern

已撤销

 

-

null

 

4.1.3.3. 返回类型

V1GetAPITokensResponse

4.1.3.4. 内容类型

  • application/json

4.1.3.5. 响应

Expand
表 4.3. HTTP 响应代码
代码消息datatype

200

成功响应。

V1GetAPITokensResponse

0

意外错误响应。

GooglerpcStatus

4.1.3.6. Samples

4.1.4. ListAllowedTokenRoles

GET /v1/apitokens/generate/allowed-roles

GetAllowedTokenRoles 返回允许用户为 API 令牌请求的角色。

4.1.4.1. 描述

4.1.4.2. 参数

4.1.4.3. 返回类型

V1ListAllowedTokenRolesResponse

4.1.4.4. 内容类型

  • application/json

4.1.4.5. 响应

Expand
表 4.4. HTTP 响应代码
代码消息datatype

200

成功响应。

V1ListAllowedTokenRolesResponse

0

意外错误响应。

GooglerpcStatus

4.1.4.6. Samples

4.1.5. RevokeToken

PATCH /v1/apitokens/revoke/{id}

RevokeToken 删除给定 ID 的 API 令牌。

4.1.5.1. 描述

4.1.5.2. 参数

4.1.5.2.1. 路径参数
Expand
Name描述必填defaultpattern

id

 

X

null

 

4.1.5.3. 返回类型

对象

4.1.5.4. 内容类型

  • application/json

4.1.5.5. 响应

Expand
表 4.5. HTTP 响应代码
代码消息datatype

200

成功响应。

对象

0

意外错误响应。

GooglerpcStatus

4.1.5.6. Samples

Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2026 Red Hat
返回顶部