Keycloak 管理员 REST API

PUT /admin/realms/{realm}/authentication/config/{id}

更新身份验证配置

参数

路径参数

名称	描述	默认值	模式
realm 必需	领域名称（不是 ID！）	null
id 必需	配置 ID	null

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

id
必需

配置 ID

null

主体参数

名称	描述	默认值	模式
AuthenticatorConfigRepresentation 可选	AuthenticatorConfigRepresentation

名称

描述

默认值

模式

AuthenticatorConfigRepresentation
可选

响应

代码	消息	数据类型
204	无内容	<<>>

代码

消息

数据类型

204

无内容

<<>>

POST /admin/realms/{realm}/authentication/config

创建新的身份验证配置

参数

路径参数

名称	描述	默认值	模式
realm 必需	领域名称（不是 ID！）	null

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

主体参数

名称	描述	默认值	模式
AuthenticatorConfigRepresentation 可选	AuthenticatorConfigRepresentation

名称

描述

默认值

模式

AuthenticatorConfigRepresentation
可选

响应

代码	消息	数据类型
201	已创建	<<>>

代码

消息

数据类型

201

已创建

<<>>

GET /admin/realms/{realm}/authentication/executions/{executionId}/config/{id}

获取执行的配置

参数

路径参数

名称	描述	默认值
realm 必需	领域名称（不是 ID！）	null
executionId 必需	执行 ID	null
id 必需	配置 ID	null

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

executionId
必需

执行 ID

null

id
必需

配置 ID

null

内容类型

application/json

响应

代码	消息	数据类型
200	OK	AuthenticatorConfigRepresentation

代码

消息

数据类型

200

POST /admin/realms/{realm}/authentication/executions/{executionId}/config

使用新配置更新执行

参数

路径参数

名称	描述	默认值	模式
realm 必需	领域名称（不是 ID！）	null
executionId 必需	执行 ID	null

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

executionId
必需

执行 ID

null

主体参数

名称	描述	默认值	模式
AuthenticatorConfigRepresentation 可选	AuthenticatorConfigRepresentation

名称

描述

默认值

模式

AuthenticatorConfigRepresentation
可选

AuthenticationExecutionRepresentation

响应

代码	消息	数据类型
201	已创建	<<>>

代码

消息

数据类型

201

已创建

<<>>

DELETE /admin/realms/{realm}/authentication/executions/{executionId}

删除执行

参数

路径参数

名称	描述	默认值	模式
realm 必需	领域名称（不是 ID！）	null
executionId 必需	执行 ID	null

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

executionId
必需

执行 ID

null

响应

代码	消息	数据类型
204	无内容	<<>>

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/authentication/executions/{executionId}

获取单个执行

参数

路径参数

名称	描述	默认值	模式
realm 必需	领域名称（不是 ID！）	null
executionId 必需		null

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

executionId
必需

null

内容类型

application/json

响应

代码	消息	数据类型
200	OK	AuthenticationExecutionRepresentation

代码

消息

数据类型

200

POST /admin/realms/{realm}/authentication/executions/{executionId}/lower-priority

降低执行的优先级

参数

路径参数

名称	描述	默认值	模式
realm 必需	领域名称（不是 ID！）	null
executionId 必需	执行 ID	null

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

executionId
必需

执行 ID

null

响应

代码	消息	数据类型
204	无内容	<<>>

代码

消息

数据类型

204

无内容

<<>>

POST /admin/realms/{realm}/authentication/executions/{executionId}/raise-priority

提高执行的优先级

参数

路径参数

名称	描述	默认值	模式
realm 必需	领域名称（不是 ID！）	null
executionId 必需	执行 ID	null

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

executionId
必需

执行 ID

null

响应

代码	消息	数据类型
204	无内容	<<>>

代码

消息

数据类型

204

无内容

<<>>

POST /admin/realms/{realm}/authentication/executions

添加新的身份验证执行

参数

路径参数

名称	描述	默认值	模式
realm 必需	领域名称（不是 ID！）	null

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

主体参数

名称	描述	默认值	模式
AuthenticationExecutionRepresentation 可选	AuthenticationExecutionRepresentation

名称

描述

默认值

模式

AuthenticationExecutionRepresentation
可选

AuthenticationExecutionRepresentation

响应

代码	消息	数据类型
201	已创建	<<>>

代码

消息

数据类型

201

已创建

<<>>

POST /admin/realms/{realm}/authentication/flows/{flowAlias}/copy

使用新名称复制现有的身份验证流程。新名称作为传递的 JSON 对象的“newName”属性给出。

参数

路径参数

名称	描述	默认值	模式
realm 必需	领域名称（不是 ID！）	null
flowAlias 必需	现有身份验证流程的名称	null

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

flowAlias
必需

现有身份验证流程的名称

null

主体参数

名称	描述	默认值	模式
请求体可选	[string]

名称

描述

默认值

模式

请求体
可选

AuthenticationExecutionInfoRepresentation

响应

代码	消息	数据类型
201	已创建	<<>>

代码

消息

数据类型

201

已创建

<<>>

POST /admin/realms/{realm}/authentication/flows/{flowAlias}/executions/execution

向流程添加新的身份验证执行

参数

路径参数

名称	描述	默认值	模式
realm 必需	领域名称（不是 ID！）	null
flowAlias 必需	父流程的别名	null

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

flowAlias
必需

父流程的别名

null

主体参数

名称	描述	默认值	模式
请求体可选	[AnyType]

名称

描述

默认值

模式

请求体
可选

[AnyType]

响应

代码	消息	数据类型
201	已创建	<<>>

代码

消息

数据类型

201

已创建

<<>>

POST /admin/realms/{realm}/authentication/flows/{flowAlias}/executions/flow

使用新的执行向现有流程添加新流程

参数

路径参数

名称	描述	默认值	模式
realm 必需	领域名称（不是 ID！）	null
flowAlias 必需	父身份验证流程的别名	null

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

flowAlias
必需

父身份验证流程的别名

null

主体参数

名称	描述	默认值	模式
请求体可选	[AnyType]

名称

描述

默认值

模式

请求体
可选

[AnyType]

响应

代码	消息	数据类型
201	已创建	<<>>

代码

消息

数据类型

201

已创建

<<>>

GET /admin/realms/{realm}/authentication/flows/{flowAlias}/executions

获取流程的身份验证执行

参数

路径参数

名称	描述	默认值	模式
realm 必需	领域名称（不是 ID！）	null
flowAlias 必需	流程别名	null

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

flowAlias
必需

流程别名

null

内容类型

application/json

响应

代码	消息	数据类型
200	OK	List[AuthenticationExecutionInfoRepresentation]

代码

消息

数据类型

200

List[AuthenticationExecutionInfoRepresentation]

PUT /admin/realms/{realm}/authentication/flows/{flowAlias}/executions

更新流程的身份验证执行

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

flowAlias
必需

流程别名

null

主体参数

名称

描述

默认值

模式

AuthenticationExecutionInfoRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/authentication/flows

获取身份验证流程。返回身份验证流程的流。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[AuthenticationFlowRepresentation]

DELETE /admin/realms/{realm}/authentication/flows/{id}

删除身份验证流程

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

id
必需

流程 ID

null

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/authentication/flows/{id}

获取 ID 的身份验证流程

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

id
必需

流程 ID

null

内容类型

application/json

响应

代码

消息

数据类型

200

AuthenticationFlowRepresentation

PUT /admin/realms/{realm}/authentication/flows/{id}

更新身份验证流程

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

id
必需

null

主体参数

名称

描述

默认值

模式

AuthenticationFlowRepresentation
可选

AuthenticationFlowRepresentation

响应

代码

消息

数据类型

204

无内容

<<>>

POST /admin/realms/{realm}/authentication/flows

创建新的身份验证流程

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

主体参数

名称

描述

默认值

模式

AuthenticationFlowRepresentation
可选

AuthenticationFlowRepresentation

响应

代码

消息

数据类型

201

已创建

<<>>

GET /admin/realms/{realm}/authentication/form-action-providers

获取表单操作提供程序。返回表单操作提供程序的流。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[[AnyType]]

GET /admin/realms/{realm}/authentication/form-providers

获取表单提供程序。返回表单提供程序的流。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[[AnyType]]

GET /admin/realms/{realm}/authentication/per-client-config-description

获取所有客户端的配置描述

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

Map[ConfigPropertyRepresentation]

POST /admin/realms/{realm}/authentication/register-required-action

注册新的必需操作

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

主体参数

名称

描述

默认值

模式

请求体
可选

RequiredActionConfigInfoRepresentation

响应

代码

消息

数据类型

204

无内容

<<>>

DELETE /admin/realms/{realm}/authentication/required-actions/{alias}/config

删除必需操作配置

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

alias
必需

必需操作的别名

null

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/authentication/required-actions/{alias}/config-description

获取必需操作提供程序配置描述

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

alias
必需

必需操作的别名

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/authentication/required-actions/{alias}/config

获取必需操作配置

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

alias
必需

必需操作的别名

null

内容类型

application/json

响应

代码

消息

数据类型

200

RequiredActionConfigRepresentation

PUT /admin/realms/{realm}/authentication/required-actions/{alias}/config

更新必需操作配置

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

alias
必需

必需操作的别名

null

主体参数

名称

描述

默认值

模式

RequiredActionConfigRepresentation
可选

RequiredActionConfigRepresentation

响应

代码

消息

数据类型

204

无内容

<<>>

DELETE /admin/realms/{realm}/authentication/required-actions/{alias}

删除必需操作

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

alias
必需

必需操作的别名

null

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/authentication/required-actions/{alias}

获取别名的必需操作

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

alias
必需

必需操作的别名

null

内容类型

application/json

响应

代码

消息

数据类型

200

RequiredActionProviderRepresentation

POST /admin/realms/{realm}/authentication/required-actions/{alias}/lower-priority

降低必需操作的优先级

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

alias
必需

必需操作的别名

null

响应

代码

消息

数据类型

204

无内容

<<>>

PUT /admin/realms/{realm}/authentication/required-actions/{alias}

更新必需操作

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

alias
必需

必需操作的别名

null

主体参数

名称

描述

默认值

模式

RequiredActionProviderRepresentation
可选

RequiredActionProviderRepresentation

响应

代码

消息

数据类型

204

无内容

<<>>

POST /admin/realms/{realm}/authentication/required-actions/{alias}/raise-priority

提高必需操作的优先级

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

alias
必需

必需操作的别名

null

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/authentication/required-actions

获取必需的操作。返回必需操作的流。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[RequiredActionProviderRepresentation]

GET /admin/realms/{realm}/authentication/unregistered-required-actions

获取未注册的必需操作。返回未注册的必需操作的流。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[[string]]

客户端属性证书

POST /admin/realms/{realm}/clients/{client-uuid}/certificates/{attr}/download

获取客户端的密钥库文件，包含私钥和公钥证书。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

attr
必需

null

主体参数

名称

描述

默认值

模式

KeyStoreConfig
可选

KeyStoreConfig

内容类型

application/octet-stream

响应

代码

消息

数据类型

200

[File]

POST /admin/realms/{realm}/clients/{client-uuid}/certificates/{attr}/generate-and-download

生成新的密钥对和证书，并获取私钥文件。生成密钥对和证书，并在指定的密钥库格式中提供私钥。只有生成的公钥证书保存在 Keycloak 数据库中 - 私钥不保存。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

attr
必需

null

主体参数

名称

描述

默认值

模式

KeyStoreConfig
可选

KeyStoreConfig

内容类型

application/octet-stream

响应

代码

消息

数据类型

200

[File]

POST /admin/realms/{realm}/clients/{client-uuid}/certificates/{attr}/generate

使用新的密钥对生成新的证书

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

attr
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/clients/{client-uuid}/certificates/{attr}

获取密钥信息

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

attr
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

POST /admin/realms/{realm}/clients/{client-uuid}/certificates/{attr}/upload-certificate

仅上传证书，不上传私钥

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

attr
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

POST /admin/realms/{realm}/clients/{client-uuid}/certificates/{attr}/upload

上传证书和私钥

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

attr
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

ClientInitialAccessCreatePresentation

客户端初始访问

GET /admin/realms/{realm}/clients-initial-access

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[ClientInitialAccessPresentation]

DELETE /admin/realms/{realm}/clients-initial-access/{id}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

id
必需

null

响应

代码

消息

数据类型

204

无内容

<<>>

POST /admin/realms/{realm}/clients-initial-access

创建新的初始访问令牌。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

主体参数

名称

描述

默认值

模式

ClientInitialAccessCreatePresentation
可选

内容类型

application/json

响应

代码

消息

数据类型

201

已创建

ClientInitialAccessCreatePresentation

客户端注册策略

GET /admin/realms/{realm}/client-registration-policy/providers

用于检索配置属性已正确填充的提供程序的基路径。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[ComponentTypeRepresentation]

客户端角色映射

GET /admin/realms/{realm}/groups/{group-id}/role-mappings/clients/{client-id}/available

获取可以映射到用户或组的可用客户端级角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

group-id
必需

null

client-id
必需

客户端 ID（不是 clientId！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/groups/{group-id}/role-mappings/clients/{client-id}/composite

获取有效的客户端级角色映射。这会递归任何复合角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

group-id
必需

null

client-id
必需

客户端 ID（不是 clientId！）

null

查询参数

名称

描述

默认值

模式

briefRepresentation
可选

如果为 false，则返回具有其属性的角色。

true

内容类型

application/json

响应

代码

消息

数据类型

200

DELETE /admin/realms/{realm}/groups/{group-id}/role-mappings/clients/{client-id}

从用户或组角色映射中删除客户端级角色

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

group-id
必需

null

client-id
必需

客户端 ID（不是 clientId！）

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/groups/{group-id}/role-mappings/clients/{client-id}

获取用户或组以及应用程序的客户端级角色映射

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

