×
描述

身份记录用户与身份提供者成功身份验证。身份存储有关身份验证来源的信息,然后将其与单个用户对象关联。多个身份可以引用单个用户。从身份验证提供者检索到的信息使用由提供者确定的模式存储在 extra 字段中。

兼容性级别 1:在主要版本中稳定至少 12 个月或 3 个次要版本(以较长者为准)。

类型

对象

必需
  • providerName

  • providerUserName

  • user

规格

属性 类型 描述

apiVersion

字符串

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

extra

对象(字符串)

Extra 包含有关此身份的额外信息

kind

字符串

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

metadata

ObjectMeta_v2

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

providerName

字符串

ProviderName 是身份信息的来源

providerUserName

字符串

ProviderUserName 在提供程序范围内唯一表示此身份

user

ObjectReference

User 是对与此身份关联的用户对象的引用。必须同时设置 Name 和 UID

API 端点

提供以下 API 端点:

  • /apis/user.openshift.io/v1/identities

    • DELETE:删除 Identity 集合

    • GET:列出或监视 Identity 类型的对象

    • POST:创建一个 Identity

  • /apis/user.openshift.io/v1/watch/identities

    • GET:监视 Identity 列表的单个更改。已弃用:改用列表操作中的“watch”参数。

  • /apis/user.openshift.io/v1/identities/{name}

    • DELETE:删除一个 Identity

    • GET:读取指定的 Identity

    • PATCH:部分更新指定的 Identity

    • PUT:替换指定的 Identity

  • /apis/user.openshift.io/v1/watch/identities/{name}

    • GET:监视 Identity 类型对象的更改。已弃用:改用列表操作中的“watch”参数,并使用“fieldSelector”参数过滤为单个项目。

/apis/user.openshift.io/v1/identities

HTTP 方法

DELETE

描述

删除 Identity 集合

表 1. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

表 2. HTTP 响应
HTTP 代码 响应正文

200 - OK

Status_v11 模式

401 - 未授权

HTTP 方法

GET

描述

列出或监视 Identity 类型的对象

表 3. HTTP 响应
HTTP 代码 响应正文

200 - OK

IdentityList 模式

401 - 未授权

HTTP 方法

POST

描述

创建一个 Identity

表 4. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略任何被对象静默删除的未知字段,并且将忽略解码器遇到的所有重复字段(最后一个除外)。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍然会成功,并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict:如果任何未知字段将从对象中删除,或者如果存在任何重复字段,这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 5. 请求正文参数
参数 类型 描述

body

Identity 模式

表 6. HTTP 响应
HTTP 代码 响应正文

200 - OK

Identity 模式

201 - 已创建

Identity 模式

202 - 已接受

Identity 模式

401 - 未授权

/apis/user.openshift.io/v1/watch/identities

HTTP 方法

GET

描述

监视 Identity 列表的单个更改。已弃用:改用列表操作中的“watch”参数。

表 7. HTTP 响应
HTTP 代码 响应正文

200 - OK

WatchEvent 模式

401 - 未授权

/apis/user.openshift.io/v1/identities/{name}

表 8. 全局路径参数
参数 类型 描述

name

字符串

Identity 的名称

HTTP 方法

DELETE

描述

删除一个 Identity

表 9. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

表 10. HTTP 响应
HTTP 代码 响应正文

200 - OK

Status_v11 模式

202 - 已接受

Status_v11 模式

401 - 未授权

HTTP 方法

GET

描述

读取指定的 Identity

表 11. HTTP 响应
HTTP 代码 响应正文

200 - OK

Identity 模式

401 - 未授权

HTTP 方法

PATCH

描述

部分更新指定的 Identity

表 12. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略任何被对象静默删除的未知字段,并且将忽略解码器遇到的所有重复字段(最后一个除外)。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍然会成功,并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict:如果任何未知字段将从对象中删除,或者如果存在任何重复字段,这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 13. HTTP 响应
HTTP 代码 响应正文

200 - OK

Identity 模式

201 - 已创建

Identity 模式

401 - 未授权

HTTP 方法

PUT

描述

替换指定的 Identity

表 14. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略任何被对象静默删除的未知字段,并且将忽略解码器遇到的所有重复字段(最后一个除外)。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍然会成功,并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict:如果任何未知字段将从对象中删除,或者如果存在任何重复字段,这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 15. 请求体参数
参数 类型 描述

body

Identity 模式

表 16. HTTP 响应
HTTP 代码 响应正文

200 - OK

Identity 模式

201 - 已创建

Identity 模式

401 - 未授权

/apis/user.openshift.io/v1/watch/identities/{name}

表 17. 全局路径参数
参数 类型 描述

name

字符串

Identity 的名称

HTTP 方法

GET

描述

监听 Identity 对象的更改。已弃用:请改用列表操作中的“watch”参数,并使用“fieldSelector”参数将其过滤为单个项目。

表 18. HTTP 响应
HTTP 代码 响应正文

200 - OK

WatchEvent 模式

401 - 未授权