红帽全球峰会OAuth API
Oauth API 的参考指南
摘要
第 1 章 OAuth API
1.1. OAuthAccessToken [oauth.openshift.io/v1]
- 描述
OAuthAccessToken 描述 OAuth 访问令牌。令牌的名称必须以
sha256~字符串作为前缀，不得包含 "/" 或 "%" 字符，且必须至少为 32 个字符。令牌的名称通过 sha256-hashing 从实际令牌构建，并在哈希结果中使用 URL-safe unpadded base64-encoding （如 RFC4648 所述）。
兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
1.2. OAuthAuthorizeToken [oauth.openshift.io/v1]
- 描述
OAuthAuthorizeToken describes an OAuth authorization token
兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
1.3. OAuthClientAuthorization [oauth.openshift.io/v1]
- 描述
OAuthClientAuthorization 描述了由 OAuth 客户端创建的授权
兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
1.4. OAuthClient [oauth.openshift.io/v1]
- 描述
OAuthClient 描述 OAuth 客户端
兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
1.5. UserOAuthAccessToken [oauth.openshift.io/v1]
- 描述
- UserOAuthAccessToken 是一个虚拟资源，可为用户发布访问令牌镜像 OAuthAccessTokens
- 类型
-
对象
第 2 章 OAuthAccessToken [oauth.openshift.io/v1]
- 描述
OAuthAccessToken 描述 OAuth 访问令牌。令牌的名称必须以
sha256~字符串作为前缀，不得包含 "/" 或 "%" 字符，且必须至少为 32 个字符。令牌的名称通过 sha256-hashing 从实际令牌构建，并在哈希结果中使用 URL-safe unpadded base64-encoding （如 RFC4648 所述）。
兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
2.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| AuthorizeToken 包含授权此令牌的令牌 |
|
|
| clientName 引用创建此令牌的客户端。 |
|
|
| expiresIn 是此令牌过期前自 CreationTime 的秒数。 |
|
|
| InactivityTimeoutSeconds 是 CreationTimestamp 的值（以秒为单位），之后无法使用此令牌。使用令牌时，该值会自动递增。 |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| metadata 是标准对象的元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| redirecturi 是与令牌关联的重定向。 |
|
|
| RefreshToken 是可以续订此令牌的值。可以为空。 |
|
|
| scopes 是请求的范围的数组。 |
|
|
| username 是与此令牌关联的用户名 |
|
|
| UserUID 是与此令牌关联的唯一 UID |
2.2. API 端点
可用的 API 端点如下：
/apis/oauth.openshift.io/v1/oauthaccesstokens-
DELETE: delete collection of OAuthAccessToken -
GET: 列出或监视类型为 OAuthAccessToken 的对象 -
POST：创建 OAuthAccessToken
-
/apis/oauth.openshift.io/v1/watch/oauthaccesstokens-
GET: 观察单个对 OAuthAccessToken 列表的更改。已弃用：改为使用 'watch' 参数和列表操作。
-
/apis/oauth.openshift.io/v1/oauthaccesstokens/{name}-
DELETE: delete an OAuthAccessToken -
GET：读取指定的 OAuthAccessToken -
PATCH: 部分更新指定的 OAuthAccessToken -
PUT：替换指定的 OAuthAccessToken
-
/apis/oauth.openshift.io/v1/watch/oauthaccesstokens/{name}-
GET: 观察对类型为 OAuthAccessToken 的对象的更改。已弃用：使用带列表操作的 'watch' 参数，而是过滤成带有 'fieldSelector' 参数的单个项目。
-
2.2.1. /apis/oauth.openshift.io/v1/oauthaccesstokens
- HTTP 方法
-
DELETE - 描述
- 删除 OAuthAccessToken 集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出或监视类型为 OAuthAccessToken 的对象
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- create an OAuthAccessToken
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
2.2.2. /apis/oauth.openshift.io/v1/watch/oauthaccesstokens
- HTTP 方法
-
GET - 描述
- 观察单个对 OAuthAccessToken 列表的更改。已弃用：改为使用 'watch' 参数和 list 操作。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
2.2.3. /apis/oauth.openshift.io/v1/oauthaccesstokens/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| OAuthAccessToken 的名称 |
- HTTP 方法
-
DELETE - 描述
- delete an OAuthAccessToken
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 读取指定的 OAuthAccessToken
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 OAuthAccessToken
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 OAuthAccessToken
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
2.2.4. /apis/oauth.openshift.io/v1/watch/oauthaccesstokens/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| OAuthAccessToken 的名称 |
- HTTP 方法
-
GET - 描述
- 观察对类型为 OAuthAccessToken 的对象的更改。已弃用：使用带有 list 操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
第 3 章 OAuthAuthorizeToken [oauth.openshift.io/v1]
- 描述
OAuthAuthorizeToken describes an OAuth authorization token
兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
3.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| clientName 引用创建此令牌的客户端。 |
|
|
| CodeChallenge 是与此授权代码关联的可选 code_challenge，如 rfc7636 所述 |
|
|
| CodeChallengeMethod 是与此授权代码关联的可选 code_challenge_method，如 rfc7636 所述 |
|
|
| expiresIn 是此令牌过期前自 CreationTime 的秒数。 |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| metadata 是标准对象的元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| redirecturi 是与令牌关联的重定向。 |
|
|
| scopes 是请求的范围的数组。 |
|
|
| 来自请求的状态数据 |
|
|
| username 是与此令牌关联的用户名 |
|
|
| UserUID 是与此令牌关联的唯一 UID。UserUID 和 UserName 必须匹配此令牌才有效。 |
3.2. API 端点
可用的 API 端点如下：
/apis/oauth.openshift.io/v1/oauthauthorizetokens-
DELETE: 删除 OAuthAuthorizeToken 集合 -
GET: list 或 watch kind OAuthAuthorizeToken -
POST：创建一个 OAuthAuthorizeToken
-
/apis/oauth.openshift.io/v1/watch/oauthauthorizetokens-
GET: 观察单个更改 OAuthAuthorizeToken. deprecated: 使用带有列表操作的 'watch' 参数。
-
/apis/oauth.openshift.io/v1/oauthauthorizetokens/{name}-
DELETE: delete an OAuthAuthorizeToken -
GET: 读取指定的 OAuthAuthorizeToken -
PATCH: 部分更新指定的 OAuthAuthorizeToken -
PUT：替换指定的 OAuthAuthorizeToken
-
/apis/oauth.openshift.io/v1/watch/oauthauthorizetokens/{name}-
GET: 观察对类型为 OAuthAuthorizeToken 的对象的更改。已弃用：使用带列表操作的 'watch' 参数，而是过滤成带有 'fieldSelector' 参数的单个项目。
-
3.2.1. /apis/oauth.openshift.io/v1/oauthauthorizetokens
- HTTP 方法
-
DELETE - 描述
- 删除 OAuthAuthorizeToken 集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出或监视类型为 OAuthAuthorizeToken 的对象
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- create an OAuthAuthorizeToken
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
3.2.2. /apis/oauth.openshift.io/v1/watch/oauthauthorizetokens
- HTTP 方法
-
GET - 描述
- 观察单个对 OAuthAuthorizeToken 列表的更改。已弃用：使用带列表操作的 'watch' 参数。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
3.2.3. /apis/oauth.openshift.io/v1/oauthauthorizetokens/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| OAuthAuthorizeToken 的名称 |
- HTTP 方法
-
DELETE - 描述
- delete an OAuthAuthorizeToken
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 阅读指定的 OAuthAuthorizeToken
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 OAuthAuthorizeToken
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 OAuthAuthorizeToken
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
3.2.4. /apis/oauth.openshift.io/v1/watch/oauthauthorizetokens/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| OAuthAuthorizeToken 的名称 |
- HTTP 方法
-
GET - 描述
- 观察对类型为 OAuthAuthorizeToken 的对象的更改。已弃用：使用带有 list 操作的 'watch' 参数，而是过滤成带有 'fieldSelector' 参数的单个项目。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
第 4 章 OAuthClientAuthorization [oauth.openshift.io/v1]
- 描述
OAuthClientAuthorization 描述了由 OAuth 客户端创建的授权
兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
4.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| clientName 引用创建此授权的客户端 |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| metadata 是标准对象的元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| scopes 是授予的范围的数组。 |
|
|
| username 是授权此客户端的用户名 |
|
|
| UserUID 是与此授权关联的唯一 UID。UserUID 和 UserName 必须匹配这个授权才有效。 |
4.2. API 端点
可用的 API 端点如下：
/apis/oauth.openshift.io/v1/oauthclientauthorizations-
DELETE: delete collection of OAuthClientAuthorization -
GET: 列出或监视类型为 OAuthClientAuthorization 的对象 -
POST：创建 OAuthClientAuthorization
-
/apis/oauth.openshift.io/v1/watch/oauthclientauthorizations-
GET: 观察单个对 OAuthClientAuthorization 列表的更改。已弃用：改为使用 'watch' 参数及列表操作。
-
/apis/oauth.openshift.io/v1/oauthclientauthorizations/{name}-
DELETE: delete an OAuthClientAuthorization -
GET：读取指定的 OAuthClientAuthorization -
PATCH: 部分更新指定的 OAuthClientAuthorization -
PUT：替换指定的 OAuthClientAuthorization
-
/apis/oauth.openshift.io/v1/watch/oauthclientauthorizations/{name}-
GET: 观察对类型为 OAuthClientAuthorization 的对象的更改。已弃用：使用带列表操作的 'watch' 参数，而是过滤成带有 'fieldSelector' 参数的单个项目。
-
4.2.1. /apis/oauth.openshift.io/v1/oauthclientauthorizations
- HTTP 方法
-
DELETE - 描述
- 删除 OAuthClientAuthorization 集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出或监视类型为 OAuthClientAuthorization 的对象
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- create an OAuthClientAuthorization
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
4.2.2. /apis/oauth.openshift.io/v1/watch/oauthclientauthorizations
- HTTP 方法
-
GET - 描述
- 观察单个对 OAuthClientAuthorization 列表的更改。已弃用：改为使用 'watch' 参数以及列表操作。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
4.2.3. /apis/oauth.openshift.io/v1/oauthclientauthorizations/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| OAuthClientAuthorization 的名称 |
- HTTP 方法
-
DELETE - 描述
- delete an OAuthClientAuthorization
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 读取指定的 OAuthClientAuthorization
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 OAuthClientAuthorization
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 OAuthClientAuthorization
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
4.2.4. /apis/oauth.openshift.io/v1/watch/oauthclientauthorizations/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| OAuthClientAuthorization 的名称 |
- HTTP 方法
-
GET - 描述
- 观察对类型为 OAuthClientAuthorization 的对象的更改。已弃用：使用带列表操作的 'watch' 参数，而是过滤成带有 'fieldSelector' 参数的单个项目。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
第 5 章 OAuthClient [oauth.openshift.io/v1]
- 描述
OAuthClient 描述 OAuth 客户端
兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
5.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| accessTokenInactivityTimeoutSeconds 覆盖为此客户端授予的令牌的默认令牌不活跃超时。该值代表令牌连续使用之间可持续发生的最长时间。如果在这个时时窗口中不使用令牌，则令牌将变为无效。用户将在令牌超时后获取新令牌，以便重新获得访问。只有在配置中设置的默认值不适用于这个客户端时，才需要设置这个值。有效值为：- 0: Tokens for this client never time out - X: Tokens time out - X: Tokens time out in X seconds for X seconds the current minimum value for X is 300 (5 minutes) 警告：通过更改此值，现有令牌的超时时间不会受到影响（降低） |
|
|
| accessTokenMaxAgeSeconds 覆盖授予此客户端的令牌的默认访问令牌最长期限。0 表示没有过期。 |
|
|
| AdditionalSecrets 包含可用于识别客户端的其他 secret。这可用于轮转和服务帐户令牌验证 |
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| grantMethod 是一个必填字段，决定如何处理此客户端的授予。有效的授权处理方法有： - auto ：始终批准授权请求，对受信任的客户端很有用 - 提示符： 提示用户输入授权请求的批准，对第三方客户端很有用 |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| metadata 是标准对象的元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| redirectURIs 是与客户端关联的有效重定向 URI |
|
|
| respondWithChallenges 指明客户端是否需要以挑战的形式进行身份验证，而不是重定向 |
|
|
| ScopeRestrictions 描述了此客户端可以请求的范围。每个请求的范围会根据每个限制进行检查。如果有任何限制匹配，则允许范围。如果没有限制匹配，则范围将被拒绝。 |
|
|
| ScopeRestriction 描述范围的一个限制。只有一个选项必须是 non-nil。 |
|
|
| secret 是与客户端关联的唯一 secret |
5.1.1. .scopeRestrictions
- 描述
- ScopeRestrictions 描述了此客户端可以请求的范围。每个请求的范围会根据每个限制进行检查。如果有任何限制匹配，则允许范围。如果没有限制匹配，则范围将被拒绝。
- 类型
-
array
5.1.2. .scopeRestrictions[]
- 描述
- ScopeRestriction 描述范围的一个限制。只有一个选项必须是 non-nil。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| ClusterRoleScopeRestriction 描述了集群角色范围的限制 |
|
|
| ExactValues 表示范围必须与特定的字符串集合完全匹配 |
5.1.3. .scopeRestrictions[].clusterRole
- 描述
- ClusterRoleScopeRestriction 描述了集群角色范围的限制
- 类型
-
object - 必填
-
roleNames -
命名空间 -
allowEscalation
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| AllowEscalation 表示您可以请求角色及其扩展资源 |
|
|
| namespaces 是可以被引用的命名空间列表。* 表示其中任何一个（包括 *） |
|
|
| RoleNames 是可引用的集群角色列表。* 表示任何 |
5.2. API 端点
可用的 API 端点如下：
/apis/oauth.openshift.io/v1/oauthclients-
DELETE: 删除 OAuthClient 集合 -
GET: 列出或监视类型为 OAuthClient 的对象 -
POST：创建 OAuthClient
-
/apis/oauth.openshift.io/v1/watch/oauthclients-
GET: 观察单个对 OAuthClient 列表的更改。已弃用：改为使用 'watch' 参数及列表操作。
-
/apis/oauth.openshift.io/v1/oauthclients/{name}-
DELETE: delete an OAuthClient -
GET：读取指定的 OAuthClient -
PATCH: 部分更新指定的 OAuthClient -
PUT：替换指定的 OAuthClient
-
/apis/oauth.openshift.io/v1/watch/oauthclients/{name}-
GET: 观察对类型为 OAuthClient 的对象的更改。已弃用：使用带有 list 操作的 'watch' 参数，而是过滤成带有 'fieldSelector' 参数的单个项目。
-
5.2.1. /apis/oauth.openshift.io/v1/oauthclients
- HTTP 方法
-
DELETE - 描述
- 删除 OAuthClient 集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出或监视类型为 OAuthClient 的对象
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建 OAuthClient
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
5.2.2. /apis/oauth.openshift.io/v1/watch/oauthclients
- HTTP 方法
-
GET - 描述
- 观察单个对 OAuthClient 列表的更改。已弃用：改为使用 'watch' 参数以及列表操作。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
5.2.3. /apis/oauth.openshift.io/v1/oauthclients/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| OAuthClient 的名称 |
- HTTP 方法
-
DELETE - 描述
- delete an OAuthClient
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 读取指定的 OAuthClient
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 OAuthClient
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 OAuthClient
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
5.2.4. /apis/oauth.openshift.io/v1/watch/oauthclients/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| OAuthClient 的名称 |
- HTTP 方法
-
GET - 描述
- 观察对类型为 OAuthClient 的对象的更改。已弃用：使用带列表操作的 'watch' 参数，而是过滤成带有 'fieldSelector' 参数的单个项目。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
第 6 章 UserOAuthAccessToken [oauth.openshift.io/v1]
- 描述
- UserOAuthAccessToken 是一个虚拟资源，可为用户发布访问令牌镜像 OAuthAccessTokens
- 类型
-
对象
6.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| AuthorizeToken 包含授权此令牌的令牌 |
|
|
| clientName 引用创建此令牌的客户端。 |
|
|
| expiresIn 是此令牌过期前自 CreationTime 的秒数。 |
|
|
| InactivityTimeoutSeconds 是 CreationTimestamp 的值（以秒为单位），之后无法使用此令牌。使用令牌时，该值会自动递增。 |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| metadata 是标准对象的元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| redirecturi 是与令牌关联的重定向。 |
|
|
| RefreshToken 是可以续订此令牌的值。可以为空。 |
|
|
| scopes 是请求的范围的数组。 |
|
|
| username 是与此令牌关联的用户名 |
|
|
| UserUID 是与此令牌关联的唯一 UID |
6.2. API 端点
可用的 API 端点如下：
/apis/oauth.openshift.io/v1/useroauthaccesstokens-
GET: 列出或监视类型为 UserOAuthAccessToken 的对象
-
/apis/oauth.openshift.io/v1/watch/useroauthaccesstokens-
GET: 观察单个更改到 UserOAuthAccessToken 列表。已弃用：改为使用 'watch' 参数和列表操作。
-
/apis/oauth.openshift.io/v1/useroauthaccesstokens/{name}-
DELETE: delete an UserOAuthAccessToken -
GET：读取指定的 UserOAuthAccessToken
-
/apis/oauth.openshift.io/v1/watch/useroauthaccesstokens/{name}-
GET: 观察对类型为 UserOAuthAccessToken 的对象的更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤成带有 'fieldSelector' 参数的单个项目。
-
6.2.1. /apis/oauth.openshift.io/v1/useroauthaccesstokens
- HTTP 方法
-
GET - 描述
- 列出或监视类型为 UserOAuthAccessToken 的对象
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
6.2.2. /apis/oauth.openshift.io/v1/watch/useroauthaccesstokens
- HTTP 方法
-
GET - 描述
- 观察单个更改 UserOAuthAccessToken 列表。已弃用：改为使用带有 list 操作的 'watch' 参数。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
6.2.3. /apis/oauth.openshift.io/v1/useroauthaccesstokens/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| UserOAuthAccessToken 的名称 |
- HTTP 方法
-
DELETE - 描述
- delete an UserOAuthAccessToken
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 读取指定的 UserOAuthAccessToken
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
6.2.4. /apis/oauth.openshift.io/v1/watch/useroauthaccesstokens/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| UserOAuthAccessToken 的名称 |
- HTTP 方法
-
GET - 描述
- 观察对类型为 UserOAuthAccessToken 的对象的更改。已弃用：使用带有 list 操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
Legal Notice
Copyright © 2024 Red Hat, Inc.
OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).
Modified versions must remove all Red Hat trademarks.
Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.
Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