group-id
必需

null

client-id
必需

客户端 ID（不是 clientId！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

POST /admin/realms/{realm}/groups/{group-id}/role-mappings/clients/{client-id}

向用户或组角色映射添加客户端级角色

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

group-id
必需

null

client-id
必需

客户端 ID（不是 clientId！）

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/users/{user-id}/role-mappings/clients/{client-id}/available

获取可以映射到用户或组的可用客户端级角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

client-id
必需

客户端 ID（不是 clientId！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/users/{user-id}/role-mappings/clients/{client-id}/composite

获取有效的客户端级角色映射。这会递归任何复合角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

client-id
必需

客户端 ID（不是 clientId！）

null

查询参数

名称

描述

默认值

模式

briefRepresentation
可选

如果为 false，则返回具有其属性的角色。

true

内容类型

application/json

响应

代码

消息

数据类型

200

DELETE /admin/realms/{realm}/users/{user-id}/role-mappings/clients/{client-id}

从用户或组角色映射中删除客户端级角色

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

client-id
必需

客户端 ID（不是 clientId！）

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/users/{user-id}/role-mappings/clients/{client-id}

获取用户或组以及应用程序的客户端级角色映射

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

client-id
必需

客户端 ID（不是 clientId！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

POST /admin/realms/{realm}/users/{user-id}/role-mappings/clients/{client-id}

向用户或组角色映射添加客户端级角色

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

client-id
必需

客户端 ID（不是 clientId！）

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

客户端范围

DELETE /admin/realms/{realm}/client-scopes/{client-scope-id}

删除客户端范围

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/client-scopes/{client-scope-id}

获取客户端范围的表示

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

PUT /admin/realms/{realm}/client-scopes/{client-scope-id}

更新客户端范围

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

主体参数

名称

描述

默认值

模式

ClientScopeRepresentation
可选

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/client-scopes

获取属于 realm 的客户端范围返回属于 realm 的客户端范围列表

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

POST /admin/realms/{realm}/client-scopes

创建一个新的客户端范围客户端范围的名称必须是唯一的！

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

主体参数

名称

描述

默认值

模式

ClientScopeRepresentation
可选

响应

代码

消息

数据类型

200

<<>>

DELETE /admin/realms/{realm}/client-templates/{client-scope-id}

删除客户端范围

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/client-templates/{client-scope-id}

获取客户端范围的表示

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

PUT /admin/realms/{realm}/client-templates/{client-scope-id}

更新客户端范围

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

主体参数

名称

描述

默认值

模式

ClientScopeRepresentation
可选

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/client-templates

获取属于 realm 的客户端范围返回属于 realm 的客户端范围列表

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

POST /admin/realms/{realm}/client-templates

创建一个新的客户端范围客户端范围的名称必须是唯一的！

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

主体参数

名称

描述

默认值

模式

ClientScopeRepresentation
可选

响应

代码

消息

数据类型

200

<<>>

客户端

GET /admin/realms/{realm}/clients/{client-uuid}/client-secret

获取客户端密钥

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

POST /admin/realms/{realm}/clients/{client-uuid}/client-secret

为客户端生成一个新的密钥

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

DELETE /admin/realms/{realm}/clients/{client-uuid}/client-secret/rotated

使客户端的旋转密钥失效

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/client-secret/rotated

获取旋转的客户端密钥

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

DELETE /admin/realms/{realm}/clients/{client-uuid}/default-client-scopes/{clientScopeId}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

clientScopeId
必需

null

响应

代码

消息

数据类型

204

无内容

<<>>

PUT /admin/realms/{realm}/clients/{client-uuid}/default-client-scopes/{clientScopeId}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

clientScopeId
必需

null

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/default-client-scopes

获取默认的客户端范围。只返回名称和 ID。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

DELETE /admin/realms/{realm}/clients/{client-uuid}

删除客户端

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/evaluate-scopes/generate-example-access-token

创建包含示例访问令牌有效载荷的 JSON

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

查询参数

名称

描述

默认值

模式

scope
可选

null

userId
可选

null

内容类型

application/json

响应

代码

消息

数据类型

200

访问令牌

GET /admin/realms/{realm}/clients/{client-uuid}/evaluate-scopes/generate-example-id-token

创建包含示例 ID 令牌有效载荷的 JSON

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

查询参数

名称

描述

默认值

模式

scope
可选

null

userId
可选

null

内容类型

application/json

响应

代码

消息

数据类型

200

IDToken

GET /admin/realms/{realm}/clients/{client-uuid}/evaluate-scopes/generate-example-userinfo

创建包含示例用户信息有效载荷的 JSON

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

查询参数

名称

描述

默认值

模式

scope
可选

null

userId
可选

null

内容类型

application/json

响应

代码

消息

数据类型

200

Map[<<>>]

GET /admin/realms/{realm}/clients/{client-uuid}/evaluate-scopes/protocol-mappers

返回所有协议映射器列表，这些映射器将在为特定客户端生成令牌时使用。

描述

这意味着直接分配给此客户端的协议映射器以及分配给此客户端所有客户端范围的协议映射器。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

查询参数

名称

描述

默认值

模式

scope
可选

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[ProtocolMapperEvaluationRepresentation]

GET /admin/realms/{realm}/clients/{client-uuid}/evaluate-scopes/scope-mappings/{roleContainerId}/granted

获取特定角色容器中所有角色的有效范围映射，该客户端实际上被允许在为其发行的访问令牌中拥有。

描述

这包含此客户端直接拥有的范围映射，以及授予与该客户端关联的所有客户端范围的范围映射。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

roleContainerId
必需

realm 名称或客户端 UUID

null

查询参数

名称

描述

默认值

模式

scope
可选

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/clients/{client-uuid}/evaluate-scopes/scope-mappings/{roleContainerId}/not-granted

获取此客户端没有范围的角色，并且不能在为其发行的访问令牌中拥有这些范围。

描述

