Keycloak 管理 REST API

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

更新身份驗證器設定

參數

路徑參數

名稱	描述	預設值	模式
realm 必要	realm 名稱 (不是 ID！)	null
id 必要	設定 ID	null

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

id
必要

設定 ID

null

Body 參數

名稱	描述	預設值	模式
AuthenticatorConfigRepresentation 選用	AuthenticatorConfigRepresentation

名稱

描述

預設值

模式

AuthenticatorConfigRepresentation
選用

回應

代碼	訊息	資料類型
204	無內容	<<>>

代碼

訊息

資料類型

204

無內容

<<>>

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

建立新的身份驗證器設定

參數

路徑參數

名稱	描述	預設值	模式
realm 必要	realm 名稱 (不是 ID！)	null

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

Body 參數

名稱	描述	預設值	模式
AuthenticatorConfigRepresentation 選用	AuthenticatorConfigRepresentation

名稱

描述

預設值

模式

AuthenticatorConfigRepresentation
選用

回應

代碼	訊息	資料類型
201	已建立	<<>>

代碼

訊息

資料類型

201

已建立

<<>>

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

取得執行的設定

參數

路徑參數

名稱	描述	預設值
realm 必要	realm 名稱 (不是 ID！)	null
executionId 必要	執行 ID	null
id 必要	設定 ID	null

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

executionId
必要

執行 ID

null

id
必要

設定 ID

null

內容類型

application/json

回應

代碼	訊息	資料類型
200	OK	AuthenticatorConfigRepresentation

代碼

訊息

資料類型

200

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

以新的設定更新執行

參數

路徑參數

名稱	描述	預設值	模式
realm 必要	realm 名稱 (不是 ID！)	null
executionId 必要	執行 ID	null

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

executionId
必要

執行 ID

null

Body 參數

名稱	描述	預設值	模式
AuthenticatorConfigRepresentation 選用	AuthenticatorConfigRepresentation

名稱

描述

預設值

模式

AuthenticatorConfigRepresentation
選用

AuthenticationExecutionRepresentation

回應

代碼	訊息	資料類型
201	已建立	<<>>

代碼

訊息

資料類型

201

已建立

<<>>

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

刪除執行

參數

路徑參數

名稱	描述	預設值	模式
realm 必要	realm 名稱 (不是 ID！)	null
executionId 必要	執行 ID	null

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

executionId
必要

執行 ID

null

回應

代碼	訊息	資料類型
204	無內容	<<>>

代碼

訊息

資料類型

204

無內容

<<>>

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

取得單一執行

參數

路徑參數

名稱	描述	預設值	模式
realm 必要	realm 名稱 (不是 ID！)	null
executionId 必要		null

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

executionId
必要

null

內容類型

application/json

回應

代碼	訊息	資料類型
200	OK	AuthenticationExecutionRepresentation

代碼

訊息

資料類型

200

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

降低執行的優先順序

參數

路徑參數

名稱	描述	預設值	模式
realm 必要	realm 名稱 (不是 ID！)	null
executionId 必要	執行 ID	null

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

executionId
必要

執行 ID

null

回應

代碼	訊息	資料類型
204	無內容	<<>>

代碼

訊息

資料類型

204

無內容

<<>>

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

提高執行的優先順序

參數

路徑參數

名稱	描述	預設值	模式
realm 必要	realm 名稱 (不是 ID！)	null
executionId 必要	執行 ID	null

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

executionId
必要

執行 ID

null

回應

代碼	訊息	資料類型
204	無內容	<<>>

代碼

訊息

資料類型

204

無內容

<<>>

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

新增身份驗證執行

參數

路徑參數

名稱	描述	預設值	模式
realm 必要	realm 名稱 (不是 ID！)	null

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

Body 參數

名稱	描述	預設值	模式
AuthenticationExecutionRepresentation 選用	AuthenticationExecutionRepresentation

名稱

描述

預設值

模式

AuthenticationExecutionRepresentation
選用

AuthenticationExecutionRepresentation

回應

代碼	訊息	資料類型
201	已建立	<<>>

代碼

訊息

資料類型

201

已建立

<<>>

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

以新的名稱複製現有的身份驗證流程。新名稱會以傳遞的 JSON 物件的 'newName' 屬性給定。

參數

路徑參數

名稱	描述	預設值	模式
realm 必要	realm 名稱 (不是 ID！)	null
flowAlias 必要	現有身份驗證流程的名稱	null

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

flowAlias
必要

現有身份驗證流程的名稱

null

Body 參數

名稱	描述	預設值	模式
request_body 選用	[string]

名稱

描述

預設值

模式

request_body
選用

AuthenticationExecutionInfoRepresentation

回應

代碼	訊息	資料類型
201	已建立	<<>>

代碼

訊息

資料類型

201

已建立

<<>>

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

將新的身份驗證執行新增至流程

參數

路徑參數

名稱	描述	預設值	模式
realm 必要	realm 名稱 (不是 ID！)	null
flowAlias 必要	父流程的別名	null

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

flowAlias
必要

父流程的別名

null

Body 參數

名稱	描述	預設值	模式
request_body 選用	[AnyType]

名稱

描述

預設值

模式

request_body
選用

[AnyType]

回應

代碼	訊息	資料類型
201	已建立	<<>>

代碼

訊息

資料類型

201

已建立

<<>>

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

將具有新執行的新流程新增至現有流程

參數

路徑參數

名稱	描述	預設值	模式
realm 必要	realm 名稱 (不是 ID！)	null
flowAlias 必要	父身份驗證流程的別名	null

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

flowAlias
必要

父身份驗證流程的別名

null

Body 參數

名稱	描述	預設值	模式
request_body 選用	[AnyType]

名稱

描述

預設值

模式

request_body
選用

[AnyType]

回應

代碼	訊息	資料類型
201	已建立	<<>>

代碼

訊息

資料類型

201

已建立

<<>>

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

取得流程的身份驗證執行

參數

路徑參數

名稱	描述	預設值	模式
realm 必要	realm 名稱 (不是 ID！)	null
flowAlias 必要	流程別名	null

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

flowAlias
必要

流程別名

null

內容類型

application/json

回應

代碼	訊息	資料類型
200	OK	List[AuthenticationExecutionInfoRepresentation]

代碼

訊息

資料類型

200

List[AuthenticationExecutionInfoRepresentation]

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

更新流程的身份驗證執行

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

flowAlias
必要

流程別名

null

Body 參數

名稱

描述

預設值

模式

AuthenticationExecutionInfoRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得身份驗證流程。傳回身份驗證流程的串流。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

List[AuthenticationFlowRepresentation]

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

刪除身份驗證流程

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

id
必要

流程 ID

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得 ID 的身份驗證流程

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

id
必要

流程 ID

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

AuthenticationFlowRepresentation

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

更新身份驗證流程

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

id
必要

null

Body 參數

名稱

描述

預設值

模式

AuthenticationFlowRepresentation
選用

AuthenticationFlowRepresentation

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

建立新的身份驗證流程

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

Body 參數

名稱

描述

預設值

模式

AuthenticationFlowRepresentation
選用

AuthenticationFlowRepresentation

回應

代碼

訊息

資料類型

201

已建立

<<>>

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

取得表單動作提供者。傳回表單動作提供者的串流。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

List[[AnyType]]

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

取得表單提供者。傳回表單提供者的串流。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

List[[AnyType]]

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

取得所有用戶端的設定描述

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

Map[ConfigPropertyRepresentation]

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

註冊新的必要動作

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

Body 參數

名稱

描述

預設值

模式

request_body
選用

RequiredActionConfigInfoRepresentation

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

刪除 RequiredAction 設定

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

alias
必要

必要動作的別名

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得 RequiredAction 提供者設定描述

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

alias
必要

必要動作的別名

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

取得 RequiredAction 設定

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

alias
必要

必要動作的別名

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

RequiredActionConfigRepresentation

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

更新 RequiredAction 設定

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

alias
必要

必要動作的別名

null

Body 參數

名稱

描述

預設值

模式

RequiredActionConfigRepresentation
選用

RequiredActionConfigRepresentation

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

刪除必要動作

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

alias
必要

必要動作的別名

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得別名的必要動作

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

alias
必要

必要動作的別名

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

RequiredActionProviderRepresentation

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

降低必要動作的優先順序

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

alias
必要

必要動作的別名

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

更新必要動作

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

alias
必要

必要動作的別名

null

Body 參數

名稱

描述

預設值

模式

RequiredActionProviderRepresentation
選用

RequiredActionProviderRepresentation

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

提高必要動作的優先順序

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

alias
必要

必要動作的別名

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得必要動作。傳回必要動作的串流。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

List[RequiredActionProviderRepresentation]

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

取得未註冊的必要動作。傳回未註冊必要動作的串流。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

List[[string]]

用戶端屬性憑證

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

取得用戶端的金鑰儲存檔案，其中包含私密金鑰和公開憑證

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

attr
必要

null

Body 參數

名稱

描述

預設值

模式

KeyStoreConfig
選用

KeyStoreConfig

內容類型

application/octet-stream

回應

代碼

訊息

資料類型

200

[File]

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

產生新的金鑰配對和憑證，並取得私密金鑰檔案。產生金鑰配對和憑證，並以指定的金鑰儲存格式提供私密金鑰。只有產生的公開憑證會儲存在 Keycloak 資料庫中，私密金鑰則不會。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

attr
必要

null

Body 參數

名稱

描述

預設值

模式

KeyStoreConfig
選用

KeyStoreConfig

內容類型

application/octet-stream

回應

代碼

訊息

資料類型

200

[File]

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

以新的金鑰配對產生新的憑證

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

attr
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

取得金鑰資訊

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

attr
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

僅上傳憑證，不含私密金鑰

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

attr
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

上傳憑證，並視情況上傳私密金鑰

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

attr
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

ClientInitialAccessCreatePresentation

用戶端初始存取

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

List[ClientInitialAccessPresentation]

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

id
必要

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

建立新的初始存取權杖。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

Body 參數

名稱

描述

預設值

模式

ClientInitialAccessCreatePresentation
選用

內容類型

application/json

回應

代碼

訊息

資料類型

201

已建立

ClientInitialAccessCreatePresentation

用戶端註冊策略

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

基本路徑，用於檢索具有正確填入 configProperties 的提供者

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

List[ComponentTypeRepresentation]

用戶端角色對應

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

取得可對應至使用者或群組的可用用戶端層級角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

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
必要

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
必要

realm 名稱 (不是 ID！)

null

group-id
必要

null

client-id
必要

用戶端 ID (不是 clientId!)

null

Body 參數

名稱

描述

預設值

模式

RoleRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得使用者或群組以及應用程式的用戶端層級角色映射

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

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
必要

realm 名稱 (不是 ID！)

null

group-id
必要

null

client-id
必要

用戶端 ID (不是 clientId!)

null

Body 參數

名稱

描述

預設值

模式

RoleRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得可對應至使用者或群組的可用用戶端層級角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

client-id
必要

用戶端 ID (不是 clientId!)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

取得有效的用戶端層級角色映射。這會遞迴任何複合角色。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 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
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

client-id
必要

用戶端 ID (不是 clientId!)

null

Body 參數

名稱

描述

預設值

模式

RoleRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得使用者或群組以及應用程式的用戶端層級角色映射

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

client-id
必要

用戶端 ID (不是 clientId!)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

將用戶端層級角色新增至使用者或群組角色映射

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

client-id
必要

用戶端 ID (不是 clientId!)

null

Body 參數

名稱

描述

預設值

模式

RoleRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

用戶端範圍

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

刪除用戶端範圍

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

回應

代碼

訊息

資料類型

200

<<>>

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

取得用戶端範圍的表示法

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

更新用戶端範圍

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

Body 參數

名稱

描述

預設值

