ClaimMapping

用户上下文映射(ClaimMapping)

[GET] /api/v2/identity/claim-mappings

获取所有用户上下文。

参数

名称	类型	位置	描述
onlyNames	Boolean	query	是否只检索声明名称。例如：true

响应

状态代码: 200

成功

ClaimMappingModel

[POST] /api/v2/identity/claim-mappings

添加新的用户上下文。

请求模式

ClaimMappingCreationModel

响应

状态代码: 201

成功

ClaimMappingModel

状态代码: 400

错误请求

ApiErrorResult

[GET] /api/v2/identity/claim-mappings/{id}

获取指定的用户上下文。

参数

名称	类型	位置	描述
id必填项	string	path	用户上下文 ID。

响应

状态代码: 200

成功

ClaimMappingModel

状态代码: 404

未发现

ApiErrorResult

[PUT] /api/v2/identity/claim-mappings/{id}

修改指定的用户上下文。

参数

名称	类型	位置	描述
id必填项	string	path	用户上下文 ID。

请求模式

ClaimMappingCreationModel

响应

状态代码: 200

成功

ClaimMappingModel

状态代码: 400

错误请求

ApiErrorResult

状态代码: 404

未发现

ApiErrorResult

[DELETE] /api/v2/identity/claim-mappings/{id}

删除指定的用户上下文。

参数

名称	类型	位置	描述
id必填项	string	path	用户上下文 ID。

响应

状态代码: 204

成功

状态代码: 400

错误请求

ApiErrorResult

状态代码: 404

未发现

ApiErrorResult

模型定义

Ƭ ClaimMappingModel

名称	类型	描述	示例
id可为空	string
name	string
propName	string
isBuiltIn	Boolean

Ƭ ApiErrorResult

用来描述处理网络请求时发生的所有错误的模型。

名称	类型	描述	示例
errors可为空	ApiError	错误列表。

Ƭ ApiError

用来描述处理网络请求时发生的错误的模型。

名称	类型	描述
code可为空	string	错误的唯一标识。
message可为空	string	错误的描述文本。
context可为空	string	错误的一些相关上下文信息。

Ƭ ClaimMappingCreationModel

名称	类型	描述	示例
name	string	声明名称。	`"gender"`
propName	string	自定义属性名称。	`"Gender"`