实际上，特定角色容器中所有其他角色，这些角色不在 {@link #getGrantedScopeMappings()}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

roleContainerId
必需

realm 名称或客户端 UUID

null

查询参数

名称

描述

默认值

模式

scope
可选

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/clients/{client-uuid}

获取客户端的表示

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/clients/{client-uuid}/installation/providers/{providerId}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

providerId
必需

null

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/management/permissions

返回一个对象，该对象说明客户端授权权限是否已初始化，以及一个引用

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

PUT /admin/realms/{realm}/clients/{client-uuid}/management/permissions

返回一个对象，该对象说明客户端授权权限是否已初始化，以及一个引用

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

主体参数

名称

描述

默认值

模式

ManagementPermissionReference
可选

内容类型

application/json

响应

代码

消息

数据类型

200

DELETE /admin/realms/{realm}/clients/{client-uuid}/nodes/{node}

从客户端注销集群节点

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

node
必需

null

响应

代码

消息

数据类型

204

无内容

<<>>

POST /admin/realms/{realm}/clients/{client-uuid}/nodes

向客户端注册集群节点手动将集群节点注册到此客户端 - 通常不需要直接调用此方法，因为适配器应该通过向 Keycloak 发送注册请求来处理。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

主体参数

名称

描述

默认值

模式

请求体
可选

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/offline-session-count

获取应用程序脱机会话计数返回与该客户端关联的脱机用户会话数量 { "count": number }

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

Map[[long]]

GET /admin/realms/{realm}/clients/{client-uuid}/offline-sessions

获取客户端的脱机会话返回与该客户端关联的脱机用户会话列表

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

查询参数

名称

描述

默认值

模式

first
可选

分页偏移量

null

max
可选

最大结果大小（默认值为 100）

null

内容类型

application/json

响应

代码

消息

数据类型

200

DELETE /admin/realms/{realm}/clients/{client-uuid}/optional-client-scopes/{clientScopeId}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

clientScopeId
必需

null

响应

代码

消息

数据类型

204

无内容

<<>>

PUT /admin/realms/{realm}/clients/{client-uuid}/optional-client-scopes/{clientScopeId}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

clientScopeId
必需

null

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/optional-client-scopes

获取可选的客户端范围。只返回名称和 ID。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

POST /admin/realms/{realm}/clients/{client-uuid}/push-revocation

将客户端的撤销策略推送到其管理 URL 如果客户端具有管理 URL，则将撤销策略推送到该 URL。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

PUT /admin/realms/{realm}/clients/{client-uuid}

更新客户端

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

主体参数

名称

描述

默认值

模式

ClientRepresentation
可选

响应

代码

消息

数据类型

200

<<>>

POST /admin/realms/{realm}/clients/{client-uuid}/registration-access-token

为客户端生成一个新的注册访问令牌

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/clients/{client-uuid}/service-account-user

获取专用于服务帐户的用户

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/clients/{client-uuid}/session-count

获取应用程序会话计数返回与该客户端关联的用户会话数量 { "count": number }

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

Map[[long]]

GET /admin/realms/{realm}/clients/{client-uuid}/test-nodes-available

测试注册的集群节点是否可用通过向所有集群节点发送“ping”请求来测试可用性。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/clients/{client-uuid}/user-sessions

获取客户端的用户会话返回与该客户端关联的用户会话列表

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

查询参数

名称

描述

默认值

模式

first
可选

分页偏移量

null

max
可选

最大结果大小（默认值为 100）

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/clients

获取属于 realm 的客户端。

描述

如果由于底层存储存在问题，无法从存储中检索客户端，则会将其从返回的列表中静默删除。这确保了对列表的并发修改不会阻止调用者检索此列表。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

查询参数

名称

描述

默认值

模式

clientId
可选

按 clientId 过滤

null

first
可选

第一个结果

null

max
可选

要返回的最大结果数

null

q
可选

null

搜索
可选

这是否是搜索查询还是 getClientById 查询

false

viewableOnly
可选

过滤管理员无法完全查看的客户端

false

内容类型

application/json

响应

代码

消息

数据类型

200

List[ClientRepresentation]

POST /admin/realms/{realm}/clients

创建一个新的客户端客户端的 client_id 必须是唯一的！

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

主体参数

名称

描述

默认值

模式

ClientRepresentation
可选

响应

代码

消息

数据类型

201

已创建

<<>>

组件

GET /admin/realms/{realm}/components

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

查询参数

名称

描述

默认值

模式

name
可选

null

parent
可选

null

type
可选

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[ComponentRepresentation]

DELETE /admin/realms/{realm}/components/{id}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

id
必需

null

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/components/{id}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

ComponentRepresentation

PUT /admin/realms/{realm}/components/{id}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

id
必需

null

主体参数

名称

描述

默认值

模式

ComponentRepresentation
可选

ComponentRepresentation

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/components/{id}/sub-component-types

可用于为特定父组件配置的子组件类型列表。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

id
必需

null

查询参数

名称

描述

默认值

模式

type
可选

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[ComponentTypeRepresentation]

POST /admin/realms/{realm}/components

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

主体参数

名称

描述

默认值

模式

ComponentRepresentation
可选

ComponentRepresentation

响应

代码

消息

数据类型

200

<<>>

默认

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

POST /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/import

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

主体参数

名称

描述

默认值

模式

ResourceServerRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

POST /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/permission/evaluate

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

主体参数

名称

描述

默认值

模式

PolicyEvaluationRequest
可选

PolicyEvaluationRequest

内容类型

application/json

响应

代码

消息

数据类型

200

PolicyEvaluationResponse

500

内部服务器错误

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/permission

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

查询参数

名称

描述

默认值

模式

fields
可选

null

first
可选

null

max
可选

null

name
可选

null

owner
可选

null

permission
可选

null

policyId
可选

null

resource
可选

null

scope
可选

null

type
可选

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[AbstractPolicyRepresentation]

204

无内容

<<>>

POST /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/permission

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

主体参数

名称

描述

默认值

模式

body
可选

AbstractPolicyRepresentation

响应

代码

消息

数据类型

201

已创建

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/permission/providers

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[PolicyProviderRepresentation]

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/permission/search

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

查询参数

名称

描述

默认值

模式

fields
可选

null

name
可选

null

内容类型

application/json

响应

代码

消息

数据类型

200

204

无内容

<<>>

400

错误请求

<<>>

POST /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/policy/evaluate

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

主体参数

名称

描述

默认值

模式

PolicyEvaluationRequest
可选

PolicyEvaluationRequest

内容类型

application/json

响应

代码

消息

数据类型

200

PolicyEvaluationResponse

500

内部服务器错误

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/policy

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

查询参数

名称

描述

默认值

模式

fields
可选

null

first
可选

null

max
可选

null

name
可选

null

owner
可选

null

permission
可选

null

policyId
可选

null

resource
可选

null

scope
可选

null

type
可选

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[AbstractPolicyRepresentation]

204

无内容

<<>>

POST /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/policy

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

主体参数

名称

描述

默认值

模式

body
可选

AbstractPolicyRepresentation

响应

代码

消息

数据类型

201

已创建

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/policy/providers

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[PolicyProviderRepresentation]

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/policy/search

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

查询参数

名称

描述

默认值

模式

fields
可选

null

name
可选

null

内容类型

application/json

响应

代码

消息

数据类型

200

204

无内容

<<>>

400

错误请求

<<>>

PUT /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

主体参数

名称

描述

默认值

模式

ResourceServerRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/resource

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

查询参数

名称

描述

默认值

模式

id
_optional

null

deep
可选

null

exactName
可选

null

first
可选

null

matchingUri
可选

null

max
可选

null

name
可选

null

owner
可选

null

scope
可选

null

type
可选

null

uri
可选

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[ResourceRepresentation]

POST /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/resource

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

主体参数

名称

描述

默认值

模式

ResourceRepresentation
可选

查询参数

名称

描述

默认值

模式

id
_optional

null

deep
可选

null

exactName
可选

null

first
可选

null

matchingUri
可选

null

max
可选

null

name
可选

null

owner
可选

null

scope
可选

null

type
可选

null

uri
可选

null

内容类型

application/json

响应

代码

消息

数据类型

201

已创建

400

错误请求

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/resource/{resource-id}/attributes

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

resource-id
必需

null

查询参数

名称

描述

默认值

模式

id
_optional

null

deep
可选

null

exactName
可选

null

first
可选

null

matchingUri
可选

null

max
可选

null

name
可选

null

owner
可选

null

scope
可选

null

type
可选

null

uri
可选

null

响应

代码

消息

数据类型

200

<<>>

DELETE /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/resource/{resource-id}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

resource-id
必需

null

查询参数

名称

描述

默认值

模式

id
_optional

null

deep
可选

null

exactName
可选

null

first
可选

null

matchingUri
可选

null

max
可选

null

name
可选

null

owner
可选

null

scope
可选

null

type
可选

null

uri
可选

null

响应

代码

消息

数据类型

204

无内容

<<>>

404

未找到

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/resource/{resource-id}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

resource-id
必需

null

查询参数

名称

描述

默认值

模式

id
_optional

null

deep
可选

null

exactName
可选

null

first
可选

null

matchingUri
可选

null

max
可选

null

name
可选

null

owner
可选

null

scope
可选

null

type
可选

null

uri
可选

null

内容类型

application/json

响应

代码

消息

数据类型

200

404

未找到

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/resource/{resource-id}/permissions

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

resource-id
必需

null

查询参数

名称

描述

默认值

模式

id
_optional

null

deep
可选

null

exactName
可选

null

first
可选

null

matchingUri
可选

null

max
可选

null

name
可选

null

owner
可选

null

scope
可选

null

type
可选

null

uri
可选

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[PolicyRepresentation]

404

未找到

<<>>

PUT /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/resource/{resource-id}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

resource-id
必需

null

主体参数

名称

描述

默认值

模式

ResourceRepresentation
可选

查询参数

名称

描述

默认值

模式

id
_optional

null

deep
可选

null

exactName
可选

null

first
可选

null

matchingUri
可选

null

max
可选

null

name
可选

null

owner
可选

null

scope
可选

null

type
可选

null

uri
可选

null

响应

代码

消息

数据类型

204

无内容

<<>>

404

未找到

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/resource/{resource-id}/scopes

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

resource-id
必需

null

查询参数

名称

描述

默认值

模式

id
_optional

null

deep
可选

null

exactName
可选

null

first
可选

null

matchingUri
可选

null

max
可选

null

name
可选

null

owner
可选

null

scope
可选

null

type
可选

null

uri
可选

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[ScopeRepresentation]

404

未找到

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/resource/search

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

查询参数

名称

描述

默认值

模式

id
_optional

null

deep
可选

null

exactName
可选

null

first
可选

null

matchingUri
可选

null

max
可选

null

owner
可选

null

scope
可选

null

type
可选

null

uri
可选

null

name
可选

null

内容类型

application/json

响应

代码

消息

数据类型

200

400

错误请求

<<>>

204

无内容

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/scope

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

查询参数

名称

描述

默认值

模式

first
可选

null

max
可选

null

name
可选

null

scopeId
可选

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[ScopeRepresentation]

POST /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/scope

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

主体参数

名称

描述

默认值

模式

ScopeRepresentation
可选

ScopeRepresentation

响应

代码

消息

数据类型

200

<<>>

DELETE /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/scope/{scope-id}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

scope-id
必需

null

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/scope/{scope-id}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

scope-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

ScopeRepresentation

404

未找到

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/scope/{scope-id}/permissions

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

scope-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[PolicyRepresentation]

404

未找到

<<>>

PUT /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/scope/{scope-id}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

scope-id
必需

null

主体参数

名称

描述

默认值

模式

ScopeRepresentation
可选

ScopeRepresentation

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/scope/{scope-id}/resources

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

scope-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[ResourceRepresentation]

404

未找到

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/scope/search

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

查询参数

名称

描述

默认值

模式

name
可选

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[ScopeRepresentation]

204

无内容

<<>>

400

错误请求

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/settings

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

组

GET /admin/realms/{realm}/groups/count

返回组计数。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

查询参数

名称

描述

默认值

模式

搜索
可选

null

top
可选

false

内容类型

application/json

响应

代码

消息

数据类型

200

Map[[long]]

GET /admin/realms/{realm}/groups

获取组层次结构。只返回名称和 ID。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

查询参数

名称

描述

默认值

模式

briefRepresentation
可选

true

exact
可选

false

first
可选

null

max
可选

null

populateHierarchy
可选

true

q
可选

null

搜索
可选

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/groups/{group-id}/children

返回一个分页的子组列表，这些子组具有与 URL 上的组相对应的父组

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

group-id
必需

null

查询参数

名称

描述

默认值

模式

briefRepresentation
可选

布尔值，定义是否返回简短的组表示（默认值：false）

false

exact
可选

布尔值，定义参数“search”是否必须完全匹配

null

first
可选

要返回的第一个结果的位置（分页偏移量）。

null

max
可选

要返回的最大结果数。默认值为 10

null

搜索
可选

一个字符串，表示一个精确的组名称或一个部分名称

null

内容类型

application/json

响应

代码

消息

数据类型

200

POST /admin/realms/{realm}/groups/{group-id}/children

设置或创建子级。

描述

这只会设置父级（如果存在）。创建它并设置父级（如果组不存在）。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

group-id
必需

null

主体参数

名称

描述

默认值

模式

GroupRepresentation
可选

响应

代码

消息

数据类型

200

<<>>

DELETE /admin/realms/{realm}/groups/{group-id}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

group-id
必需

null

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/groups/{group-id}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

group-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/groups/{group-id}/management/permissions

返回一个对象，该对象说明客户端授权权限是否已初始化，以及一个引用

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

group-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

PUT /admin/realms/{realm}/groups/{group-id}/management/permissions

返回一个对象，该对象说明客户端授权权限是否已初始化，以及一个引用

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

group-id
必需

null

主体参数

名称

描述

默认值

模式

ManagementPermissionReference
可选

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/groups/{group-id}/members

获取用户返回用户流，根据查询参数进行过滤

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

group-id
必需

null

查询参数

名称

描述

默认值

模式

briefRepresentation
可选

只返回基本信息（仅保证返回 ID、用户名、创建日期、姓氏和名字、电子邮件、启用状态、电子邮件验证状态、联合链接和访问权限。请注意，这意味着具体而言，用户属性、所需操作和 not before 不会返回。）

null

first
可选

分页偏移量

null

max
可选

最大结果大小（默认值为 100）

null

内容类型

application/json

响应

代码

消息

数据类型

200

PUT /admin/realms/{realm}/groups/{group-id}

更新组，忽略子组。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

group-id
必需

null

主体参数

名称

描述

默认值

模式

GroupRepresentation
可选

响应

代码

消息

数据类型

200

<<>>

POST /admin/realms/{realm}/groups

创建或添加一个顶级 realm 组设置或创建子级。

描述

这将更新组，如果组存在，则设置父组。创建它并设置父组（如果组不存在）。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

主体参数

名称

描述

默认值

模式

GroupRepresentation
可选

响应

代码

消息

数据类型

200

<<>>

身份提供者

POST /admin/realms/{realm}/identity-provider/import-config

从 JSON 主体导入身份提供者

描述

从上传的 JSON 文件导入身份提供者

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

主体参数

名称

描述

默认值

模式

请求体
可选

[AnyType]

内容类型

application/json

响应

代码

消息

数据类型

200

Map[[string]]

DELETE /admin/realms/{realm}/identity-provider/instances/{alias}

删除身份提供者

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

alias
必需

null

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/identity-provider/instances/{alias}/export

导出身份提供者的公共代理配置

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

alias
必需

null

查询参数

名称

描述

默认值

模式

format
可选

要使用的格式

null

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/identity-provider/instances/{alias}

获取身份提供者

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

alias
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/identity-provider/instances/{alias}/management/permissions

返回一个对象，该对象说明客户端授权权限是否已初始化，以及一个引用

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

alias
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

PUT /admin/realms/{realm}/identity-provider/instances/{alias}/management/permissions

返回一个对象，该对象说明客户端授权权限是否已初始化，以及一个引用

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

alias
必需

null

主体参数

名称

描述

默认值

模式

ManagementPermissionReference
可选

内容类型

application/json

响应

代码

消息

数据类型

200

IdentityProviderMapperRepresentation

GET /admin/realms/{realm}/identity-provider/instances/{alias}/mapper-types

获取身份提供者的映射器类型

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

alias
必需

null

内容类型

*/*

响应

代码

消息

数据类型

200

Map[IdentityProviderMapperTypeRepresentation]

GET /admin/realms/{realm}/identity-provider/instances/{alias}/mappers

获取身份提供者的映射器

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

alias
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[IdentityProviderMapperRepresentation]

DELETE /admin/realms/{realm}/identity-provider/instances/{alias}/mappers/{id}

删除身份提供者的映射器

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

alias
必需

null

id
必需

映射器 ID

null

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/identity-provider/instances/{alias}/mappers/{id}

按 ID 获取身份提供者的映射器

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

alias
必需

null

id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

PUT /admin/realms/{realm}/identity-provider/instances/{alias}/mappers/{id}

更新身份提供者的映射器

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

alias
必需

null

id
必需

映射器 ID

null

主体参数

名称

描述

默认值

模式

IdentityProviderMapperRepresentation
可选

IdentityProviderMapperRepresentation

响应

代码

消息

数据类型

204

无内容

<<>>

POST /admin/realms/{realm}/identity-provider/instances/{alias}/mappers

向身份提供者添加映射器

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

alias
必需

null

主体参数

名称

描述

默认值

模式

IdentityProviderMapperRepresentation
可选

IdentityProviderMapperRepresentation

响应

代码

消息

数据类型

200

<<>>

PUT /admin/realms/{realm}/identity-provider/instances/{alias}

更新身份提供者

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

alias
必需

null

主体参数

名称

描述

默认值

模式

IdentityProviderRepresentation
可选

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/identity-provider/instances/{alias}/reload-keys

如果提供者支持，则重新加载身份提供者的密钥，如果执行了重新加载，则返回“true”，否则返回“false”。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

alias
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

[Boolean]

GET /admin/realms/{realm}/identity-provider/instances

列出身份提供者

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

查询参数

名称

描述

默认值

模式

briefRepresentation
可选

布尔值，定义是否返回简要表示（默认：false）

null

first
可选

分页偏移量

null

max
可选

最大结果大小（默认值为 100）

null

realmOnly
可选

布尔值，定义是否仅返回 realm 级别的 IDP（与组织无关）（默认：false）

null

搜索
可选

按名称筛选特定提供者。搜索可以是前缀 (name*)、包含 (**name**) 或精确 ("name")。默认情况下为前缀。

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[IdentityProviderRepresentation]

POST /admin/realms/{realm}/identity-provider/instances

创建新的身份提供者

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

主体参数

名称

描述

默认值

模式

IdentityProviderRepresentation
可选

KeysMetadataRepresentation

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/identity-provider/providers/{provider_id}

获取该提供者 ID 的身份提供者工厂

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

provider_id
必需

要获取工厂的提供者 ID

null

内容类型

application/json

响应

代码

消息

数据类型

200

[Object]

密钥

GET /admin/realms/{realm}/keys

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

组织

GET /admin/realms/{realm}/organizations

返回根据指定参数过滤的组织的分页列表

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

查询参数

名称

描述

默认值

模式

exact
可选

布尔值，定义参数“search”是否必须完全匹配

null

first
可选

要处理的第一个结果的位置（分页偏移量）

null

max
可选

要返回的结果的最大数量 - 默认值为 10

null

q
可选

用于搜索自定义属性的查询，格式为“key1:value2 key2:value2”

null

搜索
可选

表示组织名称或域的字符串

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[OrganizationRepresentation]

DELETE /admin/realms/{realm}/organizations/{id}

删除组织

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

id
必需

null

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/organizations/{id}

返回组织表示

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

OrganizationRepresentation

DELETE /admin/realms/{realm}/organizations/{id}/identity-providers/{alias}

从组织中删除具有指定别名的身份提供者

描述

打破身份提供者和组织之间的关联。提供者本身不会被删除。如果找不到提供者，或者它当前未与组织关联，则返回错误响应

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

id
必需

null

alias
必需

null

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/organizations/{id}/identity-providers/{alias}

返回与具有指定别名的组织关联的身份提供者

描述

搜索具有给定别名的身份提供者。如果找到一个并与组织关联，则返回它。否则，返回状态为 NOT_FOUND 的错误响应

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

id
必需

null

alias
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/organizations/{id}/identity-providers

返回与组织关联的所有身份提供者

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[IdentityProviderRepresentation]

POST /admin/realms/{realm}/organizations/{id}/identity-providers

将具有指定 ID 的身份提供者添加到组织

描述

将现有身份提供者与组织添加或关联。如果找不到身份提供者，或者它已与组织关联，则返回错误响应

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

id
必需

null

主体参数

名称

描述

默认值

模式

body
可选

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/organizations/{id}/members/count

返回组织中成员的数量。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

[Long]

GET /admin/realms/{realm}/organizations/{id}/members

返回根据指定参数过滤的组织成员的分页列表

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

id
必需

null

查询参数

名称

描述

默认值

模式

exact
可选

布尔值，定义参数“search”是否必须完全匹配

null

first
可选

要处理的第一个结果的位置（分页偏移量）

null

max
可选

要返回的结果的最大数量。默认值为 10

null

搜索
可选

表示成员用户名、电子邮件、姓或名的字符串。

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[MemberRepresentation]

DELETE /admin/realms/{realm}/organizations/{id}/members/{id}

从组织中删除具有指定 ID 的用户

描述

打破用户和组织之间的关联。如果成员资格是受管理的，则用户本身会被删除，否则不会删除用户。如果找不到用户，或者他们不是组织的成员，则返回错误响应

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

id
必需

null

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/organizations/{id}/members/{id}

返回具有指定 ID 的组织成员

描述

搜索具有给定 ID 的用户。如果找到一个，并且当前是组织的成员，则返回它。否则，返回状态为 NOT_FOUND 的错误响应

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

MemberRepresentation

GET /admin/realms/{realm}/organizations/{id}/members/{id}/organizations

返回与具有指定 ID 的用户关联的组织

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[OrganizationRepresentation]

POST /admin/realms/{realm}/organizations/{id}/members/invite-existing-user

使用指定的用户 ID 将现有用户邀请到组织

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

id
必需

null

表单参数

名称

描述

默认值

模式

id
可选

null

响应

代码

消息

数据类型

200

<<>>

POST /admin/realms/{realm}/organizations/{id}/members/invite-user

邀请现有用户或根据提供的电子邮件地址向新用户发送注册链接。

描述

如果具有给定电子邮件地址的用户存在，则会发送邀请链接，否则会发送注册链接。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

id
必需

null

表单参数

名称

描述

默认值

模式

email
可选

null

firstName
可选

null

lastName
可选

null

响应

代码

消息

数据类型

200

<<>>

POST /admin/realms/{realm}/organizations/{id}/members

将具有指定 ID 的用户添加为组织的成员

描述

将现有用户添加或关联到组织。如果找不到用户，或者它已与组织关联，则返回错误响应

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

id
必需

null

主体参数

名称

描述

默认值

模式

body
可选

OrganizationRepresentation

响应

代码

消息

数据类型

200

<<>>

PUT /admin/realms/{realm}/organizations/{id}

更新组织

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

id
必需

null

主体参数

名称

描述

默认值

模式

OrganizationRepresentation
可选

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/organizations/members/{id}/organizations

返回与具有指定 ID 的用户关联的组织

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[OrganizationRepresentation]

POST /admin/realms/{realm}/organizations

创建新的组织

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

主体参数

名称

描述

默认值

模式

OrganizationRepresentation
可选

OrganizationRepresentation

响应

代码

消息

数据类型

200

<<>>

协议映射器

POST /admin/realms/{realm}/client-scopes/{client-scope-id}/protocol-mappers/add-models

创建多个映射器

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

主体参数

名称

描述

默认值

模式

ProtocolMapperRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/client-scopes/{client-scope-id}/protocol-mappers/models

获取映射器

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

DELETE /admin/realms/{realm}/client-scopes/{client-scope-id}/protocol-mappers/models/{id}

删除映射器

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

id
必需

映射器 ID

null

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/client-scopes/{client-scope-id}/protocol-mappers/models/{id}

按 ID 获取映射器

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

id
必需

映射器 ID

null

内容类型

application/json

响应

代码

消息

数据类型

200

PUT /admin/realms/{realm}/client-scopes/{client-scope-id}/protocol-mappers/models/{id}

更新映射器

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

id
必需

映射器 ID

null

主体参数

名称

描述

默认值

模式

ProtocolMapperRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

POST /admin/realms/{realm}/client-scopes/{client-scope-id}/protocol-mappers/models

创建映射器

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

主体参数

名称

描述

默认值

模式

ProtocolMapperRepresentation
可选

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/client-scopes/{client-scope-id}/protocol-mappers/protocol/{protocol}

按名称获取特定协议的映射器

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

protocol
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

POST /admin/realms/{realm}/client-templates/{client-scope-id}/protocol-mappers/add-models

创建多个映射器

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

主体参数

名称

描述

默认值

模式

ProtocolMapperRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/client-templates/{client-scope-id}/protocol-mappers/models

获取映射器

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

DELETE /admin/realms/{realm}/client-templates/{client-scope-id}/protocol-mappers/models/{id}

删除映射器

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

id
必需

映射器 ID

null

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/client-templates/{client-scope-id}/protocol-mappers/models/{id}

按 ID 获取映射器

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

id
必需

映射器 ID

null

内容类型

application/json

响应

代码

消息

数据类型

200

PUT /admin/realms/{realm}/client-templates/{client-scope-id}/protocol-mappers/models/{id}

更新映射器

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

id
必需

映射器 ID

null

主体参数

名称

描述

默认值

模式

ProtocolMapperRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

POST /admin/realms/{realm}/client-templates/{client-scope-id}/protocol-mappers/models

创建映射器

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

主体参数

名称

描述

默认值

模式

ProtocolMapperRepresentation
可选

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/client-templates/{client-scope-id}/protocol-mappers/protocol/{protocol}

按名称获取特定协议的映射器

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

protocol
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

POST /admin/realms/{realm}/clients/{client-uuid}/protocol-mappers/add-models

创建多个映射器

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

主体参数

名称

描述

默认值

模式

ProtocolMapperRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/protocol-mappers/models

获取映射器

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

DELETE /admin/realms/{realm}/clients/{client-uuid}/protocol-mappers/models/{id}

删除映射器

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

id
必需

映射器 ID

null

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/protocol-mappers/models/{id}

按 ID 获取映射器

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

id
必需

映射器 ID

null

内容类型

application/json

响应

代码

消息

数据类型

200

PUT /admin/realms/{realm}/clients/{client-uuid}/protocol-mappers/models/{id}

更新映射器

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

id
必需

映射器 ID

null

主体参数

名称

描述

默认值

模式

ProtocolMapperRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

POST /admin/realms/{realm}/clients/{client-uuid}/protocol-mappers/models

创建映射器

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

主体参数

名称

描述

默认值

模式

ProtocolMapperRepresentation
可选

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/protocol-mappers/protocol/{protocol}

按名称获取特定协议的映射器

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

protocol
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

领域管理员

GET /admin/realms

获取可访问的 realm 返回可访问的 realm 列表。列表根据调用者可以查看的 realm 进行过滤。

参数

查询参数

名称

描述

默认值

模式

briefRepresentation
可选

false

内容类型

application/json

响应

代码

消息

数据类型

200

List[RealmRepresentation]

POST /admin/realms

导入 realm。从该 realm 的完整表示中导入 realm。

描述

realm 名称必须唯一。

参数

主体参数

名称

描述

默认值

模式

body
可选

[file]

响应

代码

消息

数据类型

201

已创建

<<>>

DELETE /admin/realms/{realm}/admin-events

删除所有管理事件

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/admin-events

获取管理事件返回所有管理事件，或根据此处列出的 URL 查询参数筛选事件

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

查询参数

名称

描述

默认值

模式

authClient
可选

null

authIpAddress
可选

null

authRealm
可选

null

authUser
可选

用户 ID

null

dateFrom
可选

null

dateTo
可选

null

first
可选

null

max
可选

最大结果大小（默认值为 100）

null

operationTypes
可选

[String]

null

resourcePath
可选

null

resourceTypes
可选

[String]

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[AdminEventRepresentation]

POST /admin/realms/{realm}/client-description-converter

导入此 realm 下的客户端的基路径。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

主体参数

名称

描述

默认值

模式

body
可选

内容类型

application/json

响应

代码

消息

数据类型

200

ClientPoliciesRepresentation

GET /admin/realms/{realm}/client-policies/policies

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

查询参数

名称

描述

默认值

模式

include-global-policies
可选

null

内容类型

application/json

响应

代码

消息

数据类型

200

PUT /admin/realms/{realm}/client-policies/policies

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

主体参数

名称

描述

默认值

模式

ClientPoliciesRepresentation
可选

ClientPoliciesRepresentation

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/client-policies/profiles

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

查询参数

名称

描述

默认值

模式

include-global-profiles
可选

null

内容类型

application/json

响应

代码

消息

数据类型

200

ClientProfilesRepresentation

PUT /admin/realms/{realm}/client-policies/profiles

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

主体参数

名称

描述

默认值

模式

ClientProfilesRepresentation
可选

ClientProfilesRepresentation

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/client-session-stats

获取客户端会话统计信息返回 JSON 映射。

描述

键是客户端 ID，值是当前使用该客户端处于活动状态的会话数量。此映射中只包含实际具有与之关联的会话的客户端。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[[string]]

GET /admin/realms/{realm}/client-types

列出当前 realm 中可用的所有客户端类型

描述

此端点返回全局和 realm 级别客户端类型的列表以及它们设置的属性

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

ClientTypesRepresentation

PUT /admin/realms/{realm}/client-types

更新客户端类型

描述

此端点允许您更新 realm 级别客户端类型

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

主体参数

名称

描述

默认值

模式

ClientTypesRepresentation
可选

ClientTypesRepresentation

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/credential-registrators

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[[string]]

DELETE /admin/realms/{realm}/default-default-client-scopes/{clientScopeId}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

clientScopeId
必需

null

响应

代码

消息

数据类型

204

无内容

<<>>

PUT /admin/realms/{realm}/default-default-client-scopes/{clientScopeId}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

clientScopeId
必需

null

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/default-default-client-scopes

获取 realm 默认客户端范围。只返回名称和 ID。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/default-groups

获取组层次结构。只返回名称和 ID。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

DELETE /admin/realms/{realm}/default-groups/{groupId}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

groupId
必需

null

响应

代码

消息

数据类型

204

无内容

<<>>

PUT /admin/realms/{realm}/default-groups/{groupId}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

groupId
必需

null

响应

代码

消息

数据类型

204

无内容

<<>>

DELETE /admin/realms/{realm}/default-optional-client-scopes/{clientScopeId}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

clientScopeId
必需

null

响应

代码

消息

数据类型

204

无内容

<<>>

PUT /admin/realms/{realm}/default-optional-client-scopes/{clientScopeId}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

clientScopeId
必需

null

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/default-optional-client-scopes

获取 realm 可选客户端范围。只返回名称和 ID。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

RealmEventsConfigRepresentation

DELETE /admin/realms/{realm}

删除 realm

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/events/config

获取事件提供者配置返回包含事件提供者配置的 JSON 对象

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

PUT /admin/realms/{realm}/events/config

描述

更新事件提供者更改事件提供者及其配置

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

主体参数

名称

描述

默认值

模式

RealmEventsConfigRepresentation
可选

RealmEventsConfigRepresentation

响应

代码

消息

数据类型

204

无内容

<<>>

DELETE /admin/realms/{realm}/events

删除所有事件

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/events

获取事件返回所有事件，或根据此处列出的 URL 查询参数筛选事件

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

查询参数

名称

描述

默认值

模式

client
可选

应用或 oauth 客户端名称

null

dateFrom
可选

从日期

null

dateTo
可选

到日期

null

first
可选

分页偏移量

null

ipAddress
可选

IP 地址

null

max
可选

最大结果大小（默认值为 100）

null

type
可选

要返回的事件类型 [String]

null

user
可选

用户 ID

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[EventRepresentation]

GET /admin/realms/{realm}

获取 realm 的顶级表示它不会包含嵌套信息，例如用户和客户端表示。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

RealmRepresentation

GET /admin/realms/{realm}/group-by-path/{path}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

path
必需

null

/.*/

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/localization

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[[string]]

DELETE /admin/realms/{realm}/localization/{locale}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

locale
必需

null

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/localization/{locale}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

locale
必需

null

查询参数

名称

描述

默认值

模式

useRealmDefaultLocaleFallback
可选

null

内容类型

application/json

响应

代码

消息

数据类型

200

Map[[string]]

DELETE /admin/realms/{realm}/localization/{locale}/{key}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

key
必需

null

locale
必需

null

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/localization/{locale}/{key}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

key
必需

null

locale
必需

null

内容类型

text/plain

响应

代码

消息

数据类型

200

[String]

PUT /admin/realms/{realm}/localization/{locale}/{key}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

key
必需

null

locale
必需

null

主体参数

名称

描述

默认值

模式

body
可选

响应

代码

消息

数据类型

204

无内容

<<>>

POST /admin/realms/{realm}/localization/{locale}

从上传的 JSON 文件中导入本地化

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

locale
必需

null

主体参数

名称

描述

默认值

模式

请求体
可选

响应

代码

消息

数据类型

204

无内容

<<>>

POST /admin/realms/{realm}/logout-all

删除所有用户会话。

描述

任何具有管理 URL 的客户端也将被告知使他们拥有的任何会话失效。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

POST /admin/realms/{realm}/partial-export

将现有 realm 部分导出到 JSON 文件中。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

查询参数

名称

描述

默认值

模式

exportClients
可选

null

exportGroupsAndRoles
可选

null

响应

代码

消息

数据类型

200

<<>>

POST /admin/realms/{realm}/partialImport

从 JSON 文件部分导入到现有 realm 中。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

主体参数

名称

描述

默认值

模式

body
可选

[file]

响应

代码

消息

数据类型

200

<<>>

POST /admin/realms/{realm}/push-revocation

将领域的撤销策略推送到任何与之关联的管理员 URL 的客户端。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

PUT /admin/realms/{realm}

更新领域的顶级信息。表示中的任何用户、角色或客户端信息将被忽略。

描述

这只会更新领域的顶级属性。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

主体参数

名称

描述

默认值

模式

RealmRepresentation
可选

RealmRepresentation

响应

代码

消息

数据类型

200

<<>>

DELETE /admin/realms/{realm}/sessions/{session}

删除特定的用户会话。

描述

任何具有管理员 URL 的客户端也会被告知使此特定会话失效。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

session
必需

null

查询参数

名称

描述

默认值

模式

isOffline
可选

false

响应

代码

消息

数据类型

204

无内容

<<>>

POST /admin/realms/{realm}/testSMTPConnection

使用当前登录的用户测试 SMTP 连接。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

主体参数

名称

描述

默认值

模式

请求体
可选

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/users-management-permissions

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

PUT /admin/realms/{realm}/users-management-permissions

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

主体参数

名称

描述

默认值

模式

ManagementPermissionReference
可选

内容类型

application/json

响应

代码

消息

数据类型

200

角色映射器

GET /admin/realms/{realm}/groups/{group-id}/role-mappings

获取角色映射。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

group-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/groups/{group-id}/role-mappings/realm/available

获取可以映射的领域级角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

group-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/groups/{group-id}/role-mappings/realm/composite

获取有效的领域级角色映射。这将递归所有复合角色以获取结果。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

group-id
必需

null

查询参数

名称

描述

默认值

模式

briefRepresentation
可选

如果为 false，则返回具有其属性的角色。

true

内容类型

application/json

响应

代码

消息

数据类型

200

DELETE /admin/realms/{realm}/groups/{group-id}/role-mappings/realm

删除领域级角色映射。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

group-id
必需

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/groups/{group-id}/role-mappings/realm

获取领域级角色映射。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

group-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

POST /admin/realms/{realm}/groups/{group-id}/role-mappings/realm

将领域级角色映射添加到用户。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

group-id
必需

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/users/{user-id}/role-mappings

获取角色映射。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/users/{user-id}/role-mappings/realm/available

获取可以映射的领域级角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/users/{user-id}/role-mappings/realm/composite

获取有效的领域级角色映射。这将递归所有复合角色以获取结果。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

查询参数

名称

描述

默认值

模式

briefRepresentation
可选

如果为 false，则返回具有其属性的角色。

true

内容类型

application/json

响应

代码

消息

数据类型

200

DELETE /admin/realms/{realm}/users/{user-id}/role-mappings/realm

删除领域级角色映射。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/users/{user-id}/role-mappings/realm

获取领域级角色映射。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

POST /admin/realms/{realm}/users/{user-id}/role-mappings/realm

将领域级角色映射添加到用户。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

角色

GET /admin/realms/{realm}/clients/{client-uuid}/roles

获取领域或客户端的所有角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

查询参数

名称

描述

默认值

模式

briefRepresentation
可选

true

first
可选

null

max
可选

null

搜索
可选

内容类型

application/json

响应

代码

消息

数据类型

200

POST /admin/realms/{realm}/clients/{client-uuid}/roles

为领域或客户端创建新角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}/composites/clients/{client-uuid}