模式

ClientScopeRepresentation
選用

回應

代碼

訊息

資料類型

200

<<>>

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

取得屬於領域的用戶端範圍。傳回屬於該領域的用戶端範圍列表

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

建立新的用戶端範圍。用戶端範圍的名稱必須是唯一的！

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

Body 參數

名稱

描述

預設值

模式

ClientScopeRepresentation
選用

回應

代碼

訊息

資料類型

200

<<>>

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

刪除用戶端範圍

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

回應

代碼

訊息

資料類型

200

<<>>

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

取得用戶端範圍的表示法

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

更新用戶端範圍

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

Body 參數

名稱

描述

預設值

模式

ClientScopeRepresentation
選用

回應

代碼

訊息

資料類型

200

<<>>

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

取得屬於領域的用戶端範圍。傳回屬於該領域的用戶端範圍列表

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

建立新的用戶端範圍。用戶端範圍的名稱必須是唯一的！

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

Body 參數

名稱

描述

預設值

模式

ClientScopeRepresentation
選用

回應

代碼

訊息

資料類型

200

<<>>

用戶端

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

取得用戶端密碼

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

為用戶端產生新的密碼

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

使用戶端的輪換密碼失效

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

回應

代碼

訊息

資料類型

200

<<>>

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

取得輪換的用戶端密碼

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

用戶端範圍 ID
必要

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

用戶端範圍 ID
必要

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得預設的用戶端範圍。只傳回名稱和 ID。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

刪除用戶端

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

建立具有範例存取權杖酬載的 JSON

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

查詢參數

名稱

描述

預設值

模式

範圍
選用

null

userId
選用

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

AccessToken

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

建立具有範例 ID 權杖酬載的 JSON

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

查詢參數

名稱

描述

預設值

模式

範圍
選用

null

userId
選用

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

IDToken

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

建立具有範例使用者資訊酬載的 JSON

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

查詢參數

名稱

描述

預設值

模式

範圍
選用

null

userId
選用

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

Map[<<>>]

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

傳回所有協定對應程式的列表，這些對應程式將在產生針對特定用戶端發出的權杖時使用。

描述

這表示直接指派給此用戶端的協定對應程式，以及指派給此用戶端所有用戶端範圍的協定對應程式。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

查詢參數

名稱

描述

預設值

模式

範圍
選用

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[協定對應程式評估表示法]

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

取得特定角色容器所有角色的有效範圍映射，此用戶端實際上允許在為其發出的存取權杖中擁有這些角色。

描述

這包含此用戶端直接擁有的範圍映射，以及授與給與此用戶端連結的所有用戶端範圍的範圍映射。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

角色容器 ID
必要

領域名稱或用戶端 UUID

null

查詢參數

名稱

描述

預設值

模式

範圍
選用

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

取得此用戶端沒有範圍，並且無法在為其發出的存取權杖中擁有的角色。

描述

