第 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. 正文参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| 正文(body) | X |
4.1.1.3. 返回类型 复制链接链接已复制到粘贴板!
4.1.1.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
4.1.1.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
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. 路径参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| id | X | null |
4.1.2.3. 返回类型 复制链接链接已复制到粘贴板!
4.1.2.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
4.1.2.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
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. 查询参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| 已撤销 | - | null |
4.1.3.3. 返回类型 复制链接链接已复制到粘贴板!
4.1.3.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
4.1.3.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
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. 返回类型 复制链接链接已复制到粘贴板!
4.1.4.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
4.1.4.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
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. 路径参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| id | X | null |
4.1.5.3. 返回类型 复制链接链接已复制到粘贴板!
对象
4.1.5.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
4.1.5.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 |
|
| 0 | 意外错误响应。 |