获取客户端级角色，这些角色在角色的复合角色中。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

null

role-name
必需

角色名称（不是 ID！）。

null

内容类型

application/json

响应

代码

消息

数据类型

200

DELETE /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}/composites

从角色的复合角色中删除角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

role-name
必需

角色名称（不是 ID！）。

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}/composites

获取角色的复合角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

role-name
必需

角色名称（不是 ID！）。

null

内容类型

application/json

响应

代码

消息

数据类型

200

POST /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}/composites

向角色添加复合角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

role-name
必需

角色名称（不是 ID！）。

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}/composites/realm

获取角色的复合角色的领域级角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

role-name
必需

角色名称（不是 ID！）。

null

内容类型

application/json

响应

代码

消息

数据类型

200

DELETE /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}

按名称删除角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

role-name
必需

角色名称（不是 ID！）。

null

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}

按名称获取角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

role-name
必需

角色名称（不是 ID！）。

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}/groups

返回具有指定角色名称的组流。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

role-name
必需

角色名称。

null

查询参数

名称

描述

默认值

模式

briefRepresentation
可选

如果为 false，则返回 {@code GroupRepresentation} 对象的完整表示。

true

first
可选

要返回的第一个结果。如果为负数或 {@code null}，则忽略。

null

max
可选

要返回的最大结果数。如果为负数或 {@code null}，则忽略。

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}/management/permissions