實際上是特定角色容器中，不在 {@link #getGrantedScopeMappings()} 中的所有其他角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

角色容器 ID
必要

領域名稱或用戶端 UUID

null

查詢參數

名稱

描述

預設值

模式

範圍
選用

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

取得用戶端的表示法

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

providerId
必要

null

回應

代碼

訊息

資料類型

200

<<>>

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

傳回物件，說明是否已初始化用戶端授權權限以及參照

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

傳回物件，說明是否已初始化用戶端授權權限以及參照

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

Body 參數

名稱

描述

預設值

模式

ManagementPermissionReference
選用

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

從用戶端取消註冊叢集節點

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

節點
必要

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

向用戶端註冊叢集節點。手動向此用戶端註冊叢集節點。通常不需要直接呼叫此方法，因為配接器應該透過將註冊請求傳送至 Keycloak 來處理。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

Body 參數

名稱

描述

預設值

模式

request_body
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得應用程式離線工作階段計數。傳回與此用戶端相關聯的離線使用者工作階段數 { "count": number }

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

地圖[[長整數]]

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

取得用戶端的離線工作階段。傳回與此用戶端相關聯的離線使用者工作階段列表

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

查詢參數

名稱

描述

預設值

模式

first
選用

分頁偏移量

null

max
選用

最大結果大小（預設為 100）

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

用戶端範圍 ID
必要

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

用戶端範圍 ID
必要

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得選用的用戶端範圍。只傳回名稱和 ID。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

將用戶端的撤銷原則推送至其管理員 URL。如果用戶端具有管理員 URL，則將撤銷原則推送至該 URL。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

更新用戶端

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

Body 參數

名稱

描述

預設值

模式

ClientRepresentation
選用

回應

代碼

訊息

資料類型

200

<<>>

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

為用戶端產生新的註冊存取權杖

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

取得專用於服務帳戶的使用者

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

取得應用程式工作階段計數。傳回與此用戶端相關聯的使用者工作階段數 { "count": number }

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

地圖[[長整數]]

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

測試已註冊的叢集節點是否可用。透過傳送「ping」請求至所有叢集節點來測試可用性。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

取得用戶端的使用者工作階段。傳回與此用戶端相關聯的使用者工作階段列表

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

查詢參數

名稱

描述

預設值

模式

first
選用

分頁偏移量

null

max
選用

最大結果大小（預設為 100）

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

GET /admin/realms/{realm}/clients

取得屬於領域的用戶端。

描述

如果由於基礎儲存體的問題而無法從儲存體擷取用戶端，則會從傳回的列表中靜默移除。這可確保對列表的並行修改不會阻止呼叫者擷取此列表。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

查詢參數

名稱

描述

預設值

模式

用戶端 ID
選用

依用戶端 ID 篩選

null

first
選用

第一個結果

null

max
選用

要傳回的最大結果數

null

q
選用

null

搜尋
選用

這是否為搜尋查詢或 getClientById 查詢

false

viewableOnly
選用

篩選管理員無法完整檢視的用戶端

false

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[用戶端表示法]

POST /admin/realms/{realm}/clients

建立新的用戶端。用戶端的 client_id 必須是唯一的！

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

Body 參數

名稱

描述

預設值

模式

ClientRepresentation
選用

回應

代碼

訊息

資料類型

201

已建立

<<>>

元件

GET /admin/realms/{realm}/components

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

查詢參數

名稱

描述

預設值

模式

名稱
選用

null

父項
選用

null

類型
選用

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[元件表示法]

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

id
必要

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

id
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

ComponentRepresentation

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

id
必要

null

Body 參數

名稱

描述

預設值

模式

ComponentRepresentation
選用

ComponentRepresentation

回應

代碼

訊息

資料類型

200

<<>>

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

可用於設定特定父元件的子元件類型列表。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

id
必要

null

查詢參數

名稱

描述

預設值

模式

類型
選用

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

List[ComponentTypeRepresentation]

POST /admin/realms/{realm}/components

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

Body 參數

名稱

描述

預設值

模式

ComponentRepresentation
選用

ComponentRepresentation

回應

代碼

訊息

資料類型

200

<<>>

預設

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

Body 參數

名稱

描述

預設值

模式

ResourceServerRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

Body 參數

名稱

描述

預設值

模式

PolicyEvaluationRequest
選用

PolicyEvaluationRequest

內容類型

application/json

回應

代碼

訊息

資料類型

200

PolicyEvaluationResponse

500

內部伺服器錯誤

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

查詢參數

名稱

描述

預設值

模式

欄位
選用

null

first
選用

null

max
選用

null

名稱
選用

null

擁有者
選用

null

權限
選用

null

原則 ID
選用

null

資源
選用

null

範圍
選用

null

類型
選用

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[抽象原則表示法]

204

無內容

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

Body 參數

名稱

描述

預設值

模式

主體
選用

AbstractPolicyRepresentation

回應

代碼

訊息

資料類型

201

已建立

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[原則提供者表示法]

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

查詢參數

名稱

描述

預設值

模式

欄位
選用

null

名稱
選用

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

204

無內容

<<>>

400

錯誤請求

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

Body 參數

名稱

描述

預設值

模式

PolicyEvaluationRequest
選用

PolicyEvaluationRequest

內容類型

application/json

回應

代碼

訊息

資料類型

200

PolicyEvaluationResponse

500

內部伺服器錯誤

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

查詢參數

名稱

描述

預設值

模式

欄位
選用

null

first
選用

null

max
選用

null

名稱
選用

null

擁有者
選用

null

權限
選用

null

原則 ID
選用

null

資源
選用

null

範圍
選用

null

類型
選用

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[抽象原則表示法]

204

無內容

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

Body 參數

名稱

描述

預設值

模式

主體
選用

AbstractPolicyRepresentation

回應

代碼

訊息

資料類型

201

已建立

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[原則提供者表示法]

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

查詢參數

名稱

描述

預設值

模式

欄位
選用

null

名稱
選用

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

204

無內容

<<>>

400

錯誤請求

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

Body 參數

名稱

描述

預設值

模式

ResourceServerRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

查詢參數

名稱

描述

預設值

模式

id
_選填

null

深度
選用

null

完全符合名稱
選用

null

first
選用

null

符合 URI
選用

null

max
選用

null

名稱
選用

null

擁有者
選用

null

範圍
選用

null

類型
選用

null

URI
選用

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[資源表示法]

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

Body 參數

名稱

描述

預設值

模式

ResourceRepresentation
選用

查詢參數

名稱

描述

預設值

模式

id
_選填

null

深度
選用

null

完全符合名稱
選用

null

first
選用

null

符合 URI
選用

null

max
選用

null

名稱
選用

null

擁有者
選用

null

範圍
選用

null

類型
選用

null

URI
選用

null

內容類型

application/json

回應

代碼

訊息

資料類型

201

已建立

400

錯誤請求

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

資源 ID
必要

null

查詢參數

名稱

描述

預設值

模式

id
_選填

null

深度
選用

null

完全符合名稱
選用

null

first
選用

null

符合 URI
選用

null

max
選用

null

名稱
選用

null

擁有者
選用

null

範圍
選用

null

類型
選用

null

URI
選用

null

回應

代碼

訊息

資料類型

200

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

資源 ID
必要

null

查詢參數

名稱

描述

預設值

模式

id
_選填

null

深度
選用

null

完全符合名稱
選用

null

first
選用

null

符合 URI
選用

null

max
選用

null

名稱
選用

null

擁有者
選用

null

範圍
選用

null

類型
選用

null

URI
選用

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

404

找不到

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

資源 ID
必要

null

查詢參數

名稱

描述

預設值

模式

id
_選填

null

深度
選用

null

完全符合名稱
選用

null

first
選用

null

符合 URI
選用

null

max
選用

null

名稱
選用

null

擁有者
選用

null

範圍
選用

null

類型
選用

null

URI
選用

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

404

找不到

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

資源 ID
必要

null

查詢參數

名稱

描述

預設值

模式

id
_選填

null

深度
選用

null

完全符合名稱
選用

null

first
選用

null

符合 URI
選用

null

max
選用

null

名稱
選用

null

擁有者
選用

null

範圍
選用

null

類型
選用

null

URI
選用

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[原則表示法]

404

找不到

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

資源 ID
必要

null

Body 參數

名稱

描述

預設值

模式

ResourceRepresentation
選用

查詢參數

名稱

描述

預設值

模式

id
_選填

null

深度
選用

null

完全符合名稱
選用

null

first
選用

null

符合 URI
選用

null

max
選用

null

名稱
選用

null

擁有者
選用

null

範圍
選用

null

類型
選用

null

URI
選用

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

404

找不到

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

資源 ID
必要

null

查詢參數

名稱

描述

預設值

模式

id
_選填

null

深度
選用

null

完全符合名稱
選用

null

first
選用

null

符合 URI
選用

null

max
選用

null

名稱
選用

null

擁有者
選用

null

範圍
選用

null

類型
選用

null

URI
選用

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[範圍表示法]

404

找不到

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

查詢參數

名稱

描述

預設值

模式

id
_選填

null

深度
選用

null

完全符合名稱
選用

null

first
選用

null

符合 URI
選用

null

max
選用

null

擁有者
選用

null

範圍
選用

null

類型
選用

null

URI
選用

null

名稱
選用

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

400

錯誤請求

<<>>

204

無內容

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

查詢參數

名稱

描述

預設值

模式

first
選用

null

max
選用

null

名稱
選用

null

範圍 ID
選用

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[範圍表示法]

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

Body 參數

名稱

描述

預設值

模式

ScopeRepresentation
選用

ScopeRepresentation

回應

代碼

訊息

資料類型

200

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

範圍 ID
必要

null

回應

代碼

訊息

資料類型

200

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

範圍 ID
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

ScopeRepresentation

404

找不到

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

範圍 ID
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[原則表示法]

404

找不到

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

範圍 ID
必要

null

Body 參數

名稱

描述

預設值

模式

ScopeRepresentation
選用

ScopeRepresentation

回應

代碼

訊息

資料類型

200

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

範圍 ID
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[資源表示法]

404

找不到

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

查詢參數

名稱

描述

預設值

模式

名稱
選用

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[範圍表示法]

204

無內容

<<>>

400

錯誤請求

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

群組

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

傳回群組計數。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

查詢參數

名稱

描述

預設值

模式

搜尋
選用

null

頂層
選用

false

內容類型

application/json

回應

代碼

訊息

資料類型

200

地圖[[長整數]]

GET /admin/realms/{realm}/groups

取得群組階層。只傳回名稱和 ID。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

查詢參數

名稱

描述

預設值

模式

briefRepresentation
選用

true

完全符合
選用

false

first
選用

null

max
選用

null

填入階層
選用

true

q
選用

null

搜尋
選用

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[群組表示法]

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

傳回分頁的子群組列表，這些子群組具有對應於 URL 上群組的父群組

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

group-id
必要

null

查詢參數

名稱

描述

預設值

模式

briefRepresentation
選用

布林值，定義是否傳回簡短的群組表示法（預設：false）

false

完全符合
選用

布林值，定義參數 ""search"" 是否必須完全符合

null

first
選用

要傳回的第一個結果的位置（分頁偏移量）。

null

max
選用

要返回的最大結果數。預設值為 10

null

搜尋
選用

代表確切群組名稱或部分名稱的字串

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[群組表示法]

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

設定或建立子群組。

描述

如果父群組存在，這將只設定父群組。如果群組不存在，則建立它並設定父群組。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

group-id
必要

null

Body 參數

名稱

描述

預設值

模式

GroupRepresentation
選用

回應

代碼

訊息

資料類型

200

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

group-id
必要

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

group-id
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

傳回物件，說明是否已初始化用戶端授權權限以及參照

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

group-id
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

傳回物件，說明是否已初始化用戶端授權權限以及參照

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

group-id
必要

null

Body 參數

名稱

描述

預設值

模式

ManagementPermissionReference
選用

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

取得使用者。返回根據查詢參數篩選的使用者串流

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

group-id
必要

null

查詢參數

名稱

描述

預設值

模式

briefRepresentation
選用

僅返回基本資訊（僅保證返回 id、username、created、first 和 last name、email、enabled 狀態、email 驗證狀態、federation link 和 access。請注意，這表示不會返回使用者屬性、必要動作和 not before）。

null

first
選用

分頁偏移量

null

max
選用

最大結果大小（預設為 100）

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

更新群組，忽略子群組。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

group-id
必要

null

Body 參數

名稱

描述

預設值

模式

GroupRepresentation
選用

回應

代碼

訊息

資料類型

200

<<>>

POST /admin/realms/{realm}/groups

建立或新增頂層 realm 群組。設定或建立子群組。

描述

如果父群組存在，這將更新群組並設定父群組。如果群組不存在，則建立它並設定父群組。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

Body 參數

名稱

描述

預設值

模式

GroupRepresentation
選用

回應

代碼

訊息

資料類型

200

<<>>

身份提供者

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

從 JSON 主體匯入身分提供者

描述

從上傳的 JSON 檔案匯入身分提供者

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

Body 參數

名稱

描述

預設值

模式

request_body
選用

[AnyType]

內容類型

application/json

回應

代碼

訊息

資料類型

200

Map[[string]]

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

刪除身分提供者

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

alias
必要

null

回應

代碼

訊息

資料類型

200

<<>>

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

匯出身分提供者的公用代理組態

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

alias
必要

null

查詢參數

名稱

描述

預設值

模式

格式
選用

要使用的格式

null

回應

代碼

訊息

資料類型

200

<<>>

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

取得身分提供者

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

alias
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

傳回物件，說明是否已初始化用戶端授權權限以及參照

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

alias
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

傳回物件，說明是否已初始化用戶端授權權限以及參照

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

alias
必要

null

Body 參數

名稱

描述

預設值

模式

ManagementPermissionReference
選用

內容類型

application/json

回應

代碼

訊息

資料類型

200

IdentityProviderMapperRepresentation

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

取得身分提供者的對應器類型

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

alias
必要

null

內容類型

*/*

回應

代碼

訊息

資料類型

200

Map[IdentityProviderMapperTypeRepresentation]

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

取得身分提供者的對應器

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

alias
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

List[IdentityProviderMapperRepresentation]

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

刪除身分提供者的對應器

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

alias
必要

null

id
必要

對應器 ID

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

依 ID 取得身分提供者的對應器

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

alias
必要

null

id
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

更新身分提供者的對應器

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

alias
必要

null

id
必要

對應器 ID

null

Body 參數

名稱

描述

預設值

模式

IdentityProviderMapperRepresentation
選用

IdentityProviderMapperRepresentation

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

新增對應器至身分提供者

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

alias
必要

null

Body 參數

名稱

描述

預設值

模式

IdentityProviderMapperRepresentation
選用

IdentityProviderMapperRepresentation

回應

代碼

訊息

資料類型

200

<<>>

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

更新身分提供者

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

alias
必要

null

Body 參數

名稱

描述

預設值

模式

IdentityProviderRepresentation
選用

回應

代碼

訊息

資料類型

200

<<>>

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

如果提供者支援，則重新載入身分提供者的金鑰。如果已執行重新載入，則返回「true」，如果沒有，則返回「false」。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

alias
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

[Boolean]

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

列出身分提供者

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

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
必要

realm 名稱 (不是 ID！)

null

Body 參數

名稱

描述

預設值

模式

IdentityProviderRepresentation
選用

KeysMetadataRepresentation

回應

代碼

訊息

資料類型

200

<<>>

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

取得該提供者 ID 的身分提供者工廠

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

provider_id
必要

要取得工廠的提供者 ID

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

[Object]

金鑰

GET /admin/realms/{realm}/keys

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

組織

GET /admin/realms/{realm}/organizations

返回根據指定參數篩選的分頁組織清單

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

查詢參數

名稱

描述

預設值

模式

完全符合
選用

布林值，定義參數「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
必要

realm 名稱 (不是 ID！)

null

id
必要

null

回應

代碼

訊息

資料類型

200

<<>>

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

返回組織表示法

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

id
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

OrganizationRepresentation

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

從組織中移除具有指定別名的身分提供者

描述

中斷身分提供者與組織之間的關聯。提供者本身不會被刪除。如果找不到提供者，或目前未與組織關聯，則會返回錯誤回應

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

id
必要

null

alias
必要

null

回應

代碼

訊息

資料類型

200

<<>>

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

返回與具有指定別名的組織關聯的身分提供者

描述

搜尋具有指定別名的身分提供者。如果找到一個且與組織關聯，則會返回它。否則，會返回狀態為 NOT_FOUND 的錯誤回應

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

id
必要

null

alias
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

返回與組織關聯的所有身分提供者

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

id
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

List[IdentityProviderRepresentation]

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

將具有指定 ID 的身分提供者新增至組織

描述

新增或關聯現有的身分提供者與組織。如果找不到身分提供者，或它已與組織關聯，則會返回錯誤回應

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

id
必要

null

Body 參數

名稱

描述

預設值

模式

主體
選用

回應

代碼

訊息

資料類型

200

<<>>

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

返回組織中的成員數。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

id
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

[Long]

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

返回根據指定參數篩選的分頁組織成員清單

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

id
必要

null

查詢參數

名稱

描述

預設值

模式

完全符合
選用

布林值，定義參數「search」是否必須完全符合

null

first
選用

要處理的第一個結果的位置（分頁偏移量）

null

max
選用

要返回的最大結果數。預設值為 10

null

搜尋
選用

代表成員的使用者名稱、電子郵件、名字或姓氏的字串。

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

List[MemberRepresentation]

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

從組織中移除具有指定 ID 的使用者

描述

中斷使用者與組織之間的關聯。如果會員資格為受管理，則會刪除使用者本身，否則不會刪除使用者。如果找不到使用者，或他們不是組織的成員，則會返回錯誤回應

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

id
必要

null

回應

代碼

訊息

資料類型

200

<<>>

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

返回具有指定 ID 的組織成員

描述

搜尋具有指定 ID 的使用者。如果找到一個且目前為組織的成員，則返回它。否則，會返回狀態為 NOT_FOUND 的錯誤回應

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

id
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

MemberRepresentation

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

返回與具有指定 ID 的使用者關聯的組織

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

id
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

List[OrganizationRepresentation]

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

使用指定的使用者 ID 邀請現有使用者加入組織

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

id
必要

null

表單參數

名稱

描述

預設值

模式

id
選用

null

回應

代碼

訊息

資料類型

200

<<>>

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

根據提供的電子郵件地址，邀請現有使用者或傳送註冊連結給新使用者。

描述

如果具有指定電子郵件地址的使用者存在，則傳送邀請連結，否則傳送註冊連結。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

id
必要

null

表單參數

名稱

描述

預設值

模式

電子郵件
選用

null

名字
選用

null

姓氏
選用

null

回應

代碼

訊息

資料類型

200

<<>>

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

將具有指定 ID 的使用者新增為組織的成員

描述

新增或關聯現有使用者與組織。如果找不到使用者，或它已與組織關聯，則會返回錯誤回應

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

id
必要

null

Body 參數

名稱

描述

預設值

模式

主體
選用

OrganizationRepresentation

回應

代碼

訊息

資料類型

200

<<>>

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

更新組織

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

id
必要

null

Body 參數

名稱

描述

預設值

模式

OrganizationRepresentation
選用

回應

代碼

訊息

資料類型

200

<<>>

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

返回與具有指定 ID 的使用者關聯的組織

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

id
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

List[OrganizationRepresentation]

POST /admin/realms/{realm}/organizations

建立新的組織

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

Body 參數

名稱

描述

預設值

模式

OrganizationRepresentation
選用

OrganizationRepresentation

回應

代碼

訊息

資料類型

200

<<>>

協定對應器

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

建立多個對應器

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

Body 參數

名稱

描述

預設值

模式

ProtocolMapperRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得對應器

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

刪除對應器

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

id
必要

對應器 ID

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

依 ID 取得對應器

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

id
必要

對應器 ID

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

更新對應器

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

id
必要

對應器 ID

null

Body 參數

名稱

描述

預設值

模式

ProtocolMapperRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

建立對應器

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

Body 參數

名稱

描述

預設值

模式

ProtocolMapperRepresentation
選用

回應

代碼

訊息

資料類型

200

<<>>

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

依名稱取得特定通訊協定的對應器

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

通訊協定
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

建立多個對應器

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

Body 參數

名稱

描述

預設值

模式

ProtocolMapperRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得對應器

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

刪除對應器

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

id
必要

對應器 ID

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

依 ID 取得對應器

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

id
必要

對應器 ID

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

更新對應器

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

id
必要

對應器 ID

null

Body 參數

名稱

描述

預設值

模式

ProtocolMapperRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

建立對應器

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

Body 參數

名稱

描述

預設值

模式

ProtocolMapperRepresentation
選用

回應

代碼

訊息

資料類型

200

<<>>

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

依名稱取得特定通訊協定的對應器

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

通訊協定
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

建立多個對應器

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

Body 參數

名稱

描述

預設值

模式

ProtocolMapperRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得對應器

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

刪除對應器

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

id
必要

對應器 ID

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

依 ID 取得對應器

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

id
必要

對應器 ID

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

更新對應器

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

id
必要

對應器 ID

null

Body 參數

名稱

描述

預設值

模式

ProtocolMapperRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

建立對應器

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

Body 參數

名稱

描述

預設值

模式

ProtocolMapperRepresentation
選用

回應

代碼

訊息

資料類型

200

<<>>

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

依名稱取得特定通訊協定的對應器

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

通訊協定
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

Realm 管理

GET /admin/realms

取得可存取的 realm。返回可存取 realm 的清單。該清單會根據呼叫者允許檢視的 realm 進行篩選。

參數

查詢參數

名稱

描述

預設值

模式

briefRepresentation
選用

false

內容類型

application/json

回應

代碼

訊息

資料類型

200

List[RealmRepresentation]

POST /admin/realms

匯入 realm。從該 realm 的完整表示法匯入 realm。

描述

Realm 名稱必須是唯一的。

參數

Body 參數

名稱

描述

預設值

模式

主體
選用

[檔案]

回應

代碼

訊息

資料類型

201

已建立

<<>>

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

刪除所有管理員事件

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得管理員事件。返回所有管理員事件，或根據此處列出的 URL 查詢參數篩選事件

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

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
必要

realm 名稱 (不是 ID！)

null

Body 參數

名稱

描述

預設值

模式

主體
選用

內容類型

application/json

回應

代碼

訊息

資料類型

200

ClientPoliciesRepresentation

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

查詢參數

名稱

描述

預設值

模式

include-global-policies
選用

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

Body 參數

名稱

描述

預設值

模式

ClientPoliciesRepresentation
選用

ClientPoliciesRepresentation

回應

代碼

訊息

資料類型

200

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

查詢參數

名稱

描述

預設值

模式

include-global-profiles
選用

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

ClientProfilesRepresentation

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

Body 參數

名稱

描述

預設值

模式

ClientProfilesRepresentation
選用

ClientProfilesRepresentation

回應

代碼

訊息

資料類型

200

<<>>

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

取得用戶端工作階段統計資料。返回 JSON 對應。

描述

索引鍵是用戶端 ID，值是目前與該用戶端作用中的工作階段數。只有實際上有與之關聯工作階段的用戶端才會在此對應中。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

List[[string]]

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

列出目前 realm 中可用的所有用戶端類型

描述

此端點返回全域和 realm 層級用戶端類型的清單及其設定的屬性

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

ClientTypesRepresentation

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

更新用戶端類型

描述

此端點允許您更新 realm 層級的用戶端類型

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

Body 參數

名稱

描述

預設值

模式

ClientTypesRepresentation
選用

ClientTypesRepresentation

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

List[[string]]

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得 realm 預設用戶端範圍。僅返回名稱和 ID。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

取得群組階層。只傳回名稱和 ID。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[群組表示法]

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

groupId
必要

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

groupId
必要

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得 realm 選用用戶端範圍。僅返回名稱和 ID。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

RealmEventsConfigRepresentation

DELETE /admin/realms/{realm}

刪除 realm

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得事件提供者組態。返回包含事件提供者組態的 JSON 物件

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

描述

更新事件提供者。變更事件提供者和/或其組態

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

Body 參數

名稱

描述

預設值

模式

RealmEventsConfigRepresentation
選用

RealmEventsConfigRepresentation

回應

代碼

訊息

資料類型

204

無內容

<<>>

DELETE /admin/realms/{realm}/events

刪除所有事件

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

GET /admin/realms/{realm}/events

取得事件。返回所有事件，或根據此處列出的 URL 查詢參數篩選事件

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

查詢參數

名稱

描述

預設值

模式

client
選用

應用程式或 OAuth 用戶端名稱

null

dateFrom
選用

起始日期

null

dateTo
選用

結束日期

null

first
選用

分頁偏移量

null

ipAddress
選用

IP 位址

null

max
選用

最大結果大小（預設為 100）

null

類型
選用

要返回的事件類型 [String]

null

user
選用

使用者 ID

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[EventRepresentation]

GET /admin/realms/{realm}

取得領域的頂層表示。它不包含巢狀資訊，如使用者和客戶端表示。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

RealmRepresentation

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

路徑
必要

null

/.*/

內容類型

application/json

回應

代碼

訊息

資料類型

200

GET /admin/realms/{realm}/localization

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

List[[string]]

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

地區設定
必要

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

地區設定
必要

null

查詢參數

名稱

描述

預設值

模式

useRealmDefaultLocaleFallback
選用

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

Map[[string]]

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

金鑰
必要

null

地區設定
必要

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

金鑰
必要

null

地區設定
必要

null

內容類型

text/plain

回應

代碼

訊息

資料類型

200

[String]

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

金鑰
必要

null

地區設定
必要

null

Body 參數

名稱

描述

預設值

模式

主體
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

從上傳的 JSON 檔案匯入本地化

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

地區設定
必要

null

Body 參數

名稱

描述

預設值

模式

request_body
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

移除所有使用者工作階段。

描述

任何具有管理員 URL 的客戶端也會被告知使其擁有的任何工作階段失效。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

將現有領域部分匯出為 JSON 檔案。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

查詢參數

名稱

描述

預設值

模式

exportClients
選用

null

exportGroupsAndRoles
選用

null

回應

代碼

訊息

資料類型

200

<<>>

POST /admin/realms/{realm}/partialImport

從 JSON 檔案部分匯入到現有領域。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

Body 參數

名稱

描述

預設值

模式

主體
選用

[檔案]

回應

代碼

訊息

資料類型

200

<<>>

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

將領域的撤銷策略推送到任何與其關聯的管理員 URL 的客戶端。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

PUT /admin/realms/{realm}

更新領域的頂層資訊。表示中的任何使用者、角色或客戶端資訊都將被忽略。

描述

這只會更新領域的頂層屬性。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

Body 參數

名稱

描述

預設值

模式

RealmRepresentation
選用

RealmRepresentation

回應

代碼

訊息

資料類型

200

<<>>

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

移除特定使用者工作階段。

描述

任何具有管理員 URL 的客戶端也會被告知使此特定工作階段失效。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

工作階段
必要

null

查詢參數

名稱

描述

預設值

模式

isOffline
選用

false

回應

代碼

訊息

資料類型

204

無內容

<<>>

POST /admin/realms/{realm}/testSMTPConnection

使用目前登入的使用者測試 SMTP 連線

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

Body 參數

名稱

描述

預設值

模式

request_body
選用

回應

代碼

訊息

資料類型

200

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

Body 參數

名稱

描述

預設值

模式

ManagementPermissionReference
選用

內容類型

application/json

回應

代碼

訊息

資料類型

200

角色對應器

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

取得角色對應

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

group-id
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

取得可對應的領域級別角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

group-id
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

取得有效的領域級別角色對應。這將遞迴所有複合角色以取得結果。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

group-id
必要

null

查詢參數

名稱

描述

預設值

模式

briefRepresentation
選用

如果為 false，則傳回具有其屬性的角色

true

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

刪除領域級別的角色對應

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

group-id
必要

null

Body 參數

名稱

描述

預設值

模式

RoleRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得領域級別角色對應

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

group-id
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

將領域級別的角色對應新增至使用者

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

group-id
必要

null

Body 參數

名稱

描述

預設值

模式

RoleRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得角色對應

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

取得可對應的領域級別角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

取得有效的領域級別角色對應。這將遞迴所有複合角色以取得結果。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

查詢參數

名稱

描述

預設值

模式

briefRepresentation
選用

如果為 false，則傳回具有其屬性的角色

true

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

刪除領域級別的角色對應

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

Body 參數

名稱

描述

預設值

模式

RoleRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得領域級別角色對應

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

將領域級別的角色對應新增至使用者

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

Body 參數

名稱

描述

預設值

模式

RoleRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

角色

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

取得領域或客戶端的所有角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

查詢參數

名稱

描述

預設值

模式

briefRepresentation
選用

true

first
選用

null

max
選用

null

搜尋
選用

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

為領域或客戶端建立新角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

Body 參數

名稱

描述

預設值

模式

RoleRepresentation
選用

回應

代碼

訊息

資料類型

200

<<>>

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

取得角色複合中客戶端的客戶端級別角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

null

角色名稱
必要

角色名稱（不是 ID！）

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

從角色的複合中移除角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

角色名稱
必要

角色名稱（不是 ID！）

null

Body 參數

名稱

描述

預設值

模式

RoleRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得角色的複合

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

角色名稱
必要

角色名稱（不是 ID！）

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

將複合新增至角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

角色名稱
必要

角色名稱（不是 ID！）

null

Body 參數

名稱

描述

預設值

模式

RoleRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得角色複合的領域級別角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

角色名稱
必要

角色名稱（不是 ID！）

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

依名稱刪除角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

角色名稱
必要

角色名稱（不是 ID！）

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

依名稱取得角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

角色名稱
必要

角色名稱（不是 ID！）

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

傳回具有指定角色名稱的群組串流

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

角色名稱
必要

角色名稱。

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
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

角色名稱
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

傳回物件，指出角色授權權限是否已初始化，以及參考

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

角色名稱
必要

null

Body 參數

名稱

描述

預設值

模式

ManagementPermissionReference
選用

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

依名稱更新角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

角色名稱
必要

角色名稱（不是 ID！）

null

Body 參數

名稱

描述

預設值

模式

RoleRepresentation
選用

回應

代碼

訊息

資料類型

200

<<>>

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

傳回具有指定角色名稱的使用者串流。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

角色名稱
必要

角色名稱。

null

查詢參數

名稱

描述

預設值

模式

briefRepresentation
選用

布林值，定義是否返回簡短表示法（預設值：false）

null

first
選用

要傳回的第一個結果。如果為負數或 {@code null}，則忽略。

null

max
選用

要傳回的最大結果數。如果為負數或 {@code null}，則忽略。

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

GET /admin/realms/{realm}/roles

取得領域或客戶端的所有角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

查詢參數

名稱

描述

預設值

模式

briefRepresentation
選用

true

first
選用

null

max
選用

null

搜尋
選用

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

POST /admin/realms/{realm}/roles

為領域或客戶端建立新角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

Body 參數

名稱

描述

預設值

模式

RoleRepresentation
選用

回應

代碼

訊息

資料類型

200

<<>>

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

取得角色複合中客戶端的客戶端級別角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

null

角色名稱
必要

角色名稱（不是 ID！）

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

從角色的複合中移除角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

角色名稱
必要

角色名稱（不是 ID！）

null

Body 參數

名稱

描述

預設值

模式

RoleRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得角色的複合

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

角色名稱
必要

角色名稱（不是 ID！）

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

將複合新增至角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

角色名稱
必要

角色名稱（不是 ID！）

null

Body 參數

名稱

描述

預設值

模式

RoleRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得角色複合的領域級別角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

角色名稱
必要

角色名稱（不是 ID！）

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

依名稱刪除角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

角色名稱
必要

角色名稱（不是 ID！）

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

依名稱取得角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

角色名稱
必要

角色名稱（不是 ID！）

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

傳回具有指定角色名稱的群組串流

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

角色名稱
必要

角色名稱。

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
必要

realm 名稱 (不是 ID！)

null

角色名稱
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

傳回物件，指出角色授權權限是否已初始化，以及參考

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

角色名稱
必要

null

Body 參數

名稱

描述

預設值

模式

ManagementPermissionReference
選用

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

依名稱更新角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

角色名稱
必要

角色名稱（不是 ID！）

null

Body 參數

名稱

描述

預設值

模式

RoleRepresentation
選用

回應

代碼

訊息

資料類型

200

<<>>

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

傳回具有指定角色名稱的使用者串流。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

角色名稱
必要

角色名稱。

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
必要

realm 名稱 (不是 ID！)

null

clientUuid
必要

null

角色 ID
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

從角色的複合中移除一組角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

角色 ID
必要

角色 ID

null

Body 參數

名稱

描述

預設值

模式

RoleRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得角色的子項。如果角色為複合角色，則傳回一組角色的子項。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

角色 ID
必要

null

查詢參數

名稱

描述

預設值

模式

first
選用

null

max
選用

null

搜尋
選用

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

透過關聯一些子角色，使角色成為複合角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

角色 ID
必要

null

Body 參數

名稱

描述

預設值

模式

RoleRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得角色複合中的領域級別角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

角色 ID
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

刪除角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

角色 ID
必要

角色 ID

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得特定角色的表示

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

角色 ID
必要

角色 ID

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

傳回物件，指出角色授權權限是否已初始化，以及參考

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

角色 ID
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

傳回物件，指出角色授權權限是否已初始化，以及參考

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

角色 ID
必要

null

Body 參數

名稱

描述

預設值

模式

ManagementPermissionReference
選用

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

更新角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

角色 ID
必要

角色 ID

null

Body 參數

名稱

描述

預設值

模式

RoleRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

範圍對應

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

可用的客戶端級別角色。傳回可與客戶端範圍關聯的客戶端角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

client
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

取得有效的客戶端角色。傳回與客戶端範圍關聯的客戶端角色。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

client
必要

null

查詢參數

名稱

描述

預設值

模式

briefRepresentation
選用

如果為 false，則傳回具有其屬性的角色

true

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

從客戶端的範圍移除客戶端級別的角色。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

client
必要

null

Body 參數

名稱

描述

預設值

模式

RoleRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得與客戶端範圍關聯的角色。傳回客戶端的角色。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

client
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

將客戶端級別的角色新增至客戶端的範圍

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

client
必要

null

Body 參數

名稱

描述

預設值

模式

RoleRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得客戶端的所有範圍對應

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

取得可附加到此客戶端範圍的領域級別角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

取得與客戶端範圍關聯的有效領域級別角色。這會遞迴任何與客戶端範圍關聯的複合角色，並將角色新增至此清單。

描述

該方法實際上是顯示與客戶端關聯的領域級別角色的全面總體檢視。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

查詢參數

名稱

描述

預設值

模式

briefRepresentation
選用

如果為 false，則傳回具有其屬性的角色

true

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

從客戶端範圍中移除一組領域級別的角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

Body 參數

名稱

描述

預設值

模式

RoleRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得與客戶端範圍關聯的領域級別角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

將一組領域級別角色新增至客戶端的範圍

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

Body 參數

名稱

描述

預設值

模式

RoleRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

可用的客戶端級別角色。傳回可與客戶端範圍關聯的客戶端角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

client
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

取得有效的客戶端角色。傳回與客戶端範圍關聯的客戶端角色。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

client
必要

null

查詢參數

名稱

描述

預設值

模式

briefRepresentation
選用

如果為 false，則傳回具有其屬性的角色

true

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

從客戶端的範圍移除客戶端級別的角色。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

client
必要

null

Body 參數

名稱

描述

預設值

模式

RoleRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得與客戶端範圍關聯的角色。傳回客戶端的角色。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

client
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

將客戶端級別的角色新增至客戶端的範圍

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

client
必要

null

Body 參數

名稱

描述

預設值

模式

RoleRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得客戶端的所有範圍對應

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

取得可附加到此客戶端範圍的領域級別角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

取得與客戶端範圍關聯的有效領域級別角色。這會遞迴任何與客戶端範圍關聯的複合角色，並將角色新增至此清單。

描述

該方法實際上是顯示與客戶端關聯的領域級別角色的全面總體檢視。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

查詢參數

名稱

描述

預設值

模式

briefRepresentation
選用

如果為 false，則傳回具有其屬性的角色

true

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

從客戶端範圍中移除一組領域級別的角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

Body 參數

名稱

描述

預設值

模式

RoleRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得與客戶端範圍關聯的領域級別角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

將一組領域級別角色新增至客戶端的範圍

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

用戶端範圍 ID
必要

null

Body 參數

名稱

描述

預設值

模式

RoleRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

可用的客戶端級別角色。傳回可與客戶端範圍關聯的客戶端角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

client
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

取得有效的客戶端角色。傳回與客戶端範圍關聯的客戶端角色。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

client
必要

null

查詢參數

名稱

描述

預設值

模式

briefRepresentation
選用

如果為 false，則傳回具有其屬性的角色

true

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

從客戶端的範圍移除客戶端級別的角色。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

client
必要

null

Body 參數

名稱

描述

預設值

模式

RoleRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得與客戶端範圍關聯的角色。傳回客戶端的角色。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

client
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

將客戶端級別的角色新增至客戶端的範圍

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

client
必要

null

Body 參數

名稱

描述

預設值

模式

RoleRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得客戶端的所有範圍對應

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

取得可附加到此客戶端範圍的領域級別角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

取得與客戶端範圍關聯的有效領域級別角色。這會遞迴任何與客戶端範圍關聯的複合角色，並將角色新增至此清單。

描述

該方法實際上是顯示與客戶端關聯的領域級別角色的全面總體檢視。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

查詢參數

名稱

描述

預設值

模式

briefRepresentation
選用

如果為 false，則傳回具有其屬性的角色

true

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

從客戶端範圍中移除一組領域級別的角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

Body 參數

名稱

描述

預設值

模式

RoleRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得與客戶端範圍關聯的領域級別角色

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[角色表示法]

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

將一組領域級別角色新增至客戶端的範圍

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

client-uuid
必要

用戶端的 ID (不是用戶端 ID！)

null

Body 參數

名稱

描述

預設值

模式

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
必要

realm 名稱 (不是 ID！)

null

查詢參數

名稱

描述

預設值

模式

電子郵件
選用

電子郵件篩選器

null

emailVerified
選用

null

已啟用
選用

表示使用者是否已啟用的布林值

null

名字
選用

名字篩選器

null

姓氏
選用

姓氏篩選器

null

q
選用

null

搜尋
選用

以下所有欄位的任意搜尋字串。預設搜尋行為是基於前綴的（例如，foo 或 foo*）。使用 foo 進行中綴搜尋，並使用 "foo" 進行精確搜尋。

null

使用者名稱
選用

使用者名稱篩選器

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

[整數]

GET /admin/realms/{realm}/users

取得使用者。傳回使用者串流，根據查詢參數進行篩選。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

查詢參數

名稱

描述

預設值

模式

briefRepresentation
選用

布林值，定義是否返回簡短表示法（預設值：false）

null

電子郵件
選用

包含在電子郵件中的字串，或完整的電子郵件（如果參數 "exact" 為 true）

null

emailVerified
選用

電子郵件是否已驗證

null

已啟用
選用

表示使用者是否已啟用的布林值

null

完全符合
選用

布林值，定義參數 "last"、"first"、"email" 和 "username" 是否必須完全符合

null

first
選用

分頁偏移量

null

名字
選用

包含在名字中的字串，或完整名字（如果參數 "exact" 為 true）

null

idpAlias
選用

連結至使用者的身分提供者別名

null

idpUserId
選用

連結至使用者的身分提供者使用者 ID

null

姓氏
選用

包含在姓氏中的字串，或完整姓氏（如果參數 "exact" 為 true）

null

max
選用

最大結果大小（預設為 100）

null

q
選用

以「key1:value2 key2:value2」格式搜尋自訂屬性的查詢

null

搜尋
選用

包含在使用者名稱、名字或姓氏或電子郵件中的字串。預設搜尋行為是基於前綴的（例如，foo 或 foo*）。使用 foo 進行中綴搜尋，並使用 "foo" 進行精確搜尋。

null

使用者名稱
選用

包含在使用者名稱中的字串，或完整使用者名稱（如果參數 "exact" 為 true）

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

POST /admin/realms/{realm}/users

建立新使用者。使用者名稱必須是唯一的。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

Body 參數

名稱

描述

預設值

模式

UserRepresentation
選用

回應

代碼

訊息

資料類型

200

<<>>

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

描述

取得使用者設定檔的組態

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

UPConfig

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

描述

從組態取得 UserProfileMetadata

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

UserProfileMetadata

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

描述

設定使用者設定檔的組態

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

Body 參數

名稱

描述

預設值

模式

UPConfig
選用

UPConfig

內容類型

application/json

回應

代碼

訊息

資料類型

200

UPConfig

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

傳回憑證類型，這些類型由儲存使用者的使用者儲存空間提供。

描述

傳回值可能包含例如「password」、「otp」等。對於沒有任何使用者儲存空間支援的「local」使用者，這將始終傳回空列表。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

List[[string]]

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

撤銷特定用戶端對使用者的同意和離線權杖

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

client
必要

用戶端 ID

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得使用者授予的同意

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

List[[AnyType]]

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

移除使用者的憑證

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

credentialId
必要

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

將憑證移動到另一個憑證之後的位置

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

credentialId
必要

要移動的憑證

null

newPreviousCredentialId
必要

將成為列表中前一個元素的憑證。如果設定為 null，則移動的憑證將成為列表中的第一個元素。

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

將憑證移動到使用者憑證列表中的第一個位置

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

credentialId
必要

要移動的憑證

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

更新使用者的憑證標籤

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

credentialId
必要

null

Body 參數

名稱

描述

預設值

模式

主體
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

List[CredentialRepresentation]

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

刪除使用者

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

回應

代碼

訊息

資料類型

200

<<>>

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

停用特定類型使用者的所有憑證

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

Body 參數

名稱

描述

預設值

模式

string
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

向使用者發送一封電子郵件，其中包含使用者可以點擊以執行特定操作的連結。

描述

電子郵件包含一個連結，使用者可以點擊該連結來執行一組必要的操作。redirectUri 和 clientId 參數是可選的。如果沒有提供重新導向，那麼在操作完成後將沒有連結返回點擊。重新導向 URI 必須是特定 clientId 的有效 URI。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

Body 參數

名稱

描述

預設值

模式

string
選用

查詢參數

名稱

描述

預設值

模式

client_id
選用

用戶端 ID

null

lifespan
選用

產生權杖過期前的秒數

null

redirect_uri
選用

重新導向 URI

null

回應

代碼

訊息

資料類型

200

<<>>

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

取得與使用者關聯的社群登入

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

List[FederatedIdentityRepresentation]

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

從使用者中移除社群登入提供者

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

provider
必要

社群登入提供者 ID

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

將社群登入提供者新增至使用者

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

provider
必要

社群登入提供者 ID

null

回應

代碼

訊息

資料類型

200

<<>>

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

取得使用者的表示形式

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

查詢參數

名稱

描述

預設值

模式

userProfileMetadata
選用

指出是否應將使用者設定檔中繼資料新增至回應中

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

查詢參數

名稱

描述

預設值

模式

搜尋
選用

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

地圖[[長整數]]

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

查詢參數

名稱

描述

預設值

模式

briefRepresentation
選用

true

first
選用

null

max
選用

null

搜尋
選用

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

列表[群組表示法]

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

groupId
必要

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

groupId
必要

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

模擬使用者

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

Map[<<>>]

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

移除與使用者關聯的所有使用者工作階段。同時向所有具有管理 URL 的用戶端發送通知，以使特定使用者的工作階段失效。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

取得與使用者和用戶端關聯的離線工作階段

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

clientUuid
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

更新使用者

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

Body 參數

名稱

描述

預設值

模式

UserRepresentation
選用

回應

代碼

訊息

資料類型

200

<<>>

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

向使用者發送一封電子郵件，其中包含使用者可以點擊以重設其密碼的連結。

描述

redirectUri 和 clientId 參數是可選的。重新導向的預設值是帳戶用戶端。此端點已棄用。請使用 execute-actions-email 傳遞包含 UPDATE_PASSWORD 的列表。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

查詢參數

名稱

描述

預設值

模式

client_id
選用

用戶端 ID

null

redirect_uri
選用

重新導向 URI

null

回應

代碼

訊息

資料類型

200

<<>>

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

為使用者設定新的密碼。

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

Body 參數

名稱

描述

預設值

模式

CredentialRepresentation
選用

回應

代碼

訊息

資料類型

204

無內容

<<>>

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

向使用者發送電子郵件驗證郵件。電子郵件包含一個連結，使用者可以點擊該連結來驗證其電子郵件地址。

描述

redirectUri、clientId 和 lifespan 參數是可選的。重新導向的預設值是帳戶用戶端。lifespan 的預設值是 12 小時

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

查詢參數

名稱

描述

預設值

模式

client_id
選用

用戶端 ID

null

lifespan
選用

產生權杖過期前的秒數

null

redirect_uri
選用

重新導向 URI

null

回應

代碼

訊息

資料類型

200

<<>>

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

取得與使用者關聯的工作階段

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

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

參數

路徑參數

名稱

描述

預設值

模式

realm
必要

realm 名稱 (不是 ID！)

null

使用者 ID
必要

null

內容類型

application/json

回應

代碼

訊息

資料類型

200

Map[[string]]

定義

AbstractPolicyRepresentation

名稱

類型

格式

id
選用

字串

名稱
選用

字串

描述
選用

字串

類型
選用

字串

原則
選用

[字串] 的集合

資源
選用

[字串] 的集合

範圍
選用

[字串] 的集合

邏輯
選用

Logic

決策策略
選用

DecisionStrategy

擁有者
選用

字串

resourcesData
選用

ResourceRepresentation 的集合

scopesData
選用

ScopeRepresentation 的集合

存取

名稱

類型

格式

角色
選用

[字串] 的集合

verify_caller
選用

布林值

AccessToken

名稱

類型

格式

jti
選用

字串

exp
選用

長整數

int64

nbf
選用

長整數

int64

iat
選用

長整數

int64

iss
選用

字串

sub
選用

字串

typ
選用

字串

azp
選用

字串

其他宣告
選用

[AnyType] 的對應

nonce
選用

字串

auth_time
選用

長整數

int64

sid
選用

字串

at_hash
選用

字串

c_hash
選用

字串

名稱
選用

字串

given_name
選用

字串

family_name
選用

字串

middle_name
選用

字串

nickname
選用

字串

preferred_username
選用

字串

profile
選用

字串

picture
選用

字串

website
選用

字串

電子郵件
選用

字串

email_verified
選用

布林值

gender
選用

字串

birthdate
選用

字串

zoneinfo
選用

字串

地區設定
選用

字串

phone_number
選用

字串

phone_number_verified
選用

布林值

address
選用

AddressClaimSet

updated_at
選用

長整數

int64

claims_locales
選用

字串

acr
選用

字串

s_hash
選用

字串

trusted-certs
選用

[字串] 的集合

allowed-origins
選用

[字串] 的集合

realm_access
選用

存取

resource_access
選用

Access 的對應

authorization
選用

授權

cnf
選用

Confirmation

範圍
選用

字串

AddressClaimSet

名稱

類型

格式

formatted
選用

字串

street_address
選用

字串

locality
選用

字串

region
選用

字串

postal_code
選用

字串

country
選用

字串

AdminEventRepresentation

名稱

類型

格式

time
選用

長整數

int64

realmId
選用

字串

authDetails
選用

AuthDetailsRepresentation

operationType
選用

字串

resourceType
選用

字串

resourcePath
選用

字串

representation
選用

字串

error
選用

字串

ApplicationRepresentation

名稱

類型

格式

id
選用

字串

用戶端 ID
選用

字串

描述
選用

字串

類型
選用

字串

rootUrl
選用

字串

adminUrl
選用

字串

baseUrl
選用

字串

surrogateAuthRequired
選用

布林值

已啟用
選用

布林值

alwaysDisplayInConsole
選用

布林值

clientAuthenticatorType
選用

字串

secret
選用

字串

registrationAccessToken
選用

字串

defaultRoles
選用

[字串] 的列表

redirectUris
選用

[字串] 的列表

webOrigins
選用

[字串] 的列表

notBefore
選用

整數

int32

bearerOnly
選用

布林值

consentRequired
選用

布林值

standardFlowEnabled
選用

布林值

implicitFlowEnabled
選用

布林值

directAccessGrantsEnabled
選用

布林值

serviceAccountsEnabled
選用

布林值

authorizationServicesEnabled
選用

布林值

directGrantsOnly
選用

布林值

publicClient
選用

布林值

frontchannelLogout
選用

布林值

通訊協定
選用

字串

attributes
選用

[字串] 的對應

authenticationFlowBindingOverrides
選用

[字串] 的對應

fullScopeAllowed
選用

布林值

nodeReRegistrationTimeout
選用

整數

int32

registeredNodes
選用

[整數] 的對應

int32

protocolMappers
選用

clientTemplate
選用

字串

useTemplateConfig
選用

布林值

useTemplateScope
選用

布林值

useTemplateMappers
選用

布林值

defaultClientScopes
選用

[字串] 的列表

optionalClientScopes
選用

[字串] 的列表

authorizationSettings
選用

ResourceServerRepresentation

access
選用

[布林值] 的對應

origin
選用

字串

名稱
選用

字串

claims
選用

ApplicationRepresentation_claims

ApplicationRepresentationClaims

名稱

類型

格式

名稱
選用

布林值

使用者名稱
選用

布林值

profile
選用

布林值

picture
選用

布林值

website
選用

布林值

電子郵件
選用

布林值

gender
選用

布林值

地區設定
選用

布林值

address
選用

布林值

phone
選用

布林值

AuthDetailsRepresentation

名稱

類型

格式

realmId
選用

字串

用戶端 ID
選用

字串

userId
選用

字串

ipAddress
選用

字串

AuthenticationExecutionExportRepresentation

名稱

類型

格式

authenticatorConfig
選用

字串

authenticator
選用

字串

authenticatorFlow
選用

布林值

requirement
選用

字串

priority
選用

整數

int32

autheticatorFlow
選用

布林值

flowAlias
選用

字串

userSetupAllowed
選用

布林值

AuthenticationExecutionInfoRepresentation

名稱

類型

格式

id
選用

字串

requirement
選用

字串

displayName
選用

字串

alias
選用

字串

描述
選用

字串

requirementChoices
選用

[字串] 的列表

configurable
選用

布林值

authenticationFlow
選用

布林值

providerId
選用

字串

authenticationConfig
選用

字串

flowId
選用

字串

level
選用

整數

int32

index
選用

整數

int32

priority
選用

整數

int32

AuthenticationExecutionRepresentation

名稱

類型

格式

authenticatorConfig
選用

字串

authenticator
選用

字串

authenticatorFlow
選用

布林值

requirement
選用

字串

priority
選用

整數

int32

autheticatorFlow
選用

布林值

id
選用

字串

flowId
選用

字串

parentFlow
選用

字串

AuthenticationFlowRepresentation

名稱

類型

格式

id
選用

字串

alias
選用

字串

描述
選用

字串

providerId
選用

字串

topLevel
選用

布林值

builtIn
選用

布林值

authenticationExecutions
選用

AuthenticationExecutionExportRepresentation 的列表

AuthenticatorConfigInfoRepresentation

名稱

類型

格式

名稱
選用

字串

providerId
選用

字串

helpText
選用

字串

properties
選用

AuthenticatorConfigRepresentation

名稱

類型

格式

id
選用

字串

alias
選用

字串

config
選用

[字串] 的對應

授權

名稱

類型

格式

permissions
選用

Permission 的列表

BruteForceStrategy

名稱

類型

格式

CertificateRepresentation

名稱

類型

格式

privateKey
選用

字串

publicKey
選用

字串

certificate
選用

字串

kid
選用

字串

ClaimRepresentation

名稱

類型

格式

名稱
選用

布林值

使用者名稱
選用

布林值

profile
選用

布林值

picture
選用

布林值

website
選用

布林值

電子郵件
選用

布林值

gender
選用

布林值

地區設定
選用

布林值

address
選用

布林值

phone
選用

布林值

ClientInitialAccessCreatePresentation

名稱

類型

格式

expiration
選用

整數

int32

count
選用

整數

int32

ClientInitialAccessPresentation

名稱

類型

格式

id
選用

字串

token
選用

字串

timestamp
選用

整數

int32

expiration
選用

整數

int32

count
選用

整數

int32

remainingCount
選用

整數

int32

ClientMappingsRepresentation

名稱

類型

格式

id
選用

字串

client
選用

字串

mappings
選用

RoleRepresentation 的列表

ClientPoliciesRepresentation

名稱

類型

格式

原則
選用

ClientPolicyRepresentation 的列表

globalPolicies
選用

ClientPolicyRepresentation 的列表

ClientPolicyConditionRepresentation

名稱

類型

格式

condition
選用

字串

configuration
選用

列表

ClientPolicyExecutorRepresentation

名稱

類型

格式

executor
選用

字串

configuration
選用

列表

ClientPolicyRepresentation

名稱

類型

格式

名稱
選用

字串

描述
選用

字串

已啟用
選用

布林值

conditions
選用

ClientPolicyConditionRepresentation 的列表

profiles
選用

[字串] 的列表

ClientProfileRepresentation

名稱

類型

格式

名稱
選用

字串

描述
選用

字串

executors
選用

ClientPolicyExecutorRepresentation 的列表

ClientProfilesRepresentation

名稱

類型

格式

profiles
選用

ClientProfileRepresentation 的列表

globalProfiles
選用

ClientProfileRepresentation 的列表

ClientRepresentation

名稱

類型

格式

id
選用

字串

用戶端 ID
選用

字串

名稱
選用

字串

描述
選用

字串

類型
選用

字串

rootUrl
選用

字串

adminUrl
選用

字串

baseUrl
選用

字串

surrogateAuthRequired
選用

布林值

已啟用
選用

布林值

alwaysDisplayInConsole
選用

布林值

clientAuthenticatorType
選用

字串

secret
選用

字串

registrationAccessToken
選用

字串

defaultRoles
選用

[字串] 的列表

redirectUris
選用

[字串] 的列表

webOrigins
選用

[字串] 的列表

notBefore
選用

整數

int32

bearerOnly
選用

布林值

consentRequired
選用

布林值

standardFlowEnabled
選用

布林值

implicitFlowEnabled
選用

布林值

directAccessGrantsEnabled
選用

布林值

serviceAccountsEnabled
選用

布林值

authorizationServicesEnabled
選用

布林值

directGrantsOnly
選用

布林值

publicClient
選用

布林值

frontchannelLogout
選用

布林值

通訊協定
選用

字串

attributes
選用

[字串] 的對應

authenticationFlowBindingOverrides
選用

[字串] 的對應

fullScopeAllowed
選用

布林值

nodeReRegistrationTimeout
選用

整數

int32

registeredNodes
選用

[整數] 的對應

int32

protocolMappers
選用

clientTemplate
選用

字串

useTemplateConfig
選用

布林值

useTemplateScope
選用

布林值

useTemplateMappers
選用

布林值

defaultClientScopes
選用

[字串] 的列表

optionalClientScopes
選用

[字串] 的列表

authorizationSettings
選用

ResourceServerRepresentation

access
選用

[布林值] 的對應

origin
選用

字串

ClientScopeRepresentation

名稱

類型

格式

id
選用

字串

名稱
選用

字串

描述
選用

字串

通訊協定
選用

字串

attributes
選用

[字串] 的對應

protocolMappers
選用

ClientTemplateRepresentation

名稱

類型

格式

id
選用

字串

名稱
選用

字串

描述
選用

字串

通訊協定
選用

字串

fullScopeAllowed
選用

布林值

bearerOnly
選用

布林值

consentRequired
選用

布林值

standardFlowEnabled
選用

布林值

implicitFlowEnabled
選用

布林值

directAccessGrantsEnabled
選用

布林值

serviceAccountsEnabled
選用

布林值

publicClient
選用

布林值

frontchannelLogout
選用

布林值

attributes
選用

[字串] 的對應

protocolMappers
選用

ClientTypeRepresentation

名稱

類型

格式

名稱
選用

字串

provider
選用

字串

父項
選用

字串

config
選用

PropertyConfig 的對應

ClientTypesRepresentation

名稱

類型

格式

client-types
選用

ClientTypeRepresentation 的列表

global-client-types
選用

ClientTypeRepresentation 的列表

ComponentExportRepresentation

名稱

類型

格式

id
選用

字串

名稱
選用

字串

providerId
選用

字串

subType
選用

字串

subComponents
選用

[陣列] 的對應

config
選用

[陣列] 的對應

ComponentRepresentation

名稱

類型

格式

id
選用

字串

名稱
選用

字串

providerId
選用

字串

providerType
選用

字串

parentId
選用

字串

subType
選用

字串

config
選用

[陣列] 的對應

ComponentTypeRepresentation

名稱

類型

格式

id
選用

字串

helpText
選用

字串

properties
選用

metadata
選用

[AnyType] 的對應

Composites

名稱

類型

格式

realm
選用

[字串] 的集合

client
選用

[陣列] 的對應

application
選用

[陣列] 的對應

ConfigPropertyRepresentation

名稱

類型

格式

名稱
選用

字串

label
選用

字串

helpText
選用

字串

類型
選用

字串

defaultValue
選用

oas_any_type_not_mapped

options
選用

[字串] 的列表

secret
選用

布林值

必要
選用

布林值

readOnly
選用

布林值

Confirmation

名稱

類型

格式

x5t#S256
選用

字串

jkt
選用

字串

CredentialRepresentation

名稱

類型

格式

id
選用

字串

類型
選用

字串

userLabel
選用

字串

createdDate
選用

長整數

int64

secretData
選用

字串

credentialData
選用

字串

priority
選用

整數

int32

value
選用

字串

temporary
選用

布林值

device
選用

字串

hashedSaltedValue
選用

字串

salt
選用

字串

hashIterations
選用

整數

int32

counter
選用

整數

int32

algorithm
選用

字串

digits
選用

整數

int32

period
選用

整數

int32

config
選用

對應

DecisionEffect

名稱

類型

格式

DecisionStrategy

名稱

類型

格式

EnforcementMode

名稱

類型

格式

EvaluationResultRepresentation

名稱

類型

格式

資源
選用

ResourceRepresentation

範圍
選用

ScopeRepresentation 的列表

原則
選用

PolicyResultRepresentation 的列表

status
選用

DecisionEffect

allowedScopes
選用

ScopeRepresentation 的列表

EventRepresentation

名稱

類型

格式

time
選用

長整數

int64

類型
選用

字串

realmId
選用

字串

用戶端 ID
選用

字串

userId
選用

字串

sessionId
選用

字串

ipAddress
選用

字串

error
選用

字串

details
選用

[字串] 的對應

FederatedIdentityRepresentation

名稱

類型

格式

identityProvider
選用

字串

userId
選用

字串

userName
選用

字串

GlobalRequestResult

名稱

類型

格式

successRequests
選用

[字串] 的列表

failedRequests
選用

[字串] 的列表

GroupRepresentation

名稱

類型

格式

id
選用

字串

名稱
選用

字串

路徑
選用

字串

parentId
選用

字串

subGroupCount
選用

長整數

int64

subGroups
選用

GroupRepresentation 的列表

attributes
選用

[陣列] 的對應

realmRoles
選用

[字串] 的列表

clientRoles
選用

[陣列] 的對應

access
選用

[布林值] 的對應

IDToken

名稱

類型

格式

jti
選用

字串

exp
選用

長整數

int64

nbf
選用

長整數

int64

iat
選用

長整數

int64

iss
選用

字串

sub
選用

字串

typ
選用

字串

azp
選用

字串

其他宣告
選用

[AnyType] 的對應

nonce
選用

字串

auth_time
選用

長整數

int64

sid
選用

字串

at_hash
選用

字串

c_hash
選用

字串

名稱
選用

字串

given_name
選用

字串

family_name
選用

字串

middle_name
選用

字串

nickname
選用

字串

preferred_username
選用

字串

profile
選用

字串

picture
選用

字串

website
選用

字串

電子郵件
選用

字串

email_verified
選用

布林值

gender
選用

字串

birthdate
選用

字串

zoneinfo
選用

字串

地區設定
選用

字串

phone_number
選用

字串

phone_number_verified
選用

布林值

address
選用

AddressClaimSet

updated_at
選用

長整數

int64

claims_locales
選用

字串

acr
選用

字串

s_hash
選用

字串

IdentityProviderMapperRepresentation

名稱

類型

格式

id
選用

字串

名稱
選用

字串

identityProviderAlias
選用

字串

identityProviderMapper
選用

字串

config
選用

[字串] 的對應

IdentityProviderMapperTypeRepresentation

名稱

類型

格式

id
選用

字串

名稱
選用

字串

category
選用

字串

helpText
選用

字串

properties
選用

IdentityProviderRepresentation

名稱

類型

格式

alias
選用

字串

displayName
選用

字串

internalId
選用

字串

providerId
選用

字串

已啟用
選用

布林值

updateProfileFirstLoginMode
選用

字串

trustEmail
選用

布林值

storeToken
選用

布林值

addReadTokenRoleOnCreate
選用

布林值

authenticateByDefault
選用

布林值

linkOnly
選用

布林值

hideOnLogin
選用

布林值

firstBrokerLoginFlowAlias
選用

字串

postBrokerLoginFlowAlias
選用

字串

organizationId
選用

字串

config
選用

[字串] 的對應

updateProfileFirstLogin
選用

布林值

InstallationAdapterConfig

名稱

類型

格式

realm
選用

字串

realm-public-key
選用

字串

auth-server-url
選用

字串

ssl-required
選用

字串

bearer-only
選用

布林值

資源
選用

字串

public-client
選用

布林值

verify-token-audience
選用

布林值

credentials
選用

[AnyType] 的對應

use-resource-role-mappings
選用

布林值

confidential-port
選用

整數

int32

policy-enforcer
選用

PolicyEnforcerConfig

KeyMetadataRepresentation

名稱

類型

格式

providerId
選用

字串

providerPriority
選用

長整數

int64

kid
選用

字串

status
選用

字串

類型
選用

字串

algorithm
選用

字串

publicKey
選用

字串

certificate
選用

字串

use
選用

KeyUse

validTo
選用

長整數

int64

KeyStoreConfig

名稱

類型

格式

realmCertificate
選用

布林值

storePassword
選用

字串

keyPassword
選用

字串

keyAlias
選用

字串

realmAlias
選用

字串

格式
選用

字串

KeyUse

名稱

類型

格式

KeysMetadataRepresentation

名稱

類型

格式

active
選用

[字串] 的對應

keys
選用

KeyMetadataRepresentation 的列表

Logic

名稱

類型

格式

ManagementPermissionReference

名稱

類型

格式

已啟用
選用

布林值

資源
選用

字串

scopePermissions
選用

[字串] 的對應

MappingsRepresentation

名稱

類型

格式

realmMappings
選用

RoleRepresentation 的列表

clientMappings
選用

ClientMappingsRepresentation 的對應

MemberRepresentation

名稱

類型

格式

id
選用

字串

使用者名稱
選用

字串

名字
選用

字串

姓氏
選用

字串

電子郵件
選用

字串

emailVerified
選用

布林值

attributes
選用

[陣列] 的對應

userProfileMetadata
選用

UserProfileMetadata

self
選用

字串

origin
選用

字串

createdTimestamp
選用

長整數

int64

已啟用
選用

布林值

totp
選用

布林值

federationLink
選用

字串

serviceAccountClientId
選用

字串

credentials
選用

CredentialRepresentation 的列表

disableableCredentialTypes
選用

[字串] 的集合

requiredActions
選用

[字串] 的列表

federatedIdentities
選用

FederatedIdentityRepresentation 的列表

realmRoles
選用

[字串] 的列表

clientRoles
選用

[陣列] 的對應

clientConsents
選用

UserConsentRepresentation 的列表

notBefore
選用

整數

int32

applicationRoles
選用

[陣列] 的對應

socialLinks
選用

SocialLinkRepresentation 的列表

groups
選用

[字串] 的列表

access
選用

[布林值] 的對應

membershipType
選用

MembershipType

名稱

類型

格式

MethodConfig

名稱

類型

格式

method
選用

字串

範圍
選用

[字串] 的列表

scopes-enforcement-mode
選用

ScopeEnforcementMode

OAuthClientRepresentation

名稱

類型

格式

id
選用

字串

用戶端 ID
選用

字串

描述
選用

字串

類型
選用

字串

rootUrl
選用

字串

adminUrl
選用

字串

baseUrl
選用

字串

surrogateAuthRequired
選用

布林值

已啟用
選用

布林值

alwaysDisplayInConsole
選用

布林值

clientAuthenticatorType
選用

字串

secret
選用

字串

registrationAccessToken
選用

字串

defaultRoles
選用

[字串] 的列表

redirectUris
選用

[字串] 的列表

webOrigins
選用

[字串] 的列表

notBefore
選用

整數

int32

bearerOnly
選用

布林值

consentRequired
選用

布林值

standardFlowEnabled
選用

布林值

implicitFlowEnabled
選用

布林值

directAccessGrantsEnabled
選用

布林值

serviceAccountsEnabled
選用

布林值

authorizationServicesEnabled
選用

布林值

directGrantsOnly
選用

布林值

publicClient
選用

布林值

frontchannelLogout
選用

布林值

通訊協定
選用

字串

attributes
選用

[字串] 的對應

authenticationFlowBindingOverrides
選用

[字串] 的對應

fullScopeAllowed
選用

布林值

nodeReRegistrationTimeout
選用

整數

int32

registeredNodes
選用

[整數] 的對應

int32

protocolMappers
選用

clientTemplate
選用

字串

useTemplateConfig
選用

布林值

useTemplateScope
選用

布林值

useTemplateMappers
選用

布林值

defaultClientScopes
選用

[字串] 的列表

optionalClientScopes
選用

[字串] 的列表

authorizationSettings
選用

ResourceServerRepresentation

access
選用

[布林值] 的對應

origin
選用

字串

名稱
選用

字串

claims
選用

ApplicationRepresentation_claims

OrganizationDomainRepresentation

名稱

類型

格式

名稱
選用

字串

verified
選用

布林值

OrganizationRepresentation

名稱

類型

格式

id
選用

字串

名稱
選用

字串

alias
選用

字串

已啟用
選用

布林值

描述
選用

字串

redirectUrl
選用

字串

attributes
選用

[陣列] 的對應

domains
選用

OrganizationDomainRepresentation 的集合

members
選用

MemberRepresentation 的列表

identityProviders
選用

IdentityProviderRepresentation 的列表

PathCacheConfig

名稱

類型

格式

max-entries
選用

整數

int32

lifespan
選用

長整數

int64

PathConfig

名稱

類型

格式

名稱
選用

字串

類型
選用

字串

路徑
選用

字串

methods
選用

MethodConfig 的列表

範圍
選用

[字串] 的列表

id
選用

字串

enforcement-mode
選用

EnforcementMode

claim-information-point
選用

[對應] 的對應

invalidated
選用

布林值

staticPath
選用

布林值

static
選用

布林值

Permission

名稱

類型

格式

rsid
選用

字串

rsname
選用

字串

範圍
選用

[字串] 的集合

claims
選用

[集合] 的對應

PolicyEnforcementMode

名稱

類型

格式

PolicyEnforcerConfig

名稱

類型

格式

enforcement-mode
選用

EnforcementMode

paths
選用

PathConfig 的列表

path-cache
選用

PathCacheConfig

lazy-load-paths
選用

布林值

on-deny-redirect-to
選用

字串

user-managed-access
選用

物件

claim-information-point
選用

[對應] 的對應

http-method-as-scope
選用

布林值

realm
選用

字串

auth-server-url
選用

字串

credentials
選用

[AnyType] 的對應

資源
選用

字串

PolicyEvaluationRequest

名稱

類型

格式

context
選用

[對應] 的對應

資源
選用

ResourceRepresentation 的列表

用戶端 ID
選用

字串

userId
選用

字串

roleIds
選用

[字串] 的列表

entitlements
選用

布林值

PolicyEvaluationResponse

名稱

類型

格式

results
選用

EvaluationResultRepresentation 的列表

entitlements
選用

布林值

status
選用

DecisionEffect

rpt
選用

AccessToken

PolicyProviderRepresentation

名稱

類型

格式

類型
選用

字串

名稱
選用

字串

group
選用

字串

PolicyRepresentation

名稱

類型

格式

id
選用

字串

名稱
選用

字串

描述
選用

字串

類型
選用

字串

原則
選用

[字串] 的集合

資源
選用

[字串] 的集合

範圍
選用

[字串] 的集合

邏輯
選用

Logic

決策策略
選用

DecisionStrategy

擁有者
選用

字串

resourcesData
選用

ResourceRepresentation 的集合

scopesData
選用

ScopeRepresentation 的集合

config
選用

[字串] 的對應

PolicyResultRepresentation

名稱

類型

格式

policy
選用

PolicyRepresentation

status
選用

DecisionEffect

associatedPolicies
選用

PolicyResultRepresentation 的列表

範圍
選用

[字串] 的集合

PropertyConfig

名稱

類型

格式

applicable
選用

布林值

value
選用

oas_any_type_not_mapped

ProtocolMapperEvaluationRepresentation

名稱

類型

格式

mapperId
選用

字串

mapperName
選用

字串

containerId
選用

字串

containerName
選用

字串

containerType
選用

字串

protocolMapper
選用

字串

ProtocolMapperRepresentation

名稱

類型

格式

id
選用

字串

名稱
選用

字串

通訊協定
選用

字串

protocolMapper
選用

字串

consentRequired
選用

布林值

consentText
選用

字串

config
選用

[字串] 的對應

PublishedRealmRepresentation

名稱

類型

格式

realm
選用

字串

public_key
選用

字串

token-service
選用

字串

account-service
選用

字串

tokens-not-before
選用

整數

int32

RealmEventsConfigRepresentation

名稱

類型

格式

eventsEnabled
選用

布林值

eventsExpiration
選用

長整數

int64

eventsListeners
選用

[字串] 的列表

enabledEventTypes
選用

[字串] 的列表

adminEventsEnabled
選用

布林值

adminEventsDetailsEnabled
選用

布林值

RealmRepresentation

名稱

類型

格式

id
選用

字串

realm
選用

字串

displayName
選用

字串

displayNameHtml
選用

字串

notBefore
選用

整數

int32

defaultSignatureAlgorithm
選用

字串

revokeRefreshToken
選用

布林值

refreshTokenMaxReuse
選用

整數

int32

accessTokenLifespan
選用

整數

int32

accessTokenLifespanForImplicitFlow
選用

整數

int32

ssoSessionIdleTimeout
選用

整數

int32

ssoSessionMaxLifespan
選用

整數

int32

ssoSessionIdleTimeoutRememberMe
選用

整數

int32

ssoSessionMaxLifespanRememberMe
選用

整數

int32

offlineSessionIdleTimeout
選用

整數

int32

offlineSessionMaxLifespanEnabled
選用

布林值

offlineSessionMaxLifespan
選用

整數

int32

clientSessionIdleTimeout
選用

整數

int32

clientSessionMaxLifespan
選用

整數

int32

clientOfflineSessionIdleTimeout
選用

整數

int32

clientOfflineSessionMaxLifespan
選用

整數

int32

accessCodeLifespan
選用

整數

int32

accessCodeLifespanUserAction
選用

整數

int32

accessCodeLifespanLogin
選用

整數

int32

actionTokenGeneratedByAdminLifespan
選用

整數

int32

actionTokenGeneratedByUserLifespan
選用

整數

int32

oauth2DeviceCodeLifespan
選用

整數

int32

oauth2DevicePollingInterval
選用

整數

int32

已啟用
選用

布林值

sslRequired
選用

字串

passwordCredentialGrantAllowed
選用

布林值

registrationAllowed
選用

布林值

registrationEmailAsUsername
選用

布林值

rememberMe
選用

布林值

verifyEmail
選用

布林值

loginWithEmailAllowed
選用

布林值

duplicateEmailsAllowed
選用

布林值

resetPasswordAllowed
選用

布林值

editUsernameAllowed
選用

布林值

userCacheEnabled
選用

布林值

realmCacheEnabled
選用

布林值

bruteForceProtected
選用

布林值

permanentLockout
選用

布林值

maxTemporaryLockouts
選用

整數

int32

bruteForceStrategy
選用

BruteForceStrategy

maxFailureWaitSeconds
選用

整數

int32

minimumQuickLoginWaitSeconds
選用

整數

int32

waitIncrementSeconds
選用

整數

int32

quickLoginCheckMilliSeconds
選用

長整數

int64

maxDeltaTimeSeconds
選用

整數

int32

failureFactor
選用

整數

int32

privateKey
選用

字串

publicKey
選用

字串

certificate
選用

字串

codeSecret
選用

字串

角色
選用

RolesRepresentation

groups
選用

GroupRepresentation 的列表

defaultRoles
選用

[字串] 的列表

defaultRole
選用

RoleRepresentation

defaultGroups
選用

[字串] 的列表

requiredCredentials
選用

[字串] 的集合

passwordPolicy
選用

字串

otpPolicyType
選用

字串

otpPolicyAlgorithm
選用

字串

otpPolicyInitialCounter
選用

整數

int32

otpPolicyDigits
選用

整數

int32

otpPolicyLookAheadWindow
選用

整數

int32

otpPolicyPeriod
選用

整數

int32

otpPolicyCodeReusable
選用

布林值

otpSupportedApplications
選用

[字串] 的列表

localizationTexts
選用

[對應] 的對應

webAuthnPolicyRpEntityName
選用

字串

webAuthnPolicySignatureAlgorithms
選用

[字串] 的列表

webAuthnPolicyRpId
選用

字串

webAuthnPolicyAttestationConveyancePreference
選用

字串

webAuthnPolicyAuthenticatorAttachment
選用

字串

webAuthnPolicyRequireResidentKey
選用

字串

webAuthnPolicyUserVerificationRequirement
選用

字串

webAuthnPolicyCreateTimeout
選用

整數

int32

webAuthnPolicyAvoidSameAuthenticatorRegister
選用

布林值

webAuthnPolicyAcceptableAaguids
選用

[字串] 的列表

webAuthnPolicyExtraOrigins
選用

[字串] 的列表

webAuthnPolicyPasswordlessRpEntityName
選用

字串

webAuthnPolicyPasswordlessSignatureAlgorithms
選用

[字串] 的列表

webAuthnPolicyPasswordlessRpId
選用

字串

webAuthnPolicyPasswordlessAttestationConveyancePreference
選用

字串

webAuthnPolicyPasswordlessAuthenticatorAttachment
選用

字串

webAuthnPolicyPasswordlessRequireResidentKey
選用

字串

webAuthnPolicyPasswordlessUserVerificationRequirement
選用

字串

webAuthnPolicyPasswordlessCreateTimeout
選用

整數

int32

webAuthnPolicyPasswordlessAvoidSameAuthenticatorRegister
選用

布林值

webAuthnPolicyPasswordlessAcceptableAaguids
選用

[字串] 的列表

webAuthnPolicyPasswordlessExtraOrigins
選用

[字串] 的列表

clientProfiles
選用

ClientProfilesRepresentation

clientPolicies
選用

ClientPoliciesRepresentation

users
選用

使用者表示法列表 UserRepresentation

federatedUsers
選用

使用者表示法列表 UserRepresentation

scopeMappings
選用

範圍映射表示法列表 ScopeMappingRepresentation

clientScopeMappings
選用

[陣列] 的對應

clients
選用

客戶端表示法列表 ClientRepresentation

clientScopes
選用

客戶端範圍表示法列表 ClientScopeRepresentation

defaultDefaultClientScopes
選用

[字串] 的列表

defaultOptionalClientScopes
選用

[字串] 的列表

browserSecurityHeaders
選用

[字串] 的對應

smtpServer
選用

[字串] 的對應

userFederationProviders
選用

使用者聯合供應商表示法列表 UserFederationProviderRepresentation

userFederationMappers
選用

使用者聯合映射器表示法列表 UserFederationMapperRepresentation

loginTheme
選用

字串

accountTheme
選用

字串

adminTheme
選用

字串

emailTheme
選用

字串

eventsEnabled
選用

布林值

eventsExpiration
選用

長整數

int64

eventsListeners
選用

[字串] 的列表

enabledEventTypes
選用

[字串] 的列表

adminEventsEnabled
選用

布林值

adminEventsDetailsEnabled
選用

布林值

identityProviders
選用

IdentityProviderRepresentation 的列表

identityProviderMappers
選用

身分供應商映射器表示法列表 IdentityProviderMapperRepresentation

protocolMappers
選用

components
選用

[陣列] 的對應

internationalizationEnabled
選用

布林值

supportedLocales
選用

[字串] 的集合

defaultLocale
選用

字串

authenticationFlows
選用

驗證流程表示法列表 AuthenticationFlowRepresentation

authenticatorConfig
選用

驗證器配置表示法列表 AuthenticatorConfigRepresentation

requiredActions
選用

必要動作供應商表示法列表 RequiredActionProviderRepresentation

browserFlow
選用

字串

registrationFlow
選用

字串

directGrantFlow
選用

字串

resetCredentialsFlow
選用

字串

clientAuthenticationFlow
選用

字串

dockerAuthenticationFlow
選用

字串

firstBrokerLoginFlow
選用

字串

attributes
選用

[字串] 的對應

keycloakVersion
選用

字串

userManagedAccessAllowed
選用

布林值

organizationsEnabled
選用

布林值

organizations
選用

組織表示法列表 OrganizationRepresentation

social
選用

布林值

updateProfileOnInitialSocialLogin
選用

布林值

socialProviders
選用

[字串] 的對應

applicationScopeMappings
選用

[陣列] 的對應

applications
選用

應用程式表示法列表 ApplicationRepresentation

oauthClients
選用

OAuth 客戶端表示法列表 OAuthClientRepresentation

clientTemplates
選用

客戶端範本表示法列表 ClientTemplateRepresentation

oAuth2DeviceCodeLifespan
選用

整數

int32

oAuth2DevicePollingInterval
選用

整數

int32

RequiredActionConfigInfoRepresentation

名稱

類型

格式

properties
選用