返回一个对象，说明角色授权权限是否已初始化以及参考

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

role-name
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

PUT /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}/management/permissions

返回一个对象，说明角色授权权限是否已初始化以及参考

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

role-name
必需

null

主体参数

名称

描述

默认值

模式

ManagementPermissionReference
可选

内容类型

application/json

响应

代码

消息

数据类型

200

PUT /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}

按名称更新角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

role-name
必需

角色名称（不是 ID！）。

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}/users

返回具有指定角色名称的用户流。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

role-name
必需

角色名称。

null

查询参数

名称

描述

默认值

模式

briefRepresentation
可选

布尔值，定义是否返回简要表示（默认：false）

null

first
可选

要返回的第一个结果。如果为负数或 {@code null}，则忽略。

null

max
可选

要返回的最大结果数。如果为负数或 {@code null}，则忽略。

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/roles

获取领域或客户端的所有角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

查询参数

名称

描述

默认值

模式

briefRepresentation
可选

true

first
可选

null

max
可选

null

搜索
可选

内容类型

application/json

响应

代码

消息

数据类型

200

POST /admin/realms/{realm}/roles

为领域或客户端创建新角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/roles/{role-name}/composites/clients/{client-uuid}

获取客户端级角色，这些角色在角色的复合角色中。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

null

role-name
必需

角色名称（不是 ID！）。

null

内容类型

application/json

响应

代码

消息

数据类型

200

DELETE /admin/realms/{realm}/roles/{role-name}/composites

从角色的复合角色中删除角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

role-name
必需

角色名称（不是 ID！）。

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/roles/{role-name}/composites

获取角色的复合角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

role-name
必需

角色名称（不是 ID！）。

null

内容类型

application/json

响应

代码

消息

数据类型

200

POST /admin/realms/{realm}/roles/{role-name}/composites

向角色添加复合角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

role-name
必需

角色名称（不是 ID！）。

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/roles/{role-name}/composites/realm

获取角色的复合角色的领域级角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

role-name
必需

角色名称（不是 ID！）。

null

内容类型

application/json

响应

代码

消息

数据类型

200

DELETE /admin/realms/{realm}/roles/{role-name}

按名称删除角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

role-name
必需

角色名称（不是 ID！）。

null

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/roles/{role-name}

按名称获取角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

role-name
必需

角色名称（不是 ID！）。

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/roles/{role-name}/groups

返回具有指定角色名称的组流。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

role-name
必需

角色名称。

null

查询参数

名称

描述

默认值

模式

briefRepresentation
可选

如果为 false，则返回 {@code GroupRepresentation} 对象的完整表示。

true

first
可选

要返回的第一个结果。如果为负数或 {@code null}，则忽略。

null

max
可选

要返回的最大结果数。如果为负数或 {@code null}，则忽略。

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/roles/{role-name}/management/permissions

返回一个对象，说明角色授权权限是否已初始化以及参考

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

role-name
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

PUT /admin/realms/{realm}/roles/{role-name}/management/permissions

返回一个对象，说明角色授权权限是否已初始化以及参考

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

role-name
必需

null

主体参数

名称

描述

默认值

模式

ManagementPermissionReference
可选

内容类型

application/json

响应

代码

消息

数据类型

200

PUT /admin/realms/{realm}/roles/{role-name}

按名称更新角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

role-name
必需

角色名称（不是 ID！）。

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/roles/{role-name}/users

返回具有指定角色名称的用户流。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

role-name
必需

角色名称。

null

查询参数

名称

描述

默认值

模式

briefRepresentation
可选

布尔值，定义是否返回简要表示（默认：false）

null

first
可选

要返回的第一个结果。如果为负数或 {@code null}，则忽略。

null

max
可选

要返回的最大结果数。如果为负数或 {@code null}，则忽略。

null

内容类型

application/json

响应

代码

消息

数据类型

200

角色（按 ID）

GET /admin/realms/{realm}/roles-by-id/{role-id}/composites/clients/{clientUuid}

获取客户端级角色，这些角色在角色的复合角色中。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

clientUuid
必需

null

role-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

DELETE /admin/realms/{realm}/roles-by-id/{role-id}/composites

从角色的复合角色中删除一组角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

role-id
必需

角色 ID

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/roles-by-id/{role-id}/composites

获取角色的子级。如果角色是复合角色，则返回一组角色的子级。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

role-id
必需

null

查询参数

名称

描述

默认值

模式

first
可选

null

max
可选

null

搜索
可选

null

内容类型

application/json

响应

代码

消息

数据类型

200

POST /admin/realms/{realm}/roles-by-id/{role-id}/composites

通过关联一些子角色来使角色成为复合角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

role-id
必需

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/roles-by-id/{role-id}/composites/realm

获取角色的复合角色中的领域级角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

role-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

DELETE /admin/realms/{realm}/roles-by-id/{role-id}

删除角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

role-id
必需

角色的 ID。

null

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/roles-by-id/{role-id}

获取特定角色的表示。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

role-id
必需

角色的 ID。

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/roles-by-id/{role-id}/management/permissions

返回一个对象，说明角色授权权限是否已初始化以及参考

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

role-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

PUT /admin/realms/{realm}/roles-by-id/{role-id}/management/permissions

返回一个对象，说明角色授权权限是否已初始化以及参考

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

role-id
必需

null

主体参数

名称

描述

默认值

模式

ManagementPermissionReference
可选

内容类型

application/json

响应

代码

消息

数据类型

200

PUT /admin/realms/{realm}/roles-by-id/{role-id}

更新角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

role-id
必需

角色的 ID。

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

范围映射

GET /admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/clients/{client}/available

可用的客户端级角色。返回可以与客户端范围关联的客户端的角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

client
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/clients/{client}/composite

获取有效的客户端角色。返回与客户端范围关联的客户端的角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

client
必需

null

查询参数

名称

描述

默认值

模式

briefRepresentation
可选

如果为 false，则返回具有其属性的角色。

true

内容类型

application/json

响应

代码

消息

数据类型

200

DELETE /admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/clients/{client}

从客户端范围中删除客户端级角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

client
必需

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/clients/{client}

获取与客户端范围关联的角色。返回客户端的角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

client
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

POST /admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/clients/{client}

向客户端范围添加客户端级角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

client
必需

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings

获取客户端的所有范围映射。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/realm/available

获取可用于附加到此客户端范围的领域级角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/realm/composite

获取与客户端范围关联的有效的领域级角色。此操作将递归与客户端范围关联的任何复合角色并将角色添加到此列表中。

描述

此方法实际上是为了显示与客户端关联的领域级角色的全面总视图。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

查询参数

名称

描述

默认值

模式

briefRepresentation
可选

如果为 false，则返回具有其属性的角色。

true

内容类型

application/json

响应

代码

消息

数据类型

200

DELETE /admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/realm

从客户端范围中删除一组领域级角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/realm

获取与客户端范围关联的领域级角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

POST /admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/realm

向客户端范围添加一组领域级角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/clients/{client}/available

可用的客户端级角色。返回可以与客户端范围关联的客户端的角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

client
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/clients/{client}/composite

获取有效的客户端角色。返回与客户端范围关联的客户端的角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

client
必需

null

查询参数

名称

描述

默认值

模式

briefRepresentation
可选

如果为 false，则返回具有其属性的角色。

true

内容类型

application/json

响应

代码

消息

数据类型

200

DELETE /admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/clients/{client}

从客户端范围中删除客户端级角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

client
必需

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/clients/{client}

获取与客户端范围关联的角色。返回客户端的角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

client
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

POST /admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/clients/{client}

向客户端范围添加客户端级角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

client
必需

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings

获取客户端的所有范围映射。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/realm/available

获取可用于附加到此客户端范围的领域级角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/realm/composite

获取与客户端范围关联的有效的领域级角色。此操作将递归与客户端范围关联的任何复合角色并将角色添加到此列表中。

描述

此方法实际上是为了显示与客户端关联的领域级角色的全面总视图。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

查询参数

名称

描述

默认值

模式

briefRepresentation
可选

如果为 false，则返回具有其属性的角色。

true

内容类型

application/json

响应

代码

消息

数据类型

200

DELETE /admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/realm

从客户端范围中删除一组领域级角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/realm

获取与客户端范围关联的领域级角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

POST /admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/realm

向客户端范围添加一组领域级角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-scope-id
必需

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/scope-mappings/clients/{client}/available

可用的客户端级角色。返回可以与客户端范围关联的客户端的角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

client
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/clients/{client-uuid}/scope-mappings/clients/{client}/composite

获取有效的客户端角色。返回与客户端范围关联的客户端的角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

client
必需

null

查询参数

名称

描述

默认值

模式

briefRepresentation
可选

如果为 false，则返回具有其属性的角色。

true

内容类型

application/json

响应

代码

消息

数据类型

200

DELETE /admin/realms/{realm}/clients/{client-uuid}/scope-mappings/clients/{client}

从客户端范围中删除客户端级角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

client
必需

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/scope-mappings/clients/{client}

获取与客户端范围关联的角色。返回客户端的角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

client
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

POST /admin/realms/{realm}/clients/{client-uuid}/scope-mappings/clients/{client}

向客户端范围添加客户端级角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

client
必需

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/scope-mappings

获取客户端的所有范围映射。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/clients/{client-uuid}/scope-mappings/realm/available

获取可用于附加到此客户端范围的领域级角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/clients/{client-uuid}/scope-mappings/realm/composite

获取与客户端范围关联的有效的领域级角色。此操作将递归与客户端范围关联的任何复合角色并将角色添加到此列表中。

描述

此方法实际上是为了显示与客户端关联的领域级角色的全面总视图。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

查询参数

名称

描述

默认值

模式

briefRepresentation
可选

如果为 false，则返回具有其属性的角色。

true

内容类型

application/json

响应

代码

消息

数据类型

200

DELETE /admin/realms/{realm}/clients/{client-uuid}/scope-mappings/realm

从客户端范围中删除一组领域级角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/clients/{client-uuid}/scope-mappings/realm

获取与客户端范围关联的领域级角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

POST /admin/realms/{realm}/clients/{client-uuid}/scope-mappings/realm

向客户端范围添加一组领域级角色。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

client-uuid
必需

客户端 ID（不是 client-id！）

null

主体参数

名称

描述

默认值

模式

RoleRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

用户

GET /admin/realms/{realm}/users/count

返回与给定条件匹配的用户数量。

描述

它可以通过三种不同的方式调用。 1. 不要指定任何条件并传递 {@code null}。将返回该领域中所有用户的数量。<p> 2. 如果指定了 {@code search}，则会忽略其他条件，例如 {@code last}，即使您设置了它们也是如此。{@code search} 字符串将与用户的姓氏、名字、用户名和电子邮件匹配。<p> 3. 如果未指定 {@code search}，但指定了 {@code last}、{@code first}、{@code email} 或 {@code username}，则这些条件将与其在用户实体上的相应字段匹配。与逻辑与组合。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

查询参数

名称

描述

默认值

模式

email
可选

电子邮件过滤器

null

emailVerified
可选

null

enabled
可选

表示用户是否启用的布尔值。

null

firstName
可选

名字过滤器

null

lastName
可选

姓氏过滤器

null

q
可选

null

搜索
可选

所有以下字段的任意搜索字符串。默认搜索行为是基于前缀的（例如，foo 或 foo*）。使用 **foo** 进行中缀搜索，使用 “foo” 进行精确搜索。

null

username
可选

用户名过滤器

null

内容类型

application/json

响应

代码

消息

数据类型

200

[Integer]

GET /admin/realms/{realm}/users

获取用户。返回用户流，根据查询参数进行过滤。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

查询参数

名称

描述

默认值

模式

briefRepresentation
可选

布尔值，定义是否返回简要表示（默认：false）

null

email
可选

电子邮件中包含的字符串，如果参数 “exact” 为 true，则为完整的电子邮件。

null

emailVerified
可选

电子邮件是否已验证。

null

enabled
可选

表示用户是否启用的布尔值。

null

exact
可选

布尔值，定义参数 “last”、“first”、“email” 和 “username” 是否必须完全匹配。

null

first
可选

分页偏移量

null

firstName
可选

firstName 中包含的字符串，如果参数 “exact” 为 true，则为完整的 firstName。

null

idpAlias
可选

与用户关联的身份提供者的别名。

null

idpUserId
可选

与用户关联的身份提供者处的用户 ID。

null

lastName
可选

lastName 中包含的字符串，如果参数 “exact” 为 true，则为完整的 lastName。

null

max
可选

最大结果大小（默认值为 100）

null

q
可选

用于搜索自定义属性的查询，格式为“key1:value2 key2:value2”

null

搜索
可选

用户名、名字、姓氏或电子邮件中包含的字符串。默认搜索行为是基于前缀的（例如，foo 或 foo*）。使用 **foo** 进行中缀搜索，使用 “foo” 进行精确搜索。

null

username
可选

用户名中包含的字符串，如果参数 “exact” 为 true，则为完整的用户名。

null

内容类型

application/json

响应

代码

消息

数据类型

200

POST /admin/realms/{realm}/users

创建新用户。用户名必须唯一。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

主体参数

名称

描述

默认值

模式

UserRepresentation
可选

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/users/profile

描述

获取用户配置文件的配置。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

UPConfig

GET /admin/realms/{realm}/users/profile/metadata

描述

从配置中获取 UserProfileMetadata。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

内容类型

application/json

响应

代码

消息

数据类型

200

UserProfileMetadata

PUT /admin/realms/{realm}/users/profile

描述

设置用户配置文件的配置。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

主体参数

名称

描述

默认值

模式

UPConfig
可选

UPConfig

内容类型

application/json

响应

代码

消息

数据类型

200

UPConfig

GET /admin/realms/{realm}/users/{user-id}/configured-user-storage-credential-types

返回凭据类型，这些凭据类型由存储用户的用户存储提供。

描述

返回值可能包含例如 “password”、“otp” 等。这将始终为空列表，用于“local” 用户，这些用户不受任何用户存储的支持。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[[string]]

DELETE /admin/realms/{realm}/users/{user-id}/consents/{client}

撤销对特定客户端的同意和脱机令牌。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

client
必需

客户端 ID

null

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/users/{user-id}/consents

获取用户授予的同意。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[[AnyType]]

DELETE /admin/realms/{realm}/users/{user-id}/credentials/{credentialId}

删除用户的凭据。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

credentialId
必需

null

响应

代码

消息

数据类型

204

无内容

<<>>

POST /admin/realms/{realm}/users/{user-id}/credentials/{credentialId}/moveAfter/{newPreviousCredentialId}

将凭据移动到另一个凭据后面的位置。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

credentialId
必需

要移动的凭据。

null

newPreviousCredentialId
必需

列表中将成为先前元素的凭据。如果设置为 null，则移动的凭据将是列表中的第一个元素。

null

响应

代码

消息

数据类型

204

无内容

<<>>

POST /admin/realms/{realm}/users/{user-id}/credentials/{credentialId}/moveToFirst

将凭证移到用户凭证列表的第一个位置

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

credentialId
必需

要移动的凭据。

null

响应

代码

消息

数据类型

204

无内容

<<>>

PUT /admin/realms/{realm}/users/{user-id}/credentials/{credentialId}/userLabel

更新用户的凭证标签

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

credentialId
必需

null

主体参数

名称

描述

默认值

模式

body
可选

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/users/{user-id}/credentials

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[CredentialRepresentation]

DELETE /admin/realms/{realm}/users/{user-id}

删除用户

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

响应

代码

消息

数据类型

200

<<>>

PUT /admin/realms/{realm}/users/{user-id}/disable-credential-types

禁用用户特定类型的所有凭据

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

主体参数

名称

描述

默认值

模式

string
可选

响应

代码

消息

数据类型

204

无内容

<<>>

PUT /admin/realms/{realm}/users/{user-id}/execute-actions-email

向用户发送包含链接的电子邮件，他们可以点击该链接来执行特定操作。

描述

电子邮件包含一个链接，用户可以点击该链接执行一组所需的操作。redirectUri 和 clientId 参数是可选的。如果未提供重定向，则在操作完成后将不会有可点击的链接返回。重定向 URI 必须是特定 clientId 的有效 URI。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

主体参数

名称

描述

默认值

模式

string
可选

查询参数

名称

描述

默认值

模式

client_id
可选

客户端 ID

null

lifespan
可选

生成的令牌过期后的秒数

null

redirect_uri
可选

重定向 URI

null

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/users/{user-id}/federated-identity

获取与用户关联的社交登录

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

List[FederatedIdentityRepresentation]

DELETE /admin/realms/{realm}/users/{user-id}/federated-identity/{provider}

从用户中删除社交登录提供商

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

provider
必需

社交登录提供商 ID

null

响应

代码

消息

数据类型

204

无内容

<<>>

POST /admin/realms/{realm}/users/{user-id}/federated-identity/{provider}

向用户添加社交登录提供商

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

provider
必需

社交登录提供商 ID

null

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/users/{user-id}

获取用户的表示形式

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

查询参数

名称

描述

默认值

模式

userProfileMetadata
可选

指示是否将用户配置文件元数据添加到响应中

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/users/{user-id}/groups/count

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

查询参数

名称

描述

默认值

模式

搜索
可选

null

内容类型

application/json

响应

代码

消息

数据类型

200

Map[[long]]

GET /admin/realms/{realm}/users/{user-id}/groups

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

查询参数

名称

描述

默认值

模式

briefRepresentation
可选

true

first
可选

null

max
可选

null

搜索
可选

null

内容类型

application/json

响应

代码

消息

数据类型

200

DELETE /admin/realms/{realm}/users/{user-id}/groups/{groupId}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

groupId
必需

null

响应

代码

消息

数据类型

204

无内容

<<>>

PUT /admin/realms/{realm}/users/{user-id}/groups/{groupId}

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

groupId
必需

null

响应

代码

消息

数据类型

204

无内容

<<>>

POST /admin/realms/{realm}/users/{user-id}/impersonation

模拟用户

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

Map[<<>>]

POST /admin/realms/{realm}/users/{user-id}/logout

删除与用户关联的所有用户会话，还会向所有具有管理 URL 的客户端发送通知，以使特定用户的会话失效。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

响应

代码

消息

数据类型

204

无内容

<<>>

GET /admin/realms/{realm}/users/{user-id}/offline-sessions/{clientUuid}

获取与用户和客户端关联的脱机会话

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

clientUuid
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

PUT /admin/realms/{realm}/users/{user-id}

更新用户

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

主体参数

名称

描述

默认值

模式

UserRepresentation
可选

响应

代码

消息

数据类型

200

<<>>

PUT /admin/realms/{realm}/users/{user-id}/reset-password-email

向用户发送包含链接的电子邮件，他们可以点击该链接来重置其密码。

描述

redirectUri 和 clientId 参数是可选的。重定向的默认值为帐户客户端。此端点已弃用。请使用 execute-actions-email 传递包含 UPDATE_PASSWORD 的列表。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

查询参数

名称

描述

默认值

模式

client_id
可选

client id

null

redirect_uri
可选

重定向 URI

null

响应

代码

消息

数据类型

200

<<>>

PUT /admin/realms/{realm}/users/{user-id}/reset-password

为用户设置新密码。

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

主体参数

名称

描述

默认值

模式

CredentialRepresentation
可选

响应

代码

消息

数据类型

204

无内容

<<>>

PUT /admin/realms/{realm}/users/{user-id}/send-verify-email

向用户发送电子邮件验证邮件电子邮件包含一个链接，用户可以点击该链接来验证其电子邮件地址。

描述

redirectUri、clientId 和 lifespan 参数是可选的。重定向的默认值为帐户客户端。lifespan 的默认值为 12 小时

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

查询参数

名称

描述

默认值

模式

client_id
可选

客户端 ID

null

lifespan
可选

生成的令牌过期后的秒数

null

redirect_uri
可选

重定向 URI

null

响应

代码

消息

数据类型

200

<<>>

GET /admin/realms/{realm}/users/{user-id}/sessions

获取与用户关联的会话

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

GET /admin/realms/{realm}/users/{user-id}/unmanagedAttributes

参数

路径参数

名称

描述

默认值

模式

realm
必需

领域名称（不是 ID！）

null

user-id
必需

null

内容类型

application/json

响应

代码

消息

数据类型

200

Map[[string]]

定义

AbstractPolicyRepresentation

名称

Type

Format

id
可选

String

name
可选

String

description
可选

String

type
可选

String

policies
可选

Set of [string]

resources
可选

Set of [string]

scopes
可选

Set of [string]

logic
可选

逻辑

decisionStrategy
可选

DecisionStrategy

owner
可选

String

resourcesData
可选

Set of ResourceRepresentation

scopesData
可选

访问

名称

Type

Format

roles
可选

Set of [string]

verify_caller
可选

Boolean

访问令牌

名称

Type

Format

jti
可选

String

exp
可选

Long

int64

nbf
可选

Long

int64

iat
可选

Long

int64

iss
可选

String

sub
可选

String

typ
可选

String

azp
可选

String

otherClaims
可选

Map of [AnyType]

nonce
可选

String

auth_time
可选

Long

int64

sid
可选

String

at_hash
可选

String

c_hash
可选

String

name
可选

String

given_name
可选

String

family_name
可选

String

middle_name
可选

String

nickname
可选

String

preferred_username
可选

String

profile
可选

String

picture
可选

String

website
可选

String

email
可选

String

email_verified
可选

Boolean

gender
可选

String

birthdate
可选

String

zoneinfo
可选

String

locale
可选

String

phone_number
可选

String

phone_number_verified
可选

Boolean

address
可选

地址声明集

updated_at
可选

Long

int64

claims_locales
可选

String

acr
可选

String

s_hash
可选

String

trusted-certs
可选

Set of [string]

allowed-origins
可选

Set of [string]

realm_access
可选

访问

resource_access
可选

Map of Access

authorization
可选

授权

cnf
可选

确认

scope
可选

String

地址声明集

名称

Type

Format

formatted
可选

String

street_address
可选

String

locality
可选

String

region
可选

String

postal_code
可选

String

country
可选

String

AdminEventRepresentation

名称

Type

Format

time
可选

Long

int64

realmId
可选

String

authDetails
可选

AuthDetailsRepresentation

operationType
可选

String

resourceType
可选

String

resourcePath
可选

String

representation
可选

String

error
可选

String

ApplicationRepresentation

名称

Type

Format

id
可选

String

clientId
可选

String

description
可选

String

type
可选

String

rootUrl
可选

String

adminUrl
可选

String

baseUrl
可选

String

surrogateAuthRequired
可选

Boolean

enabled
可选

Boolean

alwaysDisplayInConsole
可选

Boolean

clientAuthenticatorType
可选

String

secret
可选

String

registrationAccessToken
可选

String

defaultRoles
可选

List of [string]

redirectUris
可选

List of [string]

webOrigins
可选

List of [string]

notBefore
可选

Integer

int32

bearerOnly
可选

Boolean

consentRequired
可选

Boolean

standardFlowEnabled
可选

Boolean

implicitFlowEnabled
可选

Boolean

directAccessGrantsEnabled
可选

Boolean

serviceAccountsEnabled
可选

Boolean

authorizationServicesEnabled
可选

Boolean

directGrantsOnly
可选

Boolean

publicClient
可选

Boolean

frontchannelLogout
可选

Boolean

protocol
可选

String

attributes
可选

Map of [string]

authenticationFlowBindingOverrides
可选

Map of [string]

fullScopeAllowed
可选

Boolean

nodeReRegistrationTimeout
可选

Integer

int32

registeredNodes
可选

Map of [integer]

int32

protocolMappers
可选

clientTemplate
可选

String

useTemplateConfig
可选

Boolean

useTemplateScope
可选

Boolean

useTemplateMappers
可选

Boolean

defaultClientScopes
可选

List of [string]

optionalClientScopes
可选

List of [string]

authorizationSettings
可选

ResourceServerRepresentation

access
可选

Map of [boolean]

origin
可选

String

name
可选

String

claims
可选

ApplicationRepresentation_claims

ApplicationRepresentationClaims

名称

Type

Format

name
可选

Boolean

username
可选

Boolean

profile
可选

Boolean

picture
可选

Boolean

website
可选

Boolean

email
可选

Boolean

gender
可选

Boolean

locale
可选

Boolean

address
可选

Boolean

phone
可选

Boolean

AuthDetailsRepresentation

名称

Type

Format

realmId
可选

String

clientId
可选

String

userId
可选

String

ipAddress
可选

String

AuthenticationExecutionExportRepresentation

名称

Type

Format

authenticatorConfig
可选

String

authenticator
可选

String

authenticatorFlow
可选

Boolean

requirement
可选

String

priority
可选

Integer

int32

autheticatorFlow
可选

Boolean

flowAlias
可选

String

userSetupAllowed
可选

Boolean

AuthenticationExecutionInfoRepresentation

名称

Type

Format

id
可选

String

requirement
可选

String

displayName
可选

String

alias
可选

String

description
可选

String

requirementChoices
可选

List of [string]

configurable
可选

Boolean

authenticationFlow
可选

Boolean

providerId
可选

String

authenticationConfig
可选

String

flowId
可选

String

level
可选

Integer

int32

index
可选

Integer

int32

priority
可选

Integer

int32

AuthenticationExecutionRepresentation

名称

Type

Format

authenticatorConfig
可选

String

authenticator
可选

String

authenticatorFlow
可选

Boolean

requirement
可选

String

priority
可选

Integer

int32

autheticatorFlow
可选

Boolean

id
可选

String

flowId
可选

String

parentFlow
可选

String

AuthenticationFlowRepresentation

名称

Type

Format

id
可选

String

alias
可选

String

description
可选

String

providerId
可选

String

topLevel
可选

Boolean

builtIn
可选

Boolean

authenticationExecutions
可选

List of AuthenticationExecutionExportRepresentation

AuthenticatorConfigInfoRepresentation

名称

Type

Format

name
可选

String

providerId
可选

String

helpText
可选

String

properties
可选

AuthenticatorConfigRepresentation

名称

Type

Format

id
可选

String

alias
可选

String

config
可选

Map of [string]

授权

名称

Type

Format

permissions
可选

List of Permission

BruteForceStrategy

名称

Type

Format

CertificateRepresentation

名称

Type

Format

privateKey
可选

String

publicKey
可选

String

certificate
可选

String

kid
可选

String

ClaimRepresentation

名称

Type

Format

name
可选

Boolean

username
可选

Boolean

profile
可选

Boolean

picture
可选

Boolean

website
可选

Boolean

email
可选

Boolean

gender
可选

Boolean

locale
可选

Boolean

address
可选

Boolean

phone
可选

Boolean

ClientInitialAccessCreatePresentation

名称

Type

Format

expiration
可选

Integer

int32

count
可选

Integer

int32

ClientInitialAccessPresentation

名称

Type

Format

id
可选

String

token
可选

String

timestamp
可选

Integer

int32

expiration
可选

Integer

int32

count
可选

Integer

int32

remainingCount
可选

Integer

int32

ClientMappingsRepresentation

名称

Type

Format

id
可选

String

client
可选

String

mappings
可选

List of RoleRepresentation

ClientPoliciesRepresentation

名称

Type

Format

policies
可选

List of ClientPolicyRepresentation

globalPolicies
可选

List of ClientPolicyRepresentation

ClientPolicyConditionRepresentation

名称

Type

Format

condition
可选

String

configuration
可选

List

ClientPolicyExecutorRepresentation

名称

Type

Format

executor
可选

String

configuration
可选

List

ClientPolicyRepresentation

名称

Type

Format

name
可选

String

description
可选

String

enabled
可选

Boolean

conditions
可选

List of ClientPolicyConditionRepresentation

profiles
可选

List of [string]

ClientProfileRepresentation

名称

Type

Format

name
可选

String

description
可选

String

executors
可选

List of ClientPolicyExecutorRepresentation

ClientProfilesRepresentation

名称

Type

Format

profiles
可选

List of ClientProfileRepresentation

globalProfiles
可选

List of ClientProfileRepresentation

ClientRepresentation

名称

Type

Format

id
可选

String

clientId
可选

String

name
可选

String

description
可选

String

type
可选

String

rootUrl
可选

String

adminUrl
可选

String

baseUrl
可选

String

surrogateAuthRequired
可选

Boolean

enabled
可选

Boolean

alwaysDisplayInConsole
可选

Boolean

clientAuthenticatorType
可选

String

secret
可选

String

registrationAccessToken
可选

String

defaultRoles
可选

List of [string]

redirectUris
可选

List of [string]

webOrigins
可选

List of [string]

notBefore
可选

Integer

int32

bearerOnly
可选

Boolean

consentRequired
可选

Boolean

standardFlowEnabled
可选

Boolean

implicitFlowEnabled
可选

Boolean

directAccessGrantsEnabled
可选

Boolean

serviceAccountsEnabled
可选

Boolean

authorizationServicesEnabled
可选

Boolean

directGrantsOnly
可选

Boolean

publicClient
可选

Boolean

frontchannelLogout
可选

Boolean

protocol
可选

String

attributes
可选

Map of [string]

authenticationFlowBindingOverrides
可选

Map of [string]

fullScopeAllowed
可选

Boolean

nodeReRegistrationTimeout
可选

Integer

int32

registeredNodes
可选

Map of [integer]

int32

protocolMappers
可选

clientTemplate
可选

String

useTemplateConfig
可选

Boolean

useTemplateScope
可选

Boolean

useTemplateMappers
可选

Boolean

defaultClientScopes
可选

List of [string]

optionalClientScopes
可选

List of [string]

authorizationSettings
可选

ResourceServerRepresentation

access
可选

Map of [boolean]

origin
可选

String

ClientScopeRepresentation

名称

Type

Format

id
可选

String

name
可选

String

description
可选

String

protocol
可选

String

attributes
可选

Map of [string]

protocolMappers
可选

ClientTemplateRepresentation

名称

Type

Format

id
可选

String

name
可选

String

description
可选

String

protocol
可选

String

fullScopeAllowed
可选

Boolean

bearerOnly
可选

Boolean

consentRequired
可选

Boolean

standardFlowEnabled
可选

Boolean

implicitFlowEnabled
可选

Boolean

directAccessGrantsEnabled
可选

Boolean

serviceAccountsEnabled
可选

Boolean

publicClient
可选

Boolean

frontchannelLogout
可选

Boolean

attributes
可选

Map of [string]

protocolMappers
可选

ClientTypeRepresentation

名称

Type

Format

name
可选

String

provider
可选

String

parent
可选

String

config
可选

Map of PropertyConfig

ClientTypesRepresentation

名称

Type

Format

client-types
可选

List of ClientTypeRepresentation

global-client-types
可选

List of ClientTypeRepresentation

ComponentExportRepresentation

名称

Type

Format

id
可选

String

name
可选

String

providerId
可选

String

subType
可选

String

subComponents
可选

Map of [array]

config
可选

Map of [array]

ComponentRepresentation

名称

Type

Format

id
可选

String

name
可选

String

providerId
可选

String

providerType
可选

String

parentId
可选

String

subType
可选

String

config
可选

Map of [array]

ComponentTypeRepresentation

名称

Type

Format

id
可选

String

helpText
可选

String

properties
可选

metadata
可选

Map of [AnyType]

复合

名称

Type

Format

realm
可选

Set of [string]

client
可选

Map of [array]

application
可选

Map of [array]

ConfigPropertyRepresentation

名称

Type

Format

name
可选

String

label
可选

String

helpText
可选

String

type
可选

String

defaultValue
可选

oas_any_type_not_mapped

options
可选

List of [string]

secret
可选

Boolean

必需
可选

Boolean

readOnly
可选

Boolean

确认

名称

Type

Format

x5t#S256
可选

String

jkt
可选

String

CredentialRepresentation

名称

Type

Format

id
可选

String

type
可选

String

userLabel
可选

String

createdDate
可选

Long

int64

secretData
可选

String

credentialData
可选

String

priority
可选

Integer

int32

value
可选

String

temporary
可选

Boolean

device
可选

String

hashedSaltedValue
可选

String

salt
可选

String

hashIterations
可选

Integer

int32

counter
可选

Integer

int32

algorithm
可选

String

digits
可选

Integer

int32

period
可选

Integer

int32

config
可选

Map

DecisionEffect

名称

Type

Format

DecisionStrategy

名称

Type

Format

EnforcementMode

名称

Type

Format

EvaluationResultRepresentation

名称

Type

Format

resource
可选

ResourceRepresentation

scopes
可选

List of ScopeRepresentation

policies
可选

List of PolicyResultRepresentation

status
可选

DecisionEffect

allowedScopes
可选

List of ScopeRepresentation

EventRepresentation

名称

Type

Format

time
可选

Long

int64

type
可选

String

realmId
可选

String

clientId
可选

String

userId
可选

String

sessionId
可选

String

ipAddress
可选

String

error
可选

String

details
可选

Map of [string]

FederatedIdentityRepresentation

名称

Type

Format

identityProvider
可选

String

userId
可选

String

userName
可选

String

GlobalRequestResult

名称

Type

Format

successRequests
可选

List of [string]

failedRequests
可选

List of [string]

GroupRepresentation

名称

Type

Format

id
可选

String

name
可选

String

path
可选

String

parentId
可选

String

subGroupCount
可选

Long

int64

subGroups
可选

List of GroupRepresentation

attributes
可选

Map of [array]

realmRoles
可选

List of [string]

clientRoles
可选

Map of [array]

access
可选

Map of [boolean]

IDToken

名称

Type

Format

jti
可选

String

exp
可选

Long

int64

nbf
可选

Long

int64

iat
可选

Long

int64

iss
可选

String

sub
可选

String

typ
可选

String

azp
可选

String

otherClaims
可选

Map of [AnyType]

nonce
可选

String

auth_time
可选

Long

int64

sid
可选

String

at_hash
可选

String

c_hash
可选

String

name
可选

String

given_name
可选

String

family_name
可选

String

middle_name
可选

String

nickname
可选

String

preferred_username
可选

String

profile
可选

String

picture
可选

String

website
可选

String

email
可选

String

email_verified
可选

Boolean

gender
可选

String

birthdate
可选

String

zoneinfo
可选

String

locale
可选

String

phone_number
可选

String

phone_number_verified
可选

Boolean

address
可选

地址声明集

updated_at
可选

Long

int64

claims_locales
可选

String

acr
可选

String

s_hash
可选

String

IdentityProviderMapperRepresentation

名称

Type

Format

id
可选

String

name
可选

String

identityProviderAlias
可选

String

identityProviderMapper
可选

String

config
可选

Map of [string]

IdentityProviderMapperTypeRepresentation

名称

Type

Format

id
可选

String

name
可选

String

category
可选

String

helpText
可选

String

properties
可选

IdentityProviderRepresentation

名称

Type

Format

alias
可选

String

displayName
可选

String

internalId
可选

String

providerId
可选

String

enabled
可选

Boolean

updateProfileFirstLoginMode
可选

String

trustEmail
可选

Boolean

storeToken
可选

Boolean

addReadTokenRoleOnCreate
可选

Boolean

authenticateByDefault
可选

Boolean

linkOnly
可选

Boolean

hideOnLogin
可选

Boolean

firstBrokerLoginFlowAlias
可选

String

postBrokerLoginFlowAlias
可选

String

organizationId
可选

String

config
可选

Map of [string]

updateProfileFirstLogin
可选

Boolean

InstallationAdapterConfig

名称

Type

Format

realm
可选

String

realm-public-key
可选

String

auth-server-url
可选

String

ssl-required
可选

String

bearer-only
可选

Boolean

resource
可选

String

public-client
可选

Boolean

verify-token-audience
可选

Boolean

credentials
可选

Map of [AnyType]

use-resource-role-mappings
可选

Boolean

confidential-port
可选

Integer

int32

policy-enforcer
可选

PolicyEnforcerConfig

KeyMetadataRepresentation

名称

Type

Format

providerId
可选

String

providerPriority
可选

Long

int64

kid
可选

String

status
可选

String

type
可选

String

algorithm
可选

String

publicKey
可选

String

certificate
可选

String

use
可选

KeyUse

validTo
可选

Long

int64

KeyStoreConfig

名称

Type

Format

realmCertificate
可选

Boolean

storePassword
可选

String

keyPassword
可选

String

keyAlias
可选

String

realmAlias
可选

String

format
可选

String

KeyUse

名称

Type

Format

KeysMetadataRepresentation

名称

Type

Format

active
可选

Map of [string]

keys
可选

List of KeyMetadataRepresentation

逻辑

名称

Type

Format

ManagementPermissionReference

名称

Type

Format

enabled
可选

Boolean

resource
可选

String

scopePermissions
可选

Map of [string]

MappingsRepresentation

名称

Type

Format

realmMappings
可选

List of RoleRepresentation

clientMappings
可选

Map of ClientMappingsRepresentation

MemberRepresentation

名称

Type

Format

id
可选

String

username
可选

String

firstName
可选

String

lastName
可选

String

email
可选

String

emailVerified
可选

Boolean

attributes
可选

Map of [array]

userProfileMetadata
可选

UserProfileMetadata

self
可选

String

origin
可选

String

createdTimestamp
可选

Long

int64

enabled
可选

Boolean

totp
可选

Boolean

federationLink
可选

String

serviceAccountClientId
可选

String

credentials
可选

List of CredentialRepresentation

disableableCredentialTypes
可选

Set of [string]

requiredActions
可选

List of [string]

federatedIdentities
可选

List of FederatedIdentityRepresentation

realmRoles
可选

List of [string]

clientRoles
可选

Map of [array]

clientConsents
可选

List of UserConsentRepresentation

notBefore
可选

Integer

int32

applicationRoles
可选

Map of [array]

socialLinks
可选

List of SocialLinkRepresentation

groups
可选

List of [string]

access
可选

Map of [boolean]

membershipType
可选

MembershipType

名称

Type

Format

MethodConfig

名称

Type

Format

method
可选

String

scopes
可选

List of [string]

scopes-enforcement-mode
可选

ScopeEnforcementMode

OAuthClientRepresentation

名称

Type

Format

id
可选

String

clientId
可选

String

description
可选

String

type
可选

String

rootUrl
可选

String

adminUrl
可选

String

baseUrl
可选

String

surrogateAuthRequired
可选

Boolean

enabled
可选

Boolean

alwaysDisplayInConsole
可选

Boolean

clientAuthenticatorType
可选

String

secret
可选

String

registrationAccessToken
可选

String

defaultRoles
可选

List of [string]

redirectUris
可选

List of [string]

webOrigins
可选

List of [string]

notBefore
可选

Integer

int32

bearerOnly
可选

Boolean

consentRequired
可选

Boolean

standardFlowEnabled
可选

Boolean

implicitFlowEnabled
可选

Boolean

directAccessGrantsEnabled
可选

Boolean

serviceAccountsEnabled
可选

Boolean

authorizationServicesEnabled
可选

Boolean

directGrantsOnly
可选

Boolean

publicClient
可选

Boolean

frontchannelLogout
可选

Boolean

protocol
可选

String

attributes
可选

Map of [string]

authenticationFlowBindingOverrides
可选

Map of [string]

fullScopeAllowed
可选

Boolean

nodeReRegistrationTimeout
可选

Integer

int32

registeredNodes
可选

Map of [integer]

int32

protocolMappers
可选

clientTemplate
可选

String

useTemplateConfig
可选

Boolean

useTemplateScope
可选

Boolean

useTemplateMappers
可选

Boolean

defaultClientScopes
可选

List of [string]

optionalClientScopes
可选

List of [string]

authorizationSettings
可选

ResourceServerRepresentation

access
可选

Map of [boolean]

origin
可选

String

name
可选

String

claims
可选

ApplicationRepresentation_claims

OrganizationDomainRepresentation

名称

Type

Format

name
可选

String

verified
可选

Boolean

OrganizationRepresentation

名称

Type

Format

id
可选

String

name
可选

String

alias
可选

String

enabled
可选

Boolean

description
可选

String

redirectUrl
可选

String

attributes
可选

Map of [array]

domains
可选

Set of OrganizationDomainRepresentation

members
可选

List of MemberRepresentation

identityProviders
可选

List of IdentityProviderRepresentation

PathCacheConfig

名称

Type

Format

max-entries
可选

Integer

int32

lifespan
可选

Long

int64

PathConfig

名称

Type

Format

name
可选

String

type
可选

String

path
可选

String

methods
可选

List of MethodConfig

scopes
可选

List of [string]

id
可选

String

enforcement-mode
可选

EnforcementMode

claim-information-point
可选

Map of [map]

invalidated
可选

Boolean

staticPath
可选

Boolean

static
可选

Boolean

权限

名称

Type

Format

rsid
可选

String

rsname
可选

String

scopes
可选

Set of [string]

claims
可选

Map of [set]

PolicyEnforcementMode

名称

Type

Format

PolicyEnforcerConfig

名称

Type

Format

enforcement-mode
可选

EnforcementMode

paths
可选

List of PathConfig

path-cache
可选

PathCacheConfig

lazy-load-paths
可选

Boolean

on-deny-redirect-to
可选

String

user-managed-access
可选

Object

claim-information-point
可选

Map of [map]

http-method-as-scope
可选

Boolean

realm
可选

String

auth-server-url
可选

String

credentials
可选

Map of [AnyType]

resource
可选

String

PolicyEvaluationRequest

名称

Type

Format

context
可选

Map of [map]

resources
可选

List of ResourceRepresentation

clientId
可选

String

userId
可选

String

roleIds
可选

List of [string]

entitlements
可选

Boolean

PolicyEvaluationResponse

名称

Type

Format

results
可选

List of EvaluationResultRepresentation

entitlements
可选

Boolean

status
可选

DecisionEffect

rpt
可选

访问令牌

PolicyProviderRepresentation

名称

Type

Format

type
可选

String

name
可选

String

group
可选

String

PolicyRepresentation

名称

Type

Format

id
可选

String

name
可选

String

description
可选

String

type
可选

String

policies
可选

Set of [string]

resources
可选

Set of [string]

scopes
可选

Set of [string]

logic
可选

逻辑

decisionStrategy
可选

DecisionStrategy

owner
可选

String

resourcesData
可选

Set of ResourceRepresentation

scopesData
可选

config
可选

Map of [string]

PolicyResultRepresentation

名称

Type

Format

policy
可选

PolicyRepresentation

status
可选

DecisionEffect

associatedPolicies
可选

List of PolicyResultRepresentation

scopes
可选

Set of [string]

PropertyConfig

名称

Type

Format

applicable
可选

Boolean

value
可选

oas_any_type_not_mapped

ProtocolMapperEvaluationRepresentation

名称

Type

Format

mapperId
可选

String

mapperName
可选

String

containerId
可选

String

containerName
可选

String

containerType
可选

String

protocolMapper
可选

String

ProtocolMapperRepresentation

名称

Type

Format

id
可选

String

name
可选

String

protocol
可选

String

protocolMapper
可选

String

consentRequired
可选

Boolean

consentText
可选

String

config
可选

Map of [string]

PublishedRealmRepresentation

名称

Type

Format

realm
可选

String

public_key
可选

String

token-service
可选

String

account-service
可选

String

tokens-not-before
可选

Integer

int32

RealmEventsConfigRepresentation

名称

Type

Format

eventsEnabled
可选

Boolean

eventsExpiration
可选

Long

int64

eventsListeners
可选

List of [string]

enabledEventTypes
可选

List of [string]

adminEventsEnabled
可选

Boolean

adminEventsDetailsEnabled
可选

Boolean

RealmRepresentation

名称

Type

Format

id
可选

String

realm
可选

String

displayName
可选

String

displayNameHtml
可选

String

notBefore
可选

Integer

int32

defaultSignatureAlgorithm
可选

String

revokeRefreshToken
可选

Boolean

refreshTokenMaxReuse
可选

Integer

int32

accessTokenLifespan
可选

Integer

int32

accessTokenLifespanForImplicitFlow
可选

Integer

int32

ssoSessionIdleTimeout
可选

Integer

int32

ssoSessionMaxLifespan
可选

Integer

int32

ssoSessionIdleTimeoutRememberMe
可选

Integer

int32

ssoSessionMaxLifespanRememberMe
可选

Integer

int32

offlineSessionIdleTimeout
可选

Integer

int32

offlineSessionMaxLifespanEnabled
可选

Boolean

offlineSessionMaxLifespan
可选

Integer

int32

clientSessionIdleTimeout
可选

Integer

int32

clientSessionMaxLifespan
可选

Integer

int32

clientOfflineSessionIdleTimeout
可选

Integer

int32

clientOfflineSessionMaxLifespan
可选

Integer

int32

accessCodeLifespan
可选

Integer

int32

accessCodeLifespanUserAction
可选

Integer

int32

accessCodeLifespanLogin
可选

Integer

int32

actionTokenGeneratedByAdminLifespan
可选

Integer

int32

actionTokenGeneratedByUserLifespan
可选

Integer

int32

oauth2DeviceCodeLifespan
可选

Integer

int32

oauth2DevicePollingInterval
可选

Integer

int32

enabled
可选

Boolean

sslRequired
可选

String

passwordCredentialGrantAllowed
可选

Boolean

registrationAllowed
可选

Boolean

registrationEmailAsUsername
可选

Boolean

rememberMe
可选

Boolean

verifyEmail
可选

Boolean

loginWithEmailAllowed
可选

Boolean

允许重复电子邮件
可选

Boolean

允许重置密码
可选

Boolean

允许编辑用户名
可选

Boolean

用户缓存已启用
可选

Boolean

领域缓存已启用
可选

Boolean

受暴力破解保护
可选

Boolean

永久锁定
可选

Boolean

最大临时锁定次数
可选

Integer

int32

暴力破解策略
可选

BruteForceStrategy

最大失败等待秒数
可选

Integer

int32

最小快速登录等待秒数
可选

Integer

int32

等待递增秒数
可选

Integer

int32

快速登录检查毫秒数
可选

Long

int64

最大时间差秒数
可选

Integer

int32

失败因子
可选

Integer

int32

privateKey
可选

String

publicKey
可选

String

certificate
可选

String

代码密钥
可选

String

roles
可选

RolesRepresentation

groups
可选

List of GroupRepresentation

defaultRoles
可选

List of [string]

默认角色
可选

RoleRepresentation

默认组
可选

List of [string]

必需的凭据
可选

Set of [string]

密码策略
可选

String

OTP 策略类型
可选

String

OTP 策略算法
可选

String

OTP 策略初始计数器
可选

Integer

int32

OTP 策略位数
可选

Integer

int32

OTP 策略前瞻窗口
可选

Integer

int32

OTP 策略周期
可选

Integer

int32

OTP 策略代码可重用
可选

Boolean

支持的 OTP 应用程序
可选

List of [string]

本地化文本
可选

Map of [map]

WebAuthn 策略 RP 实体名称
可选

String

WebAuthn 策略签名算法
可选

List of [string]

WebAuthn 策略 RP ID
可选

String

WebAuthn 策略证明传递偏好
可选

String

WebAuthn 策略认证器附件
可选

String

WebAuthn 策略要求驻留密钥
可选

String

WebAuthn 策略用户验证要求
可选

String

WebAuthn 策略创建超时
可选

Integer

int32

WebAuthn 策略避免使用相同的认证器注册
可选

Boolean

WebAuthn 策略可接受的 AAGUID
可选

List of [string]

WebAuthn 策略额外来源
可选

List of [string]

WebAuthn 策略无密码 RP 实体名称
可选

String

WebAuthn 策略无密码签名算法
可选

List of [string]

WebAuthn 策略无密码 RP ID
可选

String

WebAuthn 策略无密码证明传递偏好
可选

String

WebAuthn 策略无密码认证器附件
可选

String

WebAuthn 策略无密码要求驻留密钥
可选

String

WebAuthn 策略无密码用户验证要求
可选

String

WebAuthn 策略无密码创建超时
可选

Integer

int32

WebAuthn 策略无密码避免使用相同的认证器注册
可选

Boolean

WebAuthn 策略无密码可接受的 AAGUID
可选

List of [string]

WebAuthn 策略无密码额外来源
可选

List of [string]

客户端配置文件
可选

ClientProfilesRepresentation

客户端策略
可选

ClientPoliciesRepresentation

用户
可选

用户表示列表

联合用户
可选

用户表示列表

范围映射
可选

范围映射表示列表

客户端范围映射
可选

Map of [array]

客户端
可选

客户端表示列表

客户端范围
可选

客户端范围表示列表

默认默认客户端范围
可选

List of [string]

默认可选客户端范围
可选

List of [string]

浏览器安全头
可选

Map of [string]

SMTP 服务器
可选

Map of [string]

用户联合提供者
可选

用户联合提供者表示列表

用户联合映射器
可选

用户联合映射器表示列表

登录主题
可选

String

帐户主题
可选

String

管理主题
可选

String

电子邮件主题
可选

String

eventsEnabled
可选

Boolean

eventsExpiration
可选

Long

int64

eventsListeners
可选

List of [string]

enabledEventTypes
可选

List of [string]

adminEventsEnabled
可选

Boolean

adminEventsDetailsEnabled
可选

Boolean

identityProviders
可选

List of IdentityProviderRepresentation

身份提供者映射器
可选

身份提供者映射器表示列表

protocolMappers
可选

组件
可选

Map of [array]

已启用国际化
可选

Boolean

支持的语言环境
可选

Set of [string]

默认语言环境
可选

String

身份验证流程
可选

身份验证流程表示列表

authenticatorConfig
可选

认证器配置表示列表

requiredActions
可选

必需操作提供者表示列表

浏览器流程
可选

String

注册流程
可选

String

直接授权流程
可选

String

重置凭据流程
可选

String

客户端身份验证流程
可选

String

Docker 身份验证流程
可选

String

首次代理登录流程
可选

String

attributes
可选

Map of [string]

Keycloak 版本
可选

String

允许用户管理访问
可选

Boolean

已启用组织
可选

Boolean

组织
可选

组织表示列表

社交
可选

Boolean

在初始社交登录时更新个人资料
可选

Boolean

社交提供者
可选

Map of [string]

应用程序范围映射
可选

Map of [array]

应用程序
可选

应用程序表示列表

OAuth 客户端
可选

OAuth 客户端表示列表

客户端模板
可选

客户端模板表示列表

OAuth2 设备代码生存期
可选

Integer

int32

OAuth2 设备轮询间隔
可选

Integer

int32

RequiredActionConfigInfoRepresentation

名称

Type

Format

properties
可选

RequiredActionConfigRepresentation

名称

Type

Format

config
可选

Map of [string]

RequiredActionProviderRepresentation

名称

Type

Format

alias
可选

String

name
可选

String

providerId
可选

String

enabled
可选

Boolean

默认操作
可选

Boolean

priority
可选

Integer

int32

config
可选

Map of [string]

ResourceOwnerRepresentation

名称

Type

Format

id
可选

String

name
可选

String

ResourceRepresentation

名称

Type

Format

id
_optional

String

name
可选

String

URI
可选

Set of [string]

type
可选

String

scopes
可选

图标 URI
可选

String

owner
可选

ResourceRepresentation_owner

拥有者管理访问
可选

Boolean

displayName
可选

String

attributes
可选

Map of [array]

uri
可选

String

UMA 范围
可选