Keycloak 管理 REST API

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

認証設定を更新します。

パラメーター

パスパラメーター

名前	説明	デフォルト	パターン
realm 必須	レルム名 (ID ではない!)	null
id 必須	設定 ID	null

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

id
必須

設定 ID

null

リクエストボディパラメーター

名前	説明	デフォルト	パターン
AuthenticatorConfigRepresentation オプション	AuthenticatorConfigRepresentation

名前

説明

デフォルト

パターン

AuthenticatorConfigRepresentation
オプション

レスポンス

コード	メッセージ	データ型
204	No Content	<<>>

コード

メッセージ

データ型

204

No Content

<<>>

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

新しい認証設定を作成します。

パラメーター

パスパラメーター

名前	説明	デフォルト	パターン
realm 必須	レルム名 (ID ではない!)	null

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

リクエストボディパラメーター

名前	説明	デフォルト	パターン
AuthenticatorConfigRepresentation オプション	AuthenticatorConfigRepresentation

名前

説明

デフォルト

パターン

AuthenticatorConfigRepresentation
オプション

レスポンス

コード	メッセージ	データ型
201	作成済み	<<>>

コード

メッセージ

データ型

201

作成済み

<<>>

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

実行設定を取得します。

パラメーター

パスパラメーター

名前	説明	デフォルト
realm 必須	レルム名 (ID ではない!)	null
executionId 必須	実行 ID	null
id 必須	設定 ID	null

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

executionId
必須

実行 ID

null

id
必須

設定 ID

null

コンテンツタイプ

application/json

レスポンス

コード	メッセージ	データ型
200	OK	AuthenticatorConfigRepresentation

コード

メッセージ

データ型

200

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

新しい設定で実行を更新します。

パラメーター

パスパラメーター

名前	説明	デフォルト	パターン
realm 必須	レルム名 (ID ではない!)	null
executionId 必須	実行 ID	null

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

executionId
必須

実行 ID

null

リクエストボディパラメーター

名前	説明	デフォルト	パターン
AuthenticatorConfigRepresentation オプション	AuthenticatorConfigRepresentation

名前

説明

デフォルト

パターン

AuthenticatorConfigRepresentation
オプション

AuthenticationExecutionRepresentation

レスポンス

コード	メッセージ	データ型
201	作成済み	<<>>

コード

メッセージ

データ型

201

作成済み

<<>>

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

実行を削除します。

パラメーター

パスパラメーター

名前	説明	デフォルト	パターン
realm 必須	レルム名 (ID ではない!)	null
executionId 必須	実行 ID	null

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

executionId
必須

実行 ID

null

レスポンス

コード	メッセージ	データ型
204	No Content	<<>>

コード

メッセージ

データ型

204

No Content

<<>>

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

単一の実行を取得します。

パラメーター

パスパラメーター

名前	説明	デフォルト	パターン
realm 必須	レルム名 (ID ではない!)	null
executionId 必須		null

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

executionId
必須

null

コンテンツタイプ

application/json

レスポンス

コード	メッセージ	データ型
200	OK	AuthenticationExecutionRepresentation

コード

メッセージ

データ型

200

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

実行の優先度を下げます。

パラメーター

パスパラメーター

名前	説明	デフォルト	パターン
realm 必須	レルム名 (ID ではない!)	null
executionId 必須	実行 ID	null

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

executionId
必須

実行 ID

null

レスポンス

コード	メッセージ	データ型
204	No Content	<<>>

コード

メッセージ

データ型

204

No Content

<<>>

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

実行の優先度を上げます。

パラメーター

パスパラメーター

名前	説明	デフォルト	パターン
realm 必須	レルム名 (ID ではない!)	null
executionId 必須	実行 ID	null

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

executionId
必須

実行 ID

null

レスポンス

コード	メッセージ	データ型
204	No Content	<<>>

コード

メッセージ

データ型

204

No Content

<<>>

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

新しい認証実行を追加します。

パラメーター

パスパラメーター

名前	説明	デフォルト	パターン
realm 必須	レルム名 (ID ではない!)	null

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

リクエストボディパラメーター

名前	説明	デフォルト	パターン
AuthenticationExecutionRepresentation オプション	AuthenticationExecutionRepresentation

名前

説明

デフォルト

パターン

AuthenticationExecutionRepresentation
オプション

AuthenticationExecutionRepresentation

レスポンス

コード	メッセージ	データ型
201	作成済み	<<>>

コード

メッセージ

データ型

201

作成済み

<<>>

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

既存の認証フローを新しい名前でコピーします。新しい名前は、渡された JSON オブジェクトの 'newName' 属性として指定されます。

パラメーター

パスパラメーター

名前	説明	デフォルト	パターン
realm 必須	レルム名 (ID ではない!)	null
flowAlias 必須	既存の認証フローの名前	null

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

flowAlias
必須

既存の認証フローの名前

null

リクエストボディパラメーター

名前	説明	デフォルト	パターン
request_body オプション	[string]

名前

説明

デフォルト

パターン

request_body
オプション

AuthenticationExecutionInfoRepresentation

レスポンス

コード	メッセージ	データ型
201	作成済み	<<>>

コード

メッセージ

データ型

201

作成済み

<<>>

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

フローに新しい認証実行を追加します。

パラメーター

パスパラメーター

名前	説明	デフォルト	パターン
realm 必須	レルム名 (ID ではない!)	null
flowAlias 必須	親フローのエイリアス	null

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

flowAlias
必須

親フローのエイリアス

null

リクエストボディパラメーター

名前	説明	デフォルト	パターン
request_body オプション	[AnyType]

名前

説明

デフォルト

パターン

request_body
オプション

[AnyType]

レスポンス

コード	メッセージ	データ型
201	作成済み	<<>>

コード

メッセージ

データ型

201

作成済み

<<>>

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

既存のフローに新しい実行で新しいフローを追加します。

パラメーター

パスパラメーター

名前	説明	デフォルト	パターン
realm 必須	レルム名 (ID ではない!)	null
flowAlias 必須	親認証フローのエイリアス	null

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

flowAlias
必須

親認証フローのエイリアス

null

リクエストボディパラメーター

名前	説明	デフォルト	パターン
request_body オプション	[AnyType]

名前

説明

デフォルト

パターン

request_body
オプション

[AnyType]

レスポンス

コード	メッセージ	データ型
201	作成済み	<<>>

コード

メッセージ

データ型

201

作成済み

<<>>

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

フローの認証実行を取得します。

パラメーター

パスパラメーター

名前	説明	デフォルト	パターン
realm 必須	レルム名 (ID ではない!)	null
flowAlias 必須	フローエイリアス	null

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

flowAlias
必須

フローエイリアス

null

コンテンツタイプ

application/json

レスポンス

コード	メッセージ	データ型
200	OK	List[AuthenticationExecutionInfoRepresentation]

コード

メッセージ

データ型

200

List[AuthenticationExecutionInfoRepresentation]

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

フローの認証実行を更新します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

flowAlias
必須

フローエイリアス

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

AuthenticationExecutionInfoRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

認証フローを取得します。認証フローのストリームを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[AuthenticationFlowRepresentation]

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

認証フローを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

id
必須

フロー ID

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

ID の認証フローを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

id
必須

フロー ID

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

AuthenticationFlowRepresentation

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

認証フローを更新します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

id
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

AuthenticationFlowRepresentation
オプション

AuthenticationFlowRepresentation

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

新しい認証フローを作成します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

AuthenticationFlowRepresentation
オプション

AuthenticationFlowRepresentation

レスポンス

コード

メッセージ

データ型

201

作成済み

<<>>

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

フォームアクションプロバイダーを取得します。フォームアクションプロバイダーのストリームを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[[AnyType]]

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

フォームプロバイダーを取得します。フォームプロバイダーのストリームを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[[AnyType]]

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

すべてのクライアントの設定記述を取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

Map[ConfigPropertyRepresentation]

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

新しい必須アクションを登録します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

request_body
オプション

RequiredActionConfigInfoRepresentation

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

RequiredAction 設定を削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

alias
必須

必須アクションのエイリアス

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

RequiredAction プロバイダーの設定記述を取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

alias
必須

必須アクションのエイリアス

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

RequiredAction 設定を取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

alias
必須

必須アクションのエイリアス

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

RequiredActionConfigRepresentation

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

RequiredAction 設定を更新します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

alias
必須

必須アクションのエイリアス

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RequiredActionConfigRepresentation
オプション

RequiredActionConfigRepresentation

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

必須アクションを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

alias
必須

必須アクションのエイリアス

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

エイリアスの必須アクションを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

alias
必須

必須アクションのエイリアス

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

RequiredActionProviderRepresentation

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

必須アクションの優先度を下げます。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

alias
必須

必須アクションのエイリアス

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

必須アクションを更新します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

alias
必須

必須アクションのエイリアス

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RequiredActionProviderRepresentation
オプション

RequiredActionProviderRepresentation

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

必須アクションの優先度を上げます。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

alias
必須

必須アクションのエイリアス

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

必須アクションを取得します。必須アクションのストリームを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[RequiredActionProviderRepresentation]

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

未登録の必須アクションを取得します。未登録の必須アクションのストリームを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[[string]]

クライアント属性証明書

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

クライアントのキーストアファイルを取得します。プライベートキーと公開証明書が含まれています。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

attr
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

KeyStoreConfig
オプション

KeyStoreConfig

コンテンツタイプ

application/octet-stream

レスポンス

コード

メッセージ

データ型

200

[File]

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

新しいキーペアと証明書を生成し、プライベートキーファイルを取得します。キーペアと証明書を生成し、指定されたキーストア形式でプライベートキーを提供します。生成された公開証明書のみが Keycloak DB に保存されます - プライベートキーは保存されません。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

attr
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

KeyStoreConfig
オプション

KeyStoreConfig

コンテンツタイプ

application/octet-stream

レスポンス

コード

メッセージ

データ型

200

[File]

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

新しいキーペアで新しい証明書を生成します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

attr
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

キー情報を取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

attr
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

証明書のみをアップロードします。プライベートキーはアップロードしません。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

attr
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

証明書と場合によってはプライベートキーをアップロードします。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

attr
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

ClientInitialAccessCreatePresentation

クライアント初期アクセス

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[ClientInitialAccessPresentation]

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

id
必須

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

新しい初期アクセストークンを作成します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ClientInitialAccessCreatePresentation
オプション

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

201

作成済み

ClientInitialAccessCreatePresentation

クライアント登録ポリシー

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

configProperties が適切に設定されたプロバイダーを取得するためのベースパス

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[ComponentTypeRepresentation]

クライアントロールマッピング

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

ユーザーまたはグループにマップできる利用可能なクライアントレベルのロールを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

group-id
必須

null

client-id
必須

クライアント ID (clientId ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

有効なクライアントレベルのロールマッピングを取得します。これはコンポジットロールを再帰的に処理します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

group-id
必須

null

client-id
必須

クライアント ID (clientId ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

briefRepresentation
オプション

false の場合、ロールをその属性とともに返します。

true

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

ユーザーまたはグループのロールマッピングからクライアントレベルのロールを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

group-id
必須

null

client-id
必須

クライアント ID (clientId ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

ユーザーまたはグループ、およびアプリのクライアントレベルのロールマッピングを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

group-id
必須

null

client-id
必須

クライアント ID (clientId ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

ユーザーまたはグループのロールマッピングにクライアントレベルのロールを追加します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

group-id
必須

null

client-id
必須

クライアント ID (clientId ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

ユーザーまたはグループにマップできる利用可能なクライアントレベルのロールを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

client-id
必須

クライアント ID (clientId ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

有効なクライアントレベルのロールマッピングを取得します。これはコンポジットロールを再帰的に処理します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

client-id
必須

クライアント ID (clientId ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

briefRepresentation
オプション

false の場合、ロールをその属性とともに返します。

true

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

ユーザーまたはグループのロールマッピングからクライアントレベルのロールを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

client-id
必須

クライアント ID (clientId ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

ユーザーまたはグループ、およびアプリのクライアントレベルのロールマッピングを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

client-id
必須

クライアント ID (clientId ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

ユーザーまたはグループのロールマッピングにクライアントレベルのロールを追加します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

client-id
必須

クライアント ID (clientId ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

クライアントスコープ

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

クライアントスコープを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

400

不正なリクエスト

<<>>

403

禁止

<<>>

500

内部サーバーエラー

<<>>

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

クライアントスコープの表現を取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード	メッセージ	データ型
200		ClientScopeRepresentation
403	禁止	<<>>

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

クライアントスコープを更新します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ClientScopeRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

400

不正なリクエスト

<<>>

403

禁止

<<>>

409

競合

<<>>

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

レルムに属するクライアントスコープを取得します。レルムに属するクライアントスコープのリストを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード	メッセージ	データ型
200		List[ClientScopeRepresentation]
403	禁止	<<>>

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

新しいクライアントスコープを作成します。クライアントスコープの名前は一意である必要があります!

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ClientScopeRepresentation
オプション

レスポンス

コード

メッセージ

データ型

201

作成済み

<<>>

403

禁止

<<>>

409

競合

<<>>

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

クライアントスコープを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

400

不正なリクエスト

<<>>

403

禁止

<<>>

500

内部サーバーエラー

<<>>

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

クライアントスコープの表現を取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード	メッセージ	データ型
200		ClientScopeRepresentation
403	禁止	<<>>

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

クライアントスコープを更新します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ClientScopeRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

400

不正なリクエスト

<<>>

403

禁止

<<>>

409

競合

<<>>

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

レルムに属するクライアントスコープを取得します。レルムに属するクライアントスコープのリストを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード	メッセージ	データ型
200		List[ClientScopeRepresentation]
403	禁止	<<>>

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

新しいクライアントスコープを作成します。クライアントスコープの名前は一意である必要があります!

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ClientScopeRepresentation
オプション

レスポンス

コード

メッセージ

データ型

201

作成済み

<<>>

403

禁止

<<>>

409

競合

<<>>

クライアント

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

クライアントシークレットを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

クライアントの新しいシークレットを生成します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

クライアントのローテーションされたシークレットを無効化します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

レスポンス

コード

メッセージ

データ型

200

<<>>

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

ローテーションされたクライアントシークレットを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

clientScopeId
必須

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

clientScopeId
必須

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

デフォルトクライアントスコープを取得します。名前と ID のみが返されます。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

クライアントを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

アクセストークンの例のペイロードを持つ JSON を作成します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

audience
オプション

null

scope
オプション

null

userId
オプション

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

AccessToken

403

禁止

<<>>

404

見つかりません

<<>>

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

ID トークンの例のペイロードを持つ JSON を作成します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

audience
オプション

null

scope
オプション

null

userId
オプション

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

IDToken

403

禁止

<<>>

404

見つかりません

<<>>

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

ユーザー情報の例のペイロードを持つ JSON を作成します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

scope
オプション

null

userId
オプション

null

コンテンツタイプ

application/json

レスポンス

コード	メッセージ	データ型
200		[Object]
403	禁止	<<>>

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

特定のクライアントに発行されたトークンを生成する際に使用されるすべてのプロトコルマッパーのリストを返します。

説明

これは、このクライアントに直接割り当てられたプロトコルマッパーと、このクライアントのすべてのクライアントスコープに割り当てられたプロトコルマッパーを意味します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

scope
オプション

null

コンテンツタイプ

application/json

レスポンス

コード	メッセージ	データ型
200		List[ProtocolMapperEvaluationRepresentation]
403	禁止	<<>>

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

このクライアントが事実上、彼のために発行されたアクセストークンに持つことが許可されている特定のロールコンテナのすべてのロールの有効なスコープマッピングを取得します。

説明

これには、このクライアントが直接持つスコープマッピングと、このクライアントにリンクされているすべてのクライアントスコープに許可されているスコープマッピングが含まれます。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

roleContainerId
必須

レルム名またはクライアント UUID

null

クエリパラメーター

名前

説明

デフォルト

パターン

scope
オプション

null

コンテンツタイプ

application/json

レスポンス

コード	メッセージ	データ型
200		List[RoleRepresentation]
403	禁止	<<>>

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

このクライアントがスコープを持っておらず、彼のために発行されたアクセストークンに持つことができないロールを取得します。

説明

事実上、{@link #getGrantedScopeMappings()} に含まれていない特定のロールコンテナの他のすべてのロール

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

roleContainerId
必須

レルム名またはクライアント UUID

null

クエリパラメーター

名前

説明

デフォルト

パターン

scope
オプション

null

コンテンツタイプ

application/json

レスポンス

コード	メッセージ	データ型
200		List[RoleRepresentation]
403	禁止	<<>>

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

クライアントの表現を取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

providerId
必須

null

レスポンス

コード

メッセージ

データ型

200

<<>>

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

クライアントの認可権限が初期化されているかどうかを示すオブジェクトと参照を返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

クライアントの認可権限が初期化されているかどうかを示すオブジェクトと参照を返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ManagementPermissionReference
オプション

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

クライアントからクラスターノードを登録解除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

node
必須

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

クラスターノードをクライアントに登録します。クラスターノードをこのクライアントに手動で登録します - 通常、アダプターが Keycloak に登録リクエストを送信して処理するため、これを直接呼び出す必要はありません。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

request_body
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

アプリケーションのオフラインセッション数を取得します。このクライアントに関連付けられたオフラインユーザーセッションの数を返します { \"count\": number }

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

Map[[long]]

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

クライアントのオフラインセッションを取得します。このクライアントに関連付けられたオフラインユーザーセッションのリストを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

first
オプション

ページングオフセット

null

max
オプション

最大結果サイズ (デフォルトは 100)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

clientScopeId
必須

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

clientScopeId
必須

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

オプションのクライアントスコープを取得します。名前と ID のみが返されます。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

クライアントの失効ポリシーをその管理者 URL にプッシュします。クライアントに管理者 URL がある場合、失効ポリシーをプッシュします。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

クライアントを更新します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ClientRepresentation
オプション

レスポンス

コード

メッセージ

データ型

200

<<>>

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

クライアントの新しい登録アクセストークンを生成します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

サービスアカウント専用のユーザーを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

アプリケーションセッション数を取得します。このクライアントに関連付けられたユーザーセッションの数を返します { \"count\": number }

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

Map[[long]]

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

登録されたクラスターノードが利用可能かどうかをテストします。すべてのクラスターノードに 'ping' リクエストを送信して可用性をテストします。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

クライアントのユーザーセッションを取得します。このクライアントに関連付けられたユーザーセッションのリストを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

first
オプション

ページングオフセット

null

max
オプション

最大結果サイズ (デフォルトは 100)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

GET /admin/realms/{realm}/clients

レルムに属するクライアントを取得します。

説明

基盤となるストレージの問題により、ストレージからクライアントを取得できない場合、返されるリストからサイレントに削除されます。これにより、リストへの同時変更によって、呼び出し元がこのリストを取得できなくなるのを防ぎます。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

clientId
オプション

clientId でフィルタリング

null

first
オプション

最初の結果

null

max
オプション

返す最大結果数

null

q
オプション

null

検索
オプション

これが検索クエリか、getClientById クエリか

false

viewableOnly
オプション

管理者が完全に表示できないクライアントをフィルタリング

false

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[ClientRepresentation]

POST /admin/realms/{realm}/clients

新しいクライアントを作成します。クライアントの client_id は一意である必要があります!

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ClientRepresentation
オプション

レスポンス

コード

メッセージ

データ型

201

作成済み

<<>>

コンポーネント

GET /admin/realms/{realm}/components

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

name
オプション

null

parent
オプション

null

type
オプション

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[ComponentRepresentation]

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

id
必須

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

id
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

ComponentRepresentation

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

id
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ComponentRepresentation
オプション

ComponentRepresentation

レスポンス

コード

メッセージ

データ型

200

<<>>

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

特定の親コンポーネントに対して構成可能なサブコンポーネントタイプのリスト。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

id
必須

null

クエリパラメーター

名前

説明

デフォルト

パターン

type
オプション

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[ComponentTypeRepresentation]

POST /admin/realms/{realm}/components

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ComponentRepresentation
オプション

ComponentRepresentation

レスポンス

コード

メッセージ

データ型

200

<<>>

デフォルト

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ResourceServerRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

PolicyEvaluationRequest
オプション

PolicyEvaluationRequest

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

PolicyEvaluationResponse

500

内部サーバーエラー

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

fields
オプション

null

first
オプション

null

max
オプション

null

name
オプション

null

owner
オプション

null

permission
オプション

null

policyId
オプション

null

resource
オプション

null

resourceType
オプション

null

scope
オプション

null

type
オプション

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[AbstractPolicyRepresentation]

204

No Content

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

body
オプション

AbstractPolicyRepresentation

レスポンス

コード

メッセージ

データ型

201

作成済み

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[PolicyProviderRepresentation]

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

fields
オプション

null

name
オプション

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

204

No Content

<<>>

400

不正なリクエスト

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

PolicyEvaluationRequest
オプション

PolicyEvaluationRequest

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

PolicyEvaluationResponse

500

内部サーバーエラー

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

fields
オプション

null

first
オプション

null

max
オプション

null

name
オプション

null

owner
オプション

null

permission
オプション

null

policyId
オプション

null

resource
オプション

null

resourceType
オプション

null

scope
オプション

null

type
オプション

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[AbstractPolicyRepresentation]

204

No Content

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

body
オプション

AbstractPolicyRepresentation

レスポンス

コード

メッセージ

データ型

201

作成済み

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[PolicyProviderRepresentation]

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

fields
オプション

null

name
オプション

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

204

No Content

<<>>

400

不正なリクエスト

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ResourceServerRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

id
_オプション

null

deep
オプション

null

exactName
オプション

null

first
オプション

null

matchingUri
オプション

null

max
オプション

null

name
オプション

null

owner
オプション

null

scope
オプション

null

type
オプション

null

uri
オプション

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[ResourceRepresentation]

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ResourceRepresentation
オプション

クエリパラメーター

名前

説明

デフォルト

パターン

id
_オプション

null

deep
オプション

null

exactName
オプション

null

first
オプション

null

matchingUri
オプション

null

max
オプション

null

name
オプション

null

owner
オプション

null

scope
オプション

null

type
オプション

null

uri
オプション

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

201

作成済み

400

不正なリクエスト

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

resource-id
必須

null

クエリパラメーター

名前

説明

デフォルト

パターン

id
_オプション

null

deep
オプション

null

exactName
オプション

null

first
オプション

null

matchingUri
オプション

null

max
オプション

null

name
オプション

null

owner
オプション

null

scope
オプション

null

type
オプション

null

uri
オプション

null

レスポンス

コード

メッセージ

データ型

200

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

resource-id
必須

null

クエリパラメーター

名前

説明

デフォルト

パターン

id
_オプション

null

deep
オプション

null

exactName
オプション

null

first
オプション

null

matchingUri
オプション

null

max
オプション

null

name
オプション

null

owner
オプション

null

scope
オプション

null

type
オプション

null

uri
オプション

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

404

見つかりません

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

resource-id
必須

null

クエリパラメーター

名前

説明

デフォルト

パターン

id
_オプション

null

deep
オプション

null

exactName
オプション

null

first
オプション

null

matchingUri
オプション

null

max
オプション

null

name
オプション

null

owner
オプション

null

scope
オプション

null

type
オプション

null

uri
オプション

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

404

見つかりません

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

resource-id
必須

null

クエリパラメーター

名前

説明

デフォルト

パターン

id
_オプション

null

deep
オプション

null

exactName
オプション

null

first
オプション

null

matchingUri
オプション

null

max
オプション

null

name
オプション

null

owner
オプション

null

scope
オプション

null

type
オプション

null

uri
オプション

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[PolicyRepresentation]

404

見つかりません

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

resource-id
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ResourceRepresentation
オプション

クエリパラメーター

名前

説明

デフォルト

パターン

id
_オプション

null

deep
オプション

null

exactName
オプション

null

first
オプション

null

matchingUri
オプション

null

max
オプション

null

name
オプション

null

owner
オプション

null

scope
オプション

null

type
オプション

null

uri
オプション

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

404

見つかりません

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

resource-id
必須

null

クエリパラメーター

名前

説明

デフォルト

パターン

id
_オプション

null

deep
オプション

null

exactName
オプション

null

first
オプション

null

matchingUri
オプション

null

max
オプション

null

name
オプション

null

owner
オプション

null

scope
オプション

null

type
オプション

null

uri
オプション

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[ScopeRepresentation]

404

見つかりません

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

id
_オプション

null

deep
オプション

null

exactName
オプション

null

first
オプション

null

matchingUri
オプション

null

max
オプション

null

owner
オプション

null

scope
オプション

null

type
オプション

null

uri
オプション

null

name
オプション

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

400

不正なリクエスト

<<>>

204

No Content

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

first
オプション

null

max
オプション

null

name
オプション

null

scopeId
オプション

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[ScopeRepresentation]

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ScopeRepresentation
オプション

ScopeRepresentation

レスポンス

コード

メッセージ

データ型

200

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

scope-id
必須

null

レスポンス

コード

メッセージ

データ型

200

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

scope-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

ScopeRepresentation

404

見つかりません

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

scope-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[PolicyRepresentation]

404

見つかりません

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

scope-id
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ScopeRepresentation
オプション

ScopeRepresentation

レスポンス

コード

メッセージ

データ型

200

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

scope-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[ResourceRepresentation]

404

見つかりません

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

name
オプション

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[ScopeRepresentation]

204

No Content

<<>>

400

不正なリクエスト

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

グループ

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

グループ数を返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

検索
オプション

null

top
オプション

false

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

Map[[long]]

GET /admin/realms/{realm}/groups

グループ階層を取得します。`name` と `id` のみが返されます。`subGroups` は `search` または `q` パラメーターを使用する場合にのみ返されます。これらのパラメーターが提供されていない場合、トップレベルグループは `subGroups` が入力されずに返されます。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

briefRepresentation
オプション

true

exact
オプション

false

first
オプション

null

max
オプション

null

populateHierarchy
オプション

true

q
オプション

null

検索
オプション

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

URL 上のグループに対応する親グループを持つサブグループのページネーションリストを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

group-id
必須

null

クエリパラメーター

名前

説明

デフォルト

パターン

briefRepresentation
オプション

簡潔なグループ表現が返されるかどうかを定義するブール値 (デフォルト: false)

false

exact
オプション

パラメーター "search" が完全に一致する必要があるかどうかを定義するブール値

null

first
オプション

返される最初の結果の位置 (ページネーションオフセット)。

null

max
オプション

返される結果の最大数。デフォルトは 10

null

検索
オプション

正確なグループ名または部分名を表す文字列

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

子を設定または作成します。

説明

これは、親が存在する場合にのみ親を設定します。グループが存在しない場合は、作成して親を設定します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

group-id
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

GroupRepresentation
オプション

レスポンス

コード

メッセージ

データ型

200

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

group-id
必須

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

group-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

クライアントの認可権限が初期化されているかどうかを示すオブジェクトと参照を返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

group-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

クライアントの認可権限が初期化されているかどうかを示すオブジェクトと参照を返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

group-id
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ManagementPermissionReference
オプション

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

ユーザーを取得します。クエリパラメーターに従ってフィルタリングされたユーザーのストリームを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

group-id
必須

null

クエリパラメーター

名前

説明

デフォルト

パターン

briefRepresentation
オプション

基本的な情報のみを返します (id、ユーザー名、作成日、名、姓、メール、有効状態、メール検証状態、フェデレーションリンク、およびアクセスを返すことが保証されています。つまり、ユーザー属性、必須アクション、および Not Before は返されないことに注意してください。)

null

first
オプション

ページネーションオフセット

null

max
オプション

最大結果サイズ (デフォルトは 100)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

グループを更新します。サブグループは無視します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

group-id
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

GroupRepresentation
オプション

レスポンス

コード

メッセージ

データ型

200

<<>>

POST /admin/realms/{realm}/groups

トップレベルレルムグループを作成または追加します。子を設定または作成します。

説明

これは、グループを更新し、親が存在する場合に親を設定します。グループが存在しない場合は、作成して親を設定します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

GroupRepresentation
オプション

IdentityProviderRepresentation

レスポンス

コード

メッセージ

データ型

201

作成済み

<<>>

204

No Content

<<>>

IDプロバイダー

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

JSON ボディから ID プロバイダーをインポートします。

説明

アップロードされた JSON ファイルから ID プロバイダーをインポートします。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

request_body
オプション

[AnyType]

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

Map[[string]]

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

ID プロバイダーを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

alias
必須

null

レスポンス

コード

メッセージ

データ型

200

<<>>

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

ID プロバイダーの公開ブローカー設定をエクスポートします。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

alias
必須

null

クエリパラメーター

名前

説明

デフォルト

パターン

format
オプション

使用するフォーマット

null

レスポンス

コード

メッセージ

データ型

200

<<>>

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

ID プロバイダーを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

alias
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

クライアントの認可権限が初期化されているかどうかを示すオブジェクトと参照を返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

alias
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

クライアントの認可権限が初期化されているかどうかを示すオブジェクトと参照を返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

alias
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ManagementPermissionReference
オプション

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

IdentityProviderMapperRepresentation

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

ID プロバイダーのマッパータイプを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

alias
必須

null

コンテンツタイプ

*/*

レスポンス

コード

メッセージ

データ型

200

Map[IdentityProviderMapperTypeRepresentation]

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

ID プロバイダーのマッパーを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

alias
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[IdentityProviderMapperRepresentation]

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

ID プロバイダーのマッパーを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

alias
必須

null

id
必須

マッパー ID

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

ID プロバイダーの ID でマッパーを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

alias
必須

null

id
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

ID プロバイダーのマッパーを更新します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

alias
必須

null

id
必須

マッパー ID

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

IdentityProviderMapperRepresentation
オプション

IdentityProviderMapperRepresentation

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

ID プロバイダーにマッパーを追加します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

alias
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

IdentityProviderMapperRepresentation
オプション

IdentityProviderMapperRepresentation

レスポンス

コード

メッセージ

データ型

200

<<>>

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

ID プロバイダーを更新します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

alias
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

IdentityProviderRepresentation
オプション

IdentityProviderRepresentation

レスポンス

コード

メッセージ

データ型

200

<<>>

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

プロバイダーがサポートしている場合、ID プロバイダーのキーを再読み込みします。再読み込みが実行された場合は "true" が返され、そうでない場合は "false" が返されます。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

alias
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

[Boolean]

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

ID プロバイダーをリスト表示します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

briefRepresentation
オプション

簡潔な表現が返されるかどうかを定義するブール値 (デフォルト: false)

null

first
オプション

ページネーションオフセット

null

max
オプション

最大結果サイズ (デフォルトは 100)

null

realmOnly
オプション

レルムレベルの IDP (組織に関連付けられていない) のみ返すかどうかを定義するブール値 (デフォルト: false)

null

検索
オプション

名前で特定のプロバイダーをフィルタリングします。検索は、プレフィックス (name*)、包含 (name)、または完全一致 ("name") にすることができます。デフォルトはプレフィックスです。

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[IdentityProviderRepresentation]

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

新しい ID プロバイダーを作成します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

IdentityProviderRepresentation
オプション

IdentityProviderRepresentation

レスポンス

コード

メッセージ

データ型

200

<<>>

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

そのプロバイダー ID の ID プロバイダーファクトリを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

provider_id
必須

ファクトリを取得するプロバイダー ID

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

[Object]

キー

GET /admin/realms/{realm}/keys

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

KeysMetadataRepresentation

組織

GET /admin/realms/{realm}/organizations

指定されたパラメーターに従ってフィルタリングされた組織のページネーションリストを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

briefRepresentation
オプション

false の場合、完全な表現を返します。それ以外の場合は、基本フィールドのみが返されます。

true

exact
オプション

パラメーター 'search' が完全に一致する必要があるかどうかを定義するブール値

null

first
オプション

処理される最初の結果の位置 (ページネーションオフセット)

null

max
オプション

返される結果の最大数 - デフォルトは 10

null

q
オプション

カスタム属性を検索するクエリ ('key1:value2 key2:value2' 形式)

null

検索
オプション

組織名またはドメインを表す文字列

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[OrganizationRepresentation]

403

禁止

<<>>

404

見つかりません

<<>>

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

指定された ID を持つユーザーに関連付けられた組織を返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

member-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード	メッセージ	データ型
200		List[OrganizationRepresentation]
400	不正なリクエスト	<<>>

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

組織を削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

org-id
必須

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

400

不正なリクエスト

<<>>

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

組織の表現を返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

org-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

OrganizationRepresentation

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

指定されたエイリアスを持つ ID プロバイダーを組織から削除します。

説明

ID プロバイダーと組織間の関連付けを解除します。プロバイダー自体は削除されません。プロバイダーが見つからない場合、または現在組織に関連付けられていない場合は、エラー応答が返されます。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

org-id
必須

null

alias
必須

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

400

不正なリクエスト

<<>>

404

見つかりません

<<>>

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

指定されたエイリアスを持つ組織に関連付けられた ID プロバイダーを返します。

説明

指定されたエイリアスを持つ ID プロバイダーを検索します。見つかり、組織に関連付けられている場合は、それが返されます。それ以外の場合は、ステータス NOT_FOUND のエラー応答が返されます。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

org-id
必須

null

alias
必須

null

コンテンツタイプ

application/json

レスポンス

コード	メッセージ	データ型
200		IdentityProviderRepresentation
404	見つかりません	<<>>

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

組織に関連付けられたすべての ID プロバイダーを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

org-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[IdentityProviderRepresentation]

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

指定された ID を持つ ID プロバイダーを組織に追加します。

説明

既存の ID プロバイダーを組織に追加または関連付けます。ID プロバイダーが見つからない場合、またはすでに組織に関連付けられている場合は、エラー応答が返されます。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

org-id
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

body
必須

ペイロードには、組織に関連付ける ID プロバイダーの ID またはエイリアスのみを含める必要があります (引用符の有無にかかわらず ID またはエイリアス)。周囲の空白文字はトリミングされます。[string]

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

400

不正なリクエスト

<<>>

403

禁止

<<>>

409

競合

<<>>

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

組織内のメンバー数を返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

org-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

[Long]

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

指定されたパラメーターに従ってフィルタリングされた組織メンバーのページネーションリストを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

org-id
必須

null

クエリパラメーター

名前

説明

デフォルト

パターン

exact
オプション

パラメーター 'search' が完全に一致する必要があるかどうかを定義するブール値

null

first
オプション

処理される最初の結果の位置 (ページネーションオフセット)

null

max
オプション

返される結果の最大数。デフォルトは 10

null

membershipType
オプション

メンバーシップタイプ

null

検索
オプション

メンバーのユーザー名、電子メール、名、または姓を表す文字列。

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[MemberRepresentation]

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

指定されたユーザー ID を使用して、既存のユーザーを組織に招待します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

org-id
必須

null

フォームパラメーター

名前

説明

デフォルト

パターン

id
オプション

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

400

不正なリクエスト

<<>>

500

内部サーバーエラー

<<>>

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

提供された電子メールアドレスに基づいて、既存のユーザーを招待するか、新しいユーザーに登録リンクを送信します。

説明

指定された電子メールアドレスを持つユーザーが存在する場合、招待リンクを送信し、それ以外の場合は登録リンクを送信します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

org-id
必須

null

フォームパラメーター

名前

説明

デフォルト

パターン

email
オプション

null

firstName
オプション

null

lastName
オプション

OrganizationRepresentation

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

400

不正なリクエスト

<<>>

409

競合

<<>>

500

内部サーバーエラー

<<>>

DELETE /admin/realms/{realm}/organizations/{org-id}/members/{member-id}

指定された ID を持つユーザーを組織から削除します。

説明

ユーザーと組織間の関連付けを解除します。メンバーシップが管理されている場合、ユーザー自体が削除されます。それ以外の場合、ユーザーは削除されません。ユーザーが見つからない場合、または組織のメンバーでない場合は、エラー応答が返されます。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

org-id
必須

null

member-id
必須

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

400

不正なリクエスト

<<>>

GET /admin/realms/{realm}/organizations/{org-id}/members/{member-id}

指定されたIDを持つ組織のメンバーを返します。

説明

指定されたIDのユーザーを検索します。見つかり、かつ現在組織のメンバーである場合は、そのユーザーを返します。それ以外の場合は、ステータス NOT_FOUND のエラー応答が返されます。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

org-id
必須

null

member-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード	メッセージ	データ型
200		MemberRepresentation
400	不正なリクエスト	<<>>

GET /admin/realms/{realm}/organizations/{org-id}/members/{member-id}/organizations

指定された ID を持つユーザーに関連付けられた組織を返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

org-id
必須

null

member-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード	メッセージ	データ型
200		List[OrganizationRepresentation]
400	不正なリクエスト	<<>>

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

指定されたIDのユーザーを組織のメンバーとして追加します。

説明

既存のユーザーを組織に追加または関連付けます。ユーザーが見つからない場合、またはすでに組織に関連付けられている場合は、エラー応答が返されます。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

org-id
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

body
必須

ペイロードには、組織に追加するユーザーのID（引用符の有無にかかわらずUUID）のみを含める必要があります。周囲の空白文字はトリムされます。[string]

レスポンス

コード

メッセージ

データ型

201

作成済み

<<>>

400

不正なリクエスト

<<>>

409

競合

<<>>

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

組織を更新します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

org-id
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

OrganizationRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

400

不正なリクエスト

<<>>

POST /admin/realms/{realm}/organizations

新しい組織を作成します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

OrganizationRepresentation
オプション

OrganizationRepresentation

レスポンス

コード

メッセージ

データ型

201

作成済み

<<>>

400

不正なリクエスト

<<>>

403

禁止

<<>>

プロトコルマッパー

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

複数のマッパーを作成します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ProtocolMapperRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

マッパーを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

マッパーを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

id
必須

マッパー ID

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

IDでマッパーを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

id
必須

マッパー ID

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

マッパーを更新します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

id
必須

マッパー ID

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ProtocolMapperRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

マッパーを作成します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ProtocolMapperRepresentation
オプション

レスポンス

コード

メッセージ

データ型

200

<<>>

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

特定のプロトコルの名前でマッパーを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

プロトコル
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

複数のマッパーを作成します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ProtocolMapperRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

マッパーを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

マッパーを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

id
必須

マッパー ID

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

IDでマッパーを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

id
必須

マッパー ID

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

マッパーを更新します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

id
必須

マッパー ID

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ProtocolMapperRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

マッパーを作成します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ProtocolMapperRepresentation
オプション

レスポンス

コード

メッセージ

データ型

200

<<>>

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

特定のプロトコルの名前でマッパーを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

プロトコル
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

複数のマッパーを作成します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ProtocolMapperRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

マッパーを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

マッパーを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

id
必須

マッパー ID

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

IDでマッパーを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

id
必須

マッパー ID

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

マッパーを更新します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

id
必須

マッパー ID

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ProtocolMapperRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

マッパーを作成します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ProtocolMapperRepresentation
オプション

レスポンス

コード

メッセージ

データ型

200

<<>>

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

特定のプロトコルの名前でマッパーを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

プロトコル
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

レルム管理

GET /admin/realms

アクセス可能なレルムを取得します。アクセス可能なレルムのリストを返します。リストは、呼び出し元が表示を許可されているレルムに基づいてフィルタリングされます。

パラメーター

クエリパラメーター

名前

説明

デフォルト

パターン

briefRepresentation
オプション

false

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[RealmRepresentation]

403

禁止

<<>>

POST /admin/realms

レルムをインポートします。レルムの完全な表現からレルムをインポートします。

説明

レルム名は一意である必要があります。

パラメーター

リクエストボディパラメーター

名前

説明

デフォルト

パターン

body
オプション

[ファイル]

レスポンス

コード

メッセージ

データ型

201

作成済み

<<>>

400

不正なリクエスト

<<>>

403

禁止

<<>>

409

競合

<<>>

500

内部サーバーエラー

<<>>

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

すべての管理者イベントを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

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

管理者イベントを取得します。すべての管理者イベントを返すか、またはここにリストされているURLクエリパラメータに基づいてイベントをフィルタリングします。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

authClient
オプション

null

authIpAddress
オプション

null

authRealm
オプション

null

authUser
オプション

ユーザーID

null

dateFrom
オプション

開始日（包括的）（yyyy-MM-dd）またはエポックタイムスタンプ

null

dateTo
オプション

終了日（包括的）（yyyy-MM-dd）またはエポックタイムスタンプ

null

direction
オプション

イベントをソートする方向（asc または desc）

null

first
オプション

null

max
オプション

最大結果サイズ (デフォルトは 100)

null

operationTypes
オプション

[String]

null

resourcePath
オプション

null

resourceTypes
オプション

[String]

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[AdminEventRepresentation]

400

不正なリクエスト

<<>>

403

禁止

<<>>

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

このレルムの下にクライアントをインポートするためのベースパス。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

body
オプション

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

ClientPoliciesRepresentation

403

禁止

<<>>

404

見つかりません

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

include-global-policies
オプション

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ClientPoliciesRepresentation
オプション

ClientPoliciesRepresentation

レスポンス

コード

メッセージ

データ型

200

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

include-global-profiles
オプション

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

ClientProfilesRepresentation

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ClientProfilesRepresentation
オプション

ClientProfilesRepresentation

レスポンス

コード

メッセージ

データ型

200

<<>>

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

クライアントセッション統計を取得します。JSONマップを返します。

説明

キーはクライアントID、値はそのクライアントで現在アクティブなセッションの数です。実際にセッションが関連付けられているクライアントのみがこのマップに含まれます。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[[string]]

403

禁止

<<>>

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

現在のレルムで利用可能なすべてのクライアントタイプをリストします。

説明

このエンドポイントは、グローバルレベルとレルムレベルの両方のクライアントタイプと、それらが設定する属性のリストを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

ClientTypesRepresentation

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

クライアントタイプを更新します。

説明

このエンドポイントを使用すると、レルムレベルのクライアントタイプを更新できます。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ClientTypesRepresentation
オプション

ClientTypesRepresentation

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[[string]]

403

禁止

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

clientScopeId
必須

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

clientScopeId
必須

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

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

レルムのデフォルトクライアントスコープを取得します。名前とIDのみが返されます。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

403

禁止

<<>>

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

グループ階層を取得します。名前とIDのみが返されます。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

403

禁止

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

グループID
必須

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

グループID
必須

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

clientScopeId
必須

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

clientScopeId
必須

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

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

レルムのオプションクライアントスコープを取得します。名前とIDのみが返されます。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

RealmEventsConfigRepresentation

403

禁止

<<>>

DELETE /admin/realms/{realm}

レルムを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

400

不正なリクエスト

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

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

イベントプロバイダー設定を取得します。イベントプロバイダー設定を持つJSONオブジェクトを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

403

禁止

<<>>

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

説明

イベントプロバイダーを更新します。イベントプロバイダーまたはその設定を変更します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RealmEventsConfigRepresentation
オプション

RealmEventsConfigRepresentation

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

DELETE /admin/realms/{realm}/events

すべてのイベントを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

GET /admin/realms/{realm}/events

イベントを取得します。すべてのイベントを返すか、またはここにリストされているURLクエリパラメータに基づいてイベントをフィルタリングします。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

client
オプション

アプリまたは OAuth クライアント名

null

dateFrom
オプション

開始日（包括的）（yyyy-MM-dd）またはエポックタイムスタンプ

null

dateTo
オプション

終了日（包括的）（yyyy-MM-dd）またはエポックタイムスタンプ

null

direction
オプション

イベントをソートする方向（asc または desc）

null

first
オプション

ページングオフセット

null

ipAddress
オプション

IPアドレス

null

max
オプション

最大結果サイズ (デフォルトは 100)

null

type
オプション

返されるイベントのタイプ [String]

null

user
オプション

ユーザーID

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[EventRepresentation]

400

不正なリクエスト

<<>>

403

禁止

<<>>

GET /admin/realms/{realm}

レルムのトップレベル表現を取得します。ユーザーやクライアントの表現のようなネストされた情報は含まれません。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

RealmRepresentation

403

禁止

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

パス
必須

null

/.*/

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

403

禁止

<<>>

404

見つかりません

<<>>

GET /admin/realms/{realm}/localization

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[[string]]

403

禁止

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

ロケール
必須

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

ロケール
必須

null

クエリパラメーター

名前

説明

デフォルト

パターン

レルムのデフォルトロケールフォールバックを使用する
オプション

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

Map[[string]]

403

禁止

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

キー
必須

null

ロケール
必須

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

キー
必須

null

ロケール
必須

null

コンテンツタイプ

text/plain

レスポンス

コード

メッセージ

データ型

200

[String]

403

禁止

<<>>

404

見つかりません

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

キー
必須

null

ロケール
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

body
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

400

不正なリクエスト

<<>>

403

禁止

<<>>

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

アップロードされたJSONファイルからローカライズをインポートします。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

ロケール
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

request_body
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

400

不正なリクエスト

<<>>

403

禁止

<<>>

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

すべてのユーザーセッションを削除します。

説明

管理URLを持つクライアントには、保持しているセッションを無効にするように指示も送信されます。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

403

禁止

<<>>

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

既存のレルムをJSONファイルに部分的にエクスポートします。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

クライアントをエクスポート
オプション

null

グループとロールをエクスポート
オプション

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

RealmRepresentation

403

禁止

<<>>

POST /admin/realms/{realm}/partialImport

JSONファイルから既存のレルムに部分的にインポートします。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

body
オプション

[ファイル]

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

[Object]

403

禁止

<<>>

409

競合

<<>>

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

レルムの失効ポリシーを、関連付けられた管理URLを持つすべてのクライアントにプッシュします。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

403

禁止

<<>>

PUT /admin/realms/{realm}

レルムのトップレベル情報を更新します。表現内のユーザー、ロール、またはクライアント情報はすべて無視されます。

説明

これはレルムのトップレベル属性のみを更新します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RealmRepresentation
オプション

RealmRepresentation

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

400

不正なリクエスト

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

409

競合

<<>>

500

内部サーバーエラー

<<>>

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

特定のユーザーセッションを削除します。

説明

管理URLを持つクライアントには、この特定のセッションを無効にするように指示も送信されます。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

セッション
必須

null

クエリパラメーター

名前

説明

デフォルト

パターン

オフラインですか
オプション

false

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

POST /admin/realms/{realm}/testSMTPConnection

現在ログインしているユーザーでSMTP接続をテストします。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

request_body
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

500

内部サーバーエラー

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

403

禁止

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ManagementPermissionReference
オプション

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

403

禁止

<<>>

ロールマッパー

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

ロールマッピングを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

group-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード	メッセージ	データ型
200		MappingsRepresentation
403	禁止	<<>>

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

マッピング可能なレルムレベルのロールを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

group-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード	メッセージ	データ型
200		List[RoleRepresentation]
403	禁止	<<>>

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

有効なレルムレベルのロールマッピングを取得します。これは、結果を取得するためにすべてのコンポジットロールを再帰的に処理します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

group-id
必須

null

クエリパラメーター

名前

説明

デフォルト

パターン

briefRepresentation
オプション

false の場合、ロールをその属性とともに返します。

true

コンテンツタイプ

application/json

レスポンス

コード	メッセージ	データ型
200		List[RoleRepresentation]
403	禁止	<<>>

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

レルムレベルのロールマッピングを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

group-id
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

400

不正なリクエスト

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

500

内部サーバーエラー

<<>>

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

レルムレベルのロールマッピングを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

group-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード	メッセージ	データ型
200		List[RoleRepresentation]
403	禁止	<<>>

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

レルムレベルのロールマッピングをユーザーに追加します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

group-id
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

400

不正なリクエスト

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

500

内部サーバーエラー

<<>>

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

ロールマッピングを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード	メッセージ	データ型
200		MappingsRepresentation
403	禁止	<<>>

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

マッピング可能なレルムレベルのロールを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード	メッセージ	データ型
200		List[RoleRepresentation]
403	禁止	<<>>

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

有効なレルムレベルのロールマッピングを取得します。これは、結果を取得するためにすべてのコンポジットロールを再帰的に処理します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

クエリパラメーター

名前

説明

デフォルト

パターン

briefRepresentation
オプション

false の場合、ロールをその属性とともに返します。

true

コンテンツタイプ

application/json

レスポンス

コード	メッセージ	データ型
200		List[RoleRepresentation]
403	禁止	<<>>

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

レルムレベルのロールマッピングを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

400

不正なリクエスト

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

500

内部サーバーエラー

<<>>

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

レルムレベルのロールマッピングを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード	メッセージ	データ型
200		List[RoleRepresentation]
403	禁止	<<>>

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

レルムレベルのロールマッピングをユーザーに追加します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

400

不正なリクエスト

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

500

内部サーバーエラー

<<>>

ロール

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

レルムまたはクライアントのすべてのロールを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

briefRepresentation
オプション

true

first
オプション

null

max
オプション

null

検索
オプション

コンテンツタイプ

application/json

レスポンス

コード	メッセージ	データ型
200		List[RoleRepresentation]
403	禁止	<<>>

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

レルムまたはクライアントの新しいロールを作成します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

201

作成済み

<<>>

400

不正なリクエスト

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

500

内部サーバーエラー

<<>>

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

ロールのコンポジットに含まれるクライアントのクライアントレベルのロールを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

null

role-name
必須

ロールの名前（IDではありません！）

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

403

禁止

<<>>

404

見つかりません

<<>>

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

ロールのコンポジットからロールを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

role-name
必須

ロールの名前（IDではありません！）

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

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

ロールのコンポジットを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

role-name
必須

ロールの名前（IDではありません！）

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

403

禁止

<<>>

404

見つかりません

<<>>

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

ロールにコンポジットを追加します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

role-name
必須

ロールの名前（IDではありません！）

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

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

ロールのコンポジットのレルムレベルのロールを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

role-name
必須

ロールの名前（IDではありません！）

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

403

禁止

<<>>

404

見つかりません

<<>>

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

名前でロールを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

role-name
必須

ロールの名前（IDではありません！）

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

400

不正なリクエスト

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

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

名前でロールを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

role-name
必須

ロールの名前（IDではありません！）

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

403

禁止

<<>>

404

見つかりません

<<>>

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

指定されたロール名を持つグループのストリームを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

role-name
必須

ロール名。

null

クエリパラメーター

名前

説明

デフォルト

パターン

briefRepresentation
オプション

false の場合、{@code GroupRepresentation} オブジェクトの完全な表現を返します。

true

first
オプション

返す最初の結果。負の値または {@code null} の場合は無視されます。

null

max
オプション

返す最大結果数。負の値または {@code null} の場合は無視されます。

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

403

禁止

<<>>

404

見つかりません

<<>>

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

ロールの認可権限が初期化されているかどうかを示すオブジェクトと、参照を返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

role-name
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

403

禁止

<<>>

404

見つかりません

<<>>

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

ロールの認可権限が初期化されているかどうかを示すオブジェクトと、参照を返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

role-name
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ManagementPermissionReference
オプション

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

403

禁止

<<>>

404

見つかりません

<<>>

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

名前でロールを更新します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

role-name
必須

ロールの名前（IDではありません！）

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

409

競合

<<>>

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

指定されたロール名を持つユーザーのストリームを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

role-name
必須

ロール名。

null

クエリパラメーター

名前

説明

デフォルト

パターン

briefRepresentation
オプション

簡潔な表現が返されるかどうかを定義するブール値 (デフォルト: false)

null

first
オプション

返す最初の結果。負の値または {@code null} の場合は無視されます。

null

max
オプション

返す最大結果数。負の値または {@code null} の場合は無視されます。

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

403

禁止

<<>>

404

見つかりません

<<>>

GET /admin/realms/{realm}/roles

レルムまたはクライアントのすべてのロールを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

briefRepresentation
オプション

true

first
オプション

null

max
オプション

null

検索
オプション

コンテンツタイプ

application/json

レスポンス

コード	メッセージ	データ型
200		List[RoleRepresentation]
403	禁止	<<>>

POST /admin/realms/{realm}/roles

レルムまたはクライアントの新しいロールを作成します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

201

作成済み

<<>>

400

不正なリクエスト

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

500

内部サーバーエラー

<<>>

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

ロールのコンポジットに含まれるクライアントのクライアントレベルのロールを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

null

role-name
必須

ロールの名前（IDではありません！）

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

403

禁止

<<>>

404

見つかりません

<<>>

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

ロールのコンポジットからロールを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

role-name
必須

ロールの名前（IDではありません！）

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

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

ロールのコンポジットを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

role-name
必須

ロールの名前（IDではありません！）

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

403

禁止

<<>>

404

見つかりません

<<>>

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

ロールにコンポジットを追加します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

role-name
必須

ロールの名前（IDではありません！）

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

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

ロールのコンポジットのレルムレベルのロールを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

role-name
必須

ロールの名前（IDではありません！）

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

403

禁止

<<>>

404

見つかりません

<<>>

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

名前でロールを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

role-name
必須

ロールの名前（IDではありません！）

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

400

不正なリクエスト

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

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

名前でロールを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

role-name
必須

ロールの名前（IDではありません！）

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

403

禁止

<<>>

404

見つかりません

<<>>

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

指定されたロール名を持つグループのストリームを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

role-name
必須

ロール名。

null

クエリパラメーター

名前

説明

デフォルト

パターン

briefRepresentation
オプション

false の場合、{@code GroupRepresentation} オブジェクトの完全な表現を返します。

true

first
オプション

返す最初の結果。負の値または {@code null} の場合は無視されます。

null

max
オプション

返す最大結果数。負の値または {@code null} の場合は無視されます。

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

403

禁止

<<>>

404

見つかりません

<<>>

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

ロールの認可権限が初期化されているかどうかを示すオブジェクトと、参照を返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

role-name
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

403

禁止

<<>>

404

見つかりません

<<>>

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

ロールの認可権限が初期化されているかどうかを示すオブジェクトと、参照を返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

role-name
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ManagementPermissionReference
オプション

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

403

禁止

<<>>

404

見つかりません

<<>>

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

名前でロールを更新します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

role-name
必須

ロールの名前（IDではありません！）

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

409

競合

<<>>

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

指定されたロール名を持つユーザーのストリームを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

role-name
必須

ロール名。

null

クエリパラメーター

名前

説明

デフォルト

パターン

briefRepresentation
オプション

簡潔な表現が返されるかどうかを定義するブール値 (デフォルト: false)

null

first
オプション

返す最初の結果。負の値または {@code null} の場合は無視されます。

null

max
オプション

返す最大結果数。負の値または {@code null} の場合は無視されます。

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

403

禁止

<<>>

404

見つかりません

<<>>

ロール (ID別)

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

ロールのコンポジットに含まれるクライアントのクライアントレベルのロールを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

clientUuid
必須

null

role-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

403

禁止

<<>>

404

見つかりません

<<>>

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

ロールのコンポジットからロールのセットを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

role-id
必須

ロールID

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

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

ロールの子を取得します。ロールがコンポジットである場合、ロールの子のセットを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

role-id
必須

null

クエリパラメーター

名前

説明

デフォルト

パターン

first
オプション

null

max
オプション

null

検索
オプション

null

コンテンツタイプ

application/json

レスポンス

コード	メッセージ	データ型
200		List[RoleRepresentation]
403	禁止	<<>>

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

ロールをいくつかの子ロールに関連付けることで、コンポジットロールにします。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

role-id
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

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

ロールのコンポジットに含まれるレルムレベルのロールを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

role-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード	メッセージ	データ型
200		List[RoleRepresentation]
403	禁止	<<>>

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

ロールを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

role-id
必須

ロールのID

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

400

不正なリクエスト

<<>>

403

禁止

<<>>

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

特定のロールの表現を取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

role-id
必須

ロールのID

null

コンテンツタイプ

application/json

レスポンス

コード	メッセージ	データ型
200		RoleRepresentation
403	禁止	<<>>

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

ロールの認可権限が初期化されているかどうかを示すオブジェクトと、参照を返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

role-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード	メッセージ	データ型
200		ManagementPermissionReference
403	禁止	<<>>

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

ロールの認可権限が初期化されているかどうかを示すオブジェクトと、参照を返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

role-id
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

ManagementPermissionReference
オプション

コンテンツタイプ

application/json

レスポンス

コード	メッセージ	データ型
200		ManagementPermissionReference
403	禁止	<<>>

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

ロールを更新します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

role-id
必須

ロールのID

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

スコープマッピング

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

利用可能なクライアントレベルのロール。クライアントのスコープに関連付けることができるクライアントのロールを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

client
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

有効なクライアントロールを取得します。クライアントのスコープに関連付けられているクライアントのロールを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

client
必須

null

クエリパラメーター

名前

説明

デフォルト

パターン

briefRepresentation
オプション

false の場合、ロールをその属性とともに返します。

true

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

クライアントのスコープからクライアントレベルのロールを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

client
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

クライアントのスコープに関連付けられたロールを取得します。クライアントのロールを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

client
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

クライアントレベルのロールをクライアントのスコープに追加します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

client
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

クライアントのすべてのスコープマッピングを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

MappingsRepresentation

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

このクライアントのスコープにアタッチ可能なレルムレベルのロールを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

クライアントのスコープに関連付けられた有効なレルムレベルのロールを取得します。これは、クライアントのスコープに関連付けられたコンポジットロールを再帰的に処理し、ロールをこのリストに追加します。

説明

このメソッドは、クライアントに関連付けられたレルムレベルのロールの包括的な全体像を示すためのものです。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

クエリパラメーター

名前

説明

デフォルト

パターン

briefRepresentation
オプション

false の場合、ロールをその属性とともに返します。

true

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

クライアントのスコープからレルムレベルのロールのセットを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

クライアントのスコープに関連付けられたレルムレベルのロールを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

レルムレベルのロールのセットをクライアントのスコープに追加します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

利用可能なクライアントレベルのロール。クライアントのスコープに関連付けることができるクライアントのロールを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

client
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

有効なクライアントロールを取得します。クライアントのスコープに関連付けられているクライアントのロールを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

client
必須

null

クエリパラメーター

名前

説明

デフォルト

パターン

briefRepresentation
オプション

false の場合、ロールをその属性とともに返します。

true

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

クライアントのスコープからクライアントレベルのロールを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

client
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

クライアントのスコープに関連付けられたロールを取得します。クライアントのロールを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

client
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

クライアントレベルのロールをクライアントのスコープに追加します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

client
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

クライアントのすべてのスコープマッピングを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

MappingsRepresentation

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

このクライアントのスコープにアタッチ可能なレルムレベルのロールを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

説明

このメソッドは、クライアントに関連付けられたレルムレベルのロールの包括的な全体像を示すためのものです。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

クエリパラメーター

名前

説明

デフォルト

パターン

briefRepresentation
オプション

false の場合、ロールをその属性とともに返します。

true

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

クライアントのスコープからレルムレベルのロールのセットを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

クライアントのスコープに関連付けられたレルムレベルのロールを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

レルムレベルのロールのセットをクライアントのスコープに追加します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-scope-id
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

利用可能なクライアントレベルのロール。クライアントのスコープに関連付けることができるクライアントのロールを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

client
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

有効なクライアントロールを取得します。クライアントのスコープに関連付けられているクライアントのロールを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

client
必須

null

クエリパラメーター

名前

説明

デフォルト

パターン

briefRepresentation
オプション

false の場合、ロールをその属性とともに返します。

true

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

クライアントのスコープからクライアントレベルのロールを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

client
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

クライアントのスコープに関連付けられたロールを取得します。クライアントのロールを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

client
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

クライアントレベルのロールをクライアントのスコープに追加します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

client
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

クライアントのすべてのスコープマッピングを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

MappingsRepresentation

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

このクライアントのスコープにアタッチ可能なレルムレベルのロールを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

説明

このメソッドは、クライアントに関連付けられたレルムレベルのロールの包括的な全体像を示すためのものです。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

briefRepresentation
オプション

false の場合、ロールをその属性とともに返します。

true

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

クライアントのスコープからレルムレベルのロールのセットを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

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

クライアントのスコープに関連付けられたレルムレベルのロールを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

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

レルムレベルのロールのセットをクライアントのスコープに追加します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

client-uuid
必須

クライアントの ID (client-id ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

RoleRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

ユーザー

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

指定された条件に一致するユーザー数を返します。

説明

これには3つの異なる呼び出し方があります。 1. 条件を指定せずに {@code null} を渡します。そのレルム内のすべてのユーザー数が返されます。 <p> 2. {@code search} が指定されている場合、{@code last} などの他の条件は設定しても無視されます。 {@code search} 文字列は、ユーザーの姓、名、ユーザー名、およびメールアドレスに対して照合されます。 <p> 3. {@code search} が指定されていないが、{@code last}、{@code first}、{@code email}、または {@code username} のいずれかが指定されている場合、これらの条件はユーザーエンティティのそれぞれのフィールドに対して照合されます。論理積と組み合わせて使用されます。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

email
オプション

メールフィルター

null

emailVerified
オプション

null

enabled
オプション

ユーザーが有効かどうかを表すブール値

null

firstName
オプション

名フィルター

null

lastName
オプション

姓フィルター

null

q
オプション

null

検索
オプション

以下のすべてのフィールドの任意の検索文字列。デフォルトの検索動作はプレフィックスベースです（例：foo または foo*）。中間一致検索には foo を使用し、完全一致検索には "foo" を使用します。

null

username
オプション

ユーザー名フィルター

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

[Integer]

403

禁止

<<>>

GET /admin/realms/{realm}/users

ユーザーを取得します。クエリパラメータに従ってフィルタリングされたユーザーのストリームを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

クエリパラメーター

名前

説明

デフォルト

パターン

briefRepresentation
オプション

簡潔な表現が返されるかどうかを定義するブール値 (デフォルト: false)

null

email
オプション

メールに含まれる文字列、またはパラメータ "exact" が true の場合は完全なメールアドレス

null

emailVerified
オプション

メールが認証されているかどうか

null

enabled
オプション

ユーザーが有効かどうかを表すブール値

null

exact
オプション

パラメータ "last"、"first"、"email" および "username" が完全に一致する必要があるかどうかを定義するブール値

null

first
オプション

ページネーションオフセット

null

firstName
オプション

firstName に含まれる文字列、またはパラメータ "exact" が true の場合は完全な firstName

null

idpAlias
オプション

ユーザーにリンクされたアイデンティティプロバイダーのエイリアス

null

idpUserId
オプション

ユーザーにリンクされたアイデンティティプロバイダーのユーザーID

null

lastName
オプション

lastName に含まれる文字列、またはパラメータ "exact" が true の場合は完全な lastName

null

max
オプション

最大結果サイズ (デフォルトは 100)

null

q
オプション

カスタム属性を検索するクエリ ('key1:value2 key2:value2' 形式)

null

検索
オプション

ユーザー名、名、姓、またはメールアドレスに含まれる文字列。デフォルトの検索動作はプレフィックスベースです（例：foo または foo*）。中間一致検索には foo を使用し、完全一致検索には "foo" を使用します。

null

username
オプション

ユーザー名に含まれる文字列、またはパラメータ "exact" が true の場合は完全なユーザー名

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

403

禁止

<<>>

POST /admin/realms/{realm}/users

新しいユーザーを作成します。ユーザー名は一意である必要があります。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

UserRepresentation
オプション

レスポンス

コード

メッセージ

データ型

201

作成済み

<<>>

400

不正なリクエスト

<<>>

403

禁止

<<>>

409

競合

<<>>

500

内部サーバーエラー

<<>>

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

説明

ユーザープロファイルの設定を取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

UPConfig

403

禁止

<<>>

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

説明

設定から UserProfileMetadata を取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

UserProfileMetadata

403

禁止

<<>>

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

説明

ユーザープロファイルの設定を設定します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

UPConfig
オプション

UPConfig

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

UPConfig

403

禁止

<<>>

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

ユーザーが保存されているユーザーストレージによって提供される資格情報タイプを返します。

説明

返される値には、たとえば「password」、「otp」などが含まれます。これは、ユーザーストレージによってバックアップされていない「ローカル」ユーザーに対しては常に空のリストを返します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[[string]]

403

禁止

<<>>

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

特定のクライアントの同意とオフライントークンをユーザーから取り消します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

client
必須

クライアントID

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

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

ユーザーによって付与された同意を取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[[AnyType]]

403

禁止

<<>>

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

ユーザーの資格情報を削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

credentialId
必須

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

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

資格情報を別の資格情報の後ろの位置に移動します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

credentialId
必須

移動する資格情報

null

newPreviousCredentialId
必須

リスト内の前の要素となる資格情報。 null に設定すると、移動された資格情報はリストの最初の要素になります。

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

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

ユーザーの資格情報リストの最初の位置に資格情報を移動します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

credentialId
必須

移動する資格情報

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

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

ユーザーの資格情報ラベルを更新します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

credentialId
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

body
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[CredentialRepresentation]

403

禁止

<<>>

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

ユーザーを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

400

不正なリクエスト

<<>>

403

禁止

<<>>

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

特定のタイプのユーザーのすべての資格情報を無効にします。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

string
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

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

特定の操作を実行するためにクリックできるリンクを含むメールをユーザーに送信します。

説明

メールには、ユーザーがクリックして必須アクションのセットを実行できるリンクが含まれています。 redirectUri および clientId パラメータはオプションです。リダイレクトが指定されていない場合、アクションが完了した後でクリックするリンクは表示されません。リダイレクト URI は、特定の clientId の有効な URI である必要があります。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

string
オプション

クエリパラメーター

名前

説明

デフォルト

パターン

client_id
オプション

クライアントID

null

lifespan
オプション

生成されたトークンが期限切れになるまでの秒数

null

redirect_uri
オプション

リダイレクト URI

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

400

不正なリクエスト

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

500

内部サーバーエラー

<<>>

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

ユーザーに関連付けられたソーシャルログインを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

List[FederatedIdentityRepresentation]

403

禁止

<<>>

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

ユーザーからソーシャルログインプロバイダーを削除します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

provider
必須

ソーシャルログインプロバイダーID

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

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

ユーザーにソーシャルログインプロバイダーを追加します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

provider
必須

ソーシャルログインプロバイダーID

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

409

競合

<<>>

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

ユーザーの表現を取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

クエリパラメーター

名前

説明

デフォルト

パターン

userProfileMetadata
オプション

ユーザープロファイルメタデータをレスポンスに追加する必要があるかどうかを示します。

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

403

禁止

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

クエリパラメーター

名前

説明

デフォルト

パターン

検索
オプション

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

Map[[long]]

403

禁止

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

クエリパラメーター

名前

説明

デフォルト

パターン

briefRepresentation
オプション

true

first
オプション

null

max
オプション

null

検索
オプション

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

403

禁止

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

グループID
必須

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

400

不正なリクエスト

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

500

内部サーバーエラー

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

グループID
必須

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

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

ユーザーを偽装します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

Map[<<>>]

400

不正なリクエスト

ErrorRepresentation

403

禁止

<<>>

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

ユーザーに関連付けられたすべてのユーザーセッションを削除します。特定のユーザーのセッションを無効にするために、管理 URL を持つすべてのクライアントに通知も送信します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

403

禁止

<<>>

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

ユーザーとクライアントに関連付けられたオフラインセッションを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

clientUuid
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

403

禁止

<<>>

404

見つかりません

<<>>

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

ユーザーを更新します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

UserRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

400

不正なリクエスト

<<>>

403

禁止

<<>>

409

競合

<<>>

500

内部サーバーエラー

<<>>

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

パスワードをリセットするためにクリックできるリンクを含むメールをユーザーに送信します。

説明

redirectUri および clientId パラメータはオプションです。リダイレクトのデフォルトはアカウントクライアントです。このエンドポイントは非推奨になりました。 UPDATE_PASSWORD を含むリストを渡して execute-actions-email を使用してください。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

クエリパラメーター

名前

説明

デフォルト

パターン

client_id
オプション

クライアント ID

null

redirect_uri
オプション

リダイレクト URI

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

400

不正なリクエスト

<<>>

403

禁止

<<>>

404

見つかりません

<<>>

500

内部サーバーエラー

<<>>

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

ユーザーの新しいパスワードを設定します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

リクエストボディパラメーター

名前

説明

デフォルト

パターン

CredentialRepresentation
オプション

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

400

不正なリクエスト

<<>>

403

禁止

<<>>

500

内部サーバーエラー

<<>>

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

メール認証メールをユーザーに送信します。メールには、メールアドレスを確認するためにユーザーがクリックできるリンクが含まれています。

説明

redirectUri、clientId、および lifespan パラメータはオプションです。リダイレクトのデフォルトはアカウントクライアントです。寿命のデフォルトは 12 時間です

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

クエリパラメーター

名前

説明

デフォルト

パターン

client_id
オプション

クライアントID

null

lifespan
オプション

生成されたトークンが期限切れになるまでの秒数

null

redirect_uri
オプション

リダイレクト URI

null

レスポンス

コード

メッセージ

データ型

204

No Content

<<>>

400

不正なリクエスト

<<>>

403

禁止

<<>>

500

内部サーバーエラー

<<>>

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

ユーザーに関連付けられたセッションを取得します。

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

403

禁止

<<>>

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

パラメーター

パスパラメーター

名前

説明

デフォルト

パターン

realm
必須

レルム名 (ID ではない!)

null

user-id
必須

null

コンテンツタイプ

application/json

レスポンス

コード

メッセージ

データ型

200

Map[[string]]

403

禁止

<<>>

定義

AbstractPolicyRepresentation

名前

Type

Format

id
オプション

String

name
オプション

String

description
オプション

String

type
オプション

String

policies
オプション

Set of [string]

resources
オプション

Set of [string]

scopes
オプション

Set of [string]

logic
オプション

Logic

decisionStrategy
オプション

DecisionStrategy

owner
オプション

String

resourceType
オプション

String

resourcesData
オプション

Set of ResourceRepresentation

scopesData
オプション

アクセス

名前

Type

Format

roles
オプション

Set of [string]

verify_caller
オプション

Boolean

AccessToken

名前

Type

Format

jti
オプション

String

exp
オプション

Long

int64

nbf
オプション

Long

int64

iat
オプション

Long

int64

iss
オプション

String

sub
オプション

String

typ
オプション

String

azp
オプション

String

otherClaims
オプション

Map of [AnyType]

nonce
オプション

String

auth_time
オプション

Long

int64

sid
オプション

String

at_hash
オプション

String

c_hash
オプション

String

name
オプション

String

given_name
オプション

String

family_name
オプション

String

middle_name
オプション

String

nickname
オプション

String

preferred_username
オプション

String

profile
オプション

String

picture
オプション

String

website
オプション

String

email
オプション

String

email_verified
オプション

Boolean

gender
オプション

String

birthdate
オプション

String

zoneinfo
オプション

String

ロケール
オプション

String

phone_number
オプション

String

phone_number_verified
オプション

Boolean

address
オプション

AddressClaimSet

updated_at
オプション

Long

int64

claims_locales
オプション

String

acr
オプション

String

s_hash
オプション

String

trusted-certs
オプション

Set of [string]

allowed-origins
オプション

Set of [string]

realm_access
オプション

アクセス

resource_access
オプション

Map of Access

authorization
オプション

Authorization

cnf
オプション

Confirmation

scope
オプション

String

AddressClaimSet

名前

Type

Format

formatted
オプション

String

street_address
オプション

String

locality
オプション

String

region
オプション

String

postal_code
オプション

String

country
オプション

String

AdminEventRepresentation

名前

Type

Format

id
オプション

String

time
オプション

Long

int64

realmId
オプション

String

authDetails
オプション

AuthDetailsRepresentation

operationType
オプション

String

resourceType
オプション

String

resourcePath
オプション

String

representation
オプション

String

error
オプション

String

details
オプション

Map of [string]

ApplicationRepresentation

名前

Type

Format

id
オプション

String

clientId
オプション

String

description
オプション

String

type
オプション

String

rootUrl
オプション

String

adminUrl
オプション

String

baseUrl
オプション

String

surrogateAuthRequired
オプション

Boolean

enabled
オプション

Boolean

alwaysDisplayInConsole
オプション

Boolean

clientAuthenticatorType
オプション

String

secret
オプション

String

registrationAccessToken
オプション

String

defaultRoles
オプション

List of [string]

redirectUris
オプション

List of [string]

webOrigins
オプション

List of [string]

notBefore
オプション

Integer

int32

bearerOnly
オプション

Boolean

consentRequired
オプション

Boolean

standardFlowEnabled
オプション

Boolean

implicitFlowEnabled
オプション

Boolean

directAccessGrantsEnabled
オプション

Boolean

serviceAccountsEnabled
オプション

Boolean

authorizationServicesEnabled
オプション

Boolean

directGrantsOnly
オプション

Boolean

publicClient
オプション

Boolean

frontchannelLogout
オプション

Boolean

プロトコル
オプション

String

attributes
オプション

Map of [string]

authenticationFlowBindingOverrides
オプション

Map of [string]

fullScopeAllowed
オプション

Boolean

nodeReRegistrationTimeout
オプション

Integer

int32

registeredNodes
オプション

Map of [integer]

int32

protocolMappers
オプション

clientTemplate
オプション

String

useTemplateConfig
オプション

Boolean

useTemplateScope
オプション

Boolean

useTemplateMappers
オプション

Boolean

defaultClientScopes
オプション

List of [string]

optionalClientScopes
オプション

List of [string]

authorizationSettings
オプション

ResourceServerRepresentation

access
オプション

Map of [boolean]

origin
オプション

String

name
オプション

String

claims
オプション

ApplicationRepresentation_claims

ApplicationRepresentationClaims

名前

Type

Format

name
オプション

Boolean

username
オプション

Boolean

profile
オプション

Boolean

picture
オプション

Boolean

website
オプション

Boolean

email
オプション

Boolean

gender
オプション

Boolean

ロケール
オプション

Boolean

address
オプション

Boolean

phone
オプション

Boolean

AuthDetailsRepresentation

名前

Type

Format

realmId
オプション

String

clientId
オプション

String

userId
オプション

String

ipAddress
オプション

String

AuthenticationExecutionExportRepresentation

名前

Type

Format

authenticatorConfig
オプション

String

authenticator
オプション

String

authenticatorFlow
オプション

Boolean

requirement
オプション

String

priority
オプション

Integer

int32

autheticatorFlow
オプション

Boolean

flowAlias
オプション

String

userSetupAllowed
オプション

Boolean

AuthenticationExecutionInfoRepresentation

名前

Type

Format

id
オプション

String

requirement
オプション

String

displayName
オプション

String

alias
オプション

String

description
オプション

String

requirementChoices
オプション

List of [string]

configurable
オプション

Boolean

authenticationFlow
オプション

Boolean

providerId
オプション

String

authenticationConfig
オプション

String

flowId
オプション

String

level
オプション

Integer

int32

index
オプション

Integer

int32

priority
オプション

Integer

int32

AuthenticationExecutionRepresentation

名前

Type

Format

authenticatorConfig
オプション

String

authenticator
オプション

String

authenticatorFlow
オプション

Boolean

requirement
オプション

String

priority
オプション

Integer

int32

autheticatorFlow
オプション

Boolean

id
オプション

String

flowId
オプション

String

parentFlow
オプション

String

AuthenticationFlowRepresentation

名前

Type

Format

id
オプション

String

alias
オプション

String

description
オプション

String

providerId
オプション

String

topLevel
オプション

Boolean

builtIn
オプション

Boolean

authenticationExecutions
オプション

List of AuthenticationExecutionExportRepresentation

AuthenticatorConfigInfoRepresentation

名前

Type

Format

name
オプション

String

providerId
オプション

String

helpText
オプション

String

properties
オプション

AuthenticatorConfigRepresentation

名前

Type

Format

id
オプション

String

alias
オプション

String

config
オプション

Map of [string]

Authorization

名前

Type

Format

permissions
オプション

List of Permission

AuthorizationSchema

名前

Type

Format

resourceTypes
オプション

Map of ResourceType

BruteForceStrategy

名前

Type

Format

CertificateRepresentation

名前

Type

Format

privateKey
オプション

String

publicKey
オプション

String

certificate
オプション

String

kid
オプション

String

ClaimRepresentation

名前

Type

Format

name
オプション

Boolean

username
オプション

Boolean

profile
オプション

Boolean

picture
オプション

Boolean

website
オプション

Boolean

email
オプション

Boolean

gender
オプション

Boolean

ロケール
オプション

Boolean

address
オプション

Boolean

phone
オプション

Boolean

ClientInitialAccessCreatePresentation

名前

Type

Format

expiration
オプション

Integer

int32

count
オプション

Integer

int32

ClientInitialAccessPresentation

名前

Type

Format

id
オプション

String

token
オプション

String

timestamp
オプション

Integer

int32

expiration
オプション

Integer

int32

count
オプション

Integer

int32

remainingCount
オプション

Integer

int32

ClientMappingsRepresentation

名前

Type

Format

id
オプション

String

client
オプション

String

mappings
オプション

List of RoleRepresentation

ClientPoliciesRepresentation

名前

Type

Format

policies
オプション

List of ClientPolicyRepresentation

globalPolicies
オプション

List of ClientPolicyRepresentation

ClientPolicyConditionRepresentation

名前

Type

Format

condition
オプション

String

configuration
オプション

List

ClientPolicyExecutorRepresentation

名前

Type

Format

executor
オプション

String

configuration
オプション

List

ClientPolicyRepresentation

名前

Type

Format

name
オプション

String

description
オプション

String

enabled
オプション

Boolean

conditions
オプション

List of ClientPolicyConditionRepresentation

profiles
オプション

List of [string]

ClientProfileRepresentation

名前

Type

Format

name
オプション

String

description
オプション

String

executors
オプション

List of ClientPolicyExecutorRepresentation

ClientProfilesRepresentation

名前

Type

Format

profiles
オプション

List of ClientProfileRepresentation

globalProfiles
オプション

List of ClientProfileRepresentation

ClientRepresentation

名前

Type

Format

id
オプション

String

clientId
オプション

String

name
オプション

String

description
オプション

String

type
オプション

String

rootUrl
オプション

String

adminUrl
オプション

String

baseUrl
オプション

String

surrogateAuthRequired
オプション

Boolean

enabled
オプション

Boolean

alwaysDisplayInConsole
オプション

Boolean

clientAuthenticatorType
オプション

String

secret
オプション

String

registrationAccessToken
オプション

String

defaultRoles
オプション

List of [string]

redirectUris
オプション

List of [string]

webOrigins
オプション

List of [string]

notBefore
オプション

Integer

int32

bearerOnly
オプション

Boolean

consentRequired
オプション

Boolean

standardFlowEnabled
オプション

Boolean

implicitFlowEnabled
オプション

Boolean

directAccessGrantsEnabled
オプション

Boolean

serviceAccountsEnabled
オプション

Boolean

authorizationServicesEnabled
オプション

Boolean

directGrantsOnly
オプション

Boolean

publicClient
オプション

Boolean

frontchannelLogout
オプション

Boolean

プロトコル
オプション

String

attributes
オプション

Map of [string]

authenticationFlowBindingOverrides
オプション

Map of [string]

fullScopeAllowed
オプション

Boolean

nodeReRegistrationTimeout
オプション

Integer

int32

registeredNodes
オプション

Map of [integer]

int32

protocolMappers
オプション

clientTemplate
オプション

String

useTemplateConfig
オプション

Boolean

useTemplateScope
オプション

Boolean

useTemplateMappers
オプション

Boolean

defaultClientScopes
オプション

List of [string]

optionalClientScopes
オプション

List of [string]

authorizationSettings
オプション

ResourceServerRepresentation

access
オプション

Map of [boolean]

origin
オプション

String

ClientScopeRepresentation

名前

Type

Format

id
オプション

String

name
オプション

String

description
オプション

String

プロトコル
オプション

String

attributes
オプション

Map of [string]

protocolMappers
オプション

ClientTemplateRepresentation

名前

Type

Format

id
オプション

String

name
オプション

String

description
オプション

String

プロトコル
オプション

String

fullScopeAllowed
オプション

Boolean

bearerOnly
オプション

Boolean

consentRequired
オプション

Boolean

standardFlowEnabled
オプション

Boolean

implicitFlowEnabled
オプション

Boolean

directAccessGrantsEnabled
オプション

Boolean

serviceAccountsEnabled
オプション

Boolean

publicClient
オプション

Boolean

frontchannelLogout
オプション

Boolean

attributes
オプション

Map of [string]

protocolMappers
オプション

ClientTypeRepresentation

名前

Type

Format

name
オプション

String

provider
オプション

String

parent
オプション

String

config
オプション

Map of PropertyConfig

ClientTypesRepresentation

名前

Type

Format

client-types
オプション

List of ClientTypeRepresentation

global-client-types
オプション

List of ClientTypeRepresentation

ComponentExportRepresentation

名前

Type

Format

id
オプション

String

name
オプション

String

providerId
オプション

String

subType
オプション

String

subComponents
オプション

Map of [array]

config
オプション

Map of [array]

ComponentRepresentation

名前

Type

Format

id
オプション

String

name
オプション

String

providerId
オプション

String

providerType
オプション

String

parentId
オプション

String

subType
オプション

String

config
オプション

Map of [array]

ComponentTypeRepresentation

名前

Type

Format

id
オプション

String

helpText
オプション

String

properties
オプション

metadata
オプション

Map of [AnyType]

Composites

名前

Type

Format

realm
オプション

Set of [string]

client
オプション

Map of [array]

application
オプション

Map of [array]

ConfigPropertyRepresentation

名前

Type

Format

name
オプション

String

label
オプション

String

helpText
オプション

String

type
オプション

String

defaultValue
オプション

oas_any_type_not_mapped

options
オプション

List of [string]

secret
オプション

Boolean

必須
オプション

Boolean

readOnly
オプション

Boolean

Confirmation

名前

Type

Format

x5t#S256
オプション

String

jkt
オプション

String

CredentialRepresentation

名前

Type

Format

id
オプション

String

type
オプション

String

userLabel
オプション

String

createdDate
オプション

Long

int64

secretData
オプション

String

credentialData
オプション

String

priority
オプション

Integer

int32

value
オプション

String

temporary
オプション

Boolean

device
オプション

String

hashedSaltedValue
オプション

String

salt
オプション

String

hashIterations
オプション

Integer

int32

counter
オプション

Integer

int32

algorithm
オプション

String

digits
オプション

Integer

int32

period
オプション

Integer

int32

config
オプション

Map

federationLink
オプション

String

DecisionEffect

名前

Type

Format

DecisionStrategy

名前

Type

Format

EnforcementMode

名前

Type

Format

ErrorRepresentation

名前

Type

Format

field
オプション

String

errorMessage
オプション

String

params
オプション

List of [AnyType]

errors
オプション

List of ErrorRepresentation

EvaluationResultRepresentation

名前

Type

Format

resource
オプション

ResourceRepresentation

scopes
オプション

List of ScopeRepresentation

policies
オプション

Set of PolicyResultRepresentation

status
オプション

DecisionEffect

allowedScopes
オプション

deniedScopes
オプション

EventRepresentation

名前

Type

Format

id
オプション

String

time
オプション

Long

int64

type
オプション

String

realmId
オプション

String

clientId
オプション

String

userId
オプション

String

sessionId
オプション

String

ipAddress
オプション

String

error
オプション

String

details
オプション

Map of [string]

FederatedIdentityRepresentation

名前

Type

Format

identityProvider
オプション

String

userId
オプション

String

userName
オプション

String

GlobalRequestResult

名前

Type

Format

successRequests
オプション

List of [string]

failedRequests
オプション

List of [string]

GroupRepresentation

名前

Type

Format

id
オプション

String

name
オプション

String

パス
オプション

String

parentId
オプション

String

subGroupCount
オプション

Long

int64

subGroups
オプション

List of GroupRepresentation

attributes
オプション

Map of [array]

realmRoles
オプション

List of [string]

clientRoles
オプション

Map of [array]

access
オプション

Map of [boolean]

IDToken

名前

Type

Format

jti
オプション

String

exp
オプション

Long

int64

nbf
オプション

Long

int64

iat
オプション

Long

int64

iss
オプション

String

sub
オプション

String

typ
オプション

String

azp
オプション

String

otherClaims
オプション

Map of [AnyType]

nonce
オプション

String

auth_time
オプション

Long

int64

sid
オプション

String

at_hash
オプション

String

c_hash
オプション

String

name
オプション

String

given_name
オプション

String

family_name
オプション

String

middle_name
オプション

String

nickname
オプション

String

preferred_username
オプション

String

profile
オプション

String

picture
オプション

String

website
オプション

String

email
オプション

String

email_verified
オプション

Boolean

gender
オプション

String

birthdate
オプション

String

zoneinfo
オプション

String

ロケール
オプション

String

phone_number
オプション

String

phone_number_verified
オプション

Boolean

address
オプション

AddressClaimSet

updated_at
オプション

Long

int64

claims_locales
オプション

String

acr
オプション

String

s_hash
オプション

String

IdentityProviderMapperRepresentation

名前

Type

Format

id
オプション

String

name
オプション

String

identityProviderAlias
オプション

String

identityProviderMapper
オプション

String

config
オプション

Map of [string]

IdentityProviderMapperTypeRepresentation

名前

Type

Format

id
オプション

String

name
オプション

String

category
オプション

String

helpText
オプション

String

properties
オプション

IdentityProviderRepresentation

名前

Type

Format

alias
オプション

String

displayName
オプション

String

internalId
オプション

String

providerId
オプション

String

enabled
オプション

Boolean

updateProfileFirstLoginMode
オプション

String

trustEmail
オプション

Boolean

storeToken
オプション

Boolean

addReadTokenRoleOnCreate
オプション

Boolean

authenticateByDefault
オプション

Boolean

linkOnly
オプション

Boolean

hideOnLogin
オプション

Boolean

firstBrokerLoginFlowAlias
オプション

String

postBrokerLoginFlowAlias
オプション

String

organizationId
オプション

String

config
オプション

Map of [string]

updateProfileFirstLogin
オプション

Boolean

InstallationAdapterConfig

名前

Type

Format

realm
オプション

String

realm-public-key
オプション

String

auth-server-url
オプション

String

ssl-required
オプション

String

bearer-only
オプション

Boolean

resource
オプション

String

public-client
オプション

Boolean

verify-token-audience
オプション

Boolean

credentials
オプション

Map of [AnyType]

use-resource-role-mappings
オプション

Boolean

confidential-port
オプション

Integer

int32

policy-enforcer
オプション

PolicyEnforcerConfig

KeyMetadataRepresentation

名前

Type

Format

providerId
オプション

String

providerPriority
オプション

Long

int64

kid
オプション

String

status
オプション

String

type
オプション

String

algorithm
オプション

String

publicKey
オプション

String

certificate
オプション

String

use
オプション

KeyUse

validTo
オプション

Long

int64

KeyStoreConfig

名前

Type

Format

realmCertificate
オプション

Boolean

storePassword
オプション

String

keyPassword
オプション

String

keyAlias
オプション

String

realmAlias
オプション

String

format
オプション

String

KeyUse

名前

Type

Format

KeysMetadataRepresentation

名前

Type

Format

active
オプション

Map of [string]

keys
オプション

List of KeyMetadataRepresentation

Logic

名前

Type

Format

ManagementPermissionReference

名前

Type

Format

enabled
オプション

Boolean

resource
オプション

String

scopePermissions
オプション

Map of [string]

MappingsRepresentation

名前

Type

Format

realmMappings
オプション

List of RoleRepresentation

clientMappings
オプション

Map of ClientMappingsRepresentation

MemberRepresentation

名前

Type

Format

id
オプション

String

username
オプション

String

firstName
オプション

String

lastName
オプション

String

email
オプション

String

emailVerified
オプション

Boolean

attributes
オプション

Map of [array]

userProfileMetadata
オプション

UserProfileMetadata

self
オプション

String

origin
オプション

String

createdTimestamp
オプション

Long

int64

enabled
オプション

Boolean

totp
オプション

Boolean

federationLink
オプション

String

serviceAccountClientId
オプション

String

credentials
オプション

List of CredentialRepresentation

disableableCredentialTypes
オプション

Set of [string]

requiredActions
オプション

List of [string]

federatedIdentities
オプション

List of FederatedIdentityRepresentation

realmRoles
オプション

List of [string]

clientRoles
オプション

Map of [array]

clientConsents
オプション

List of UserConsentRepresentation

notBefore
オプション

Integer

int32

applicationRoles
オプション

Map of [array]

socialLinks
オプション

List of SocialLinkRepresentation

groups
オプション

List of [string]

access
オプション

Map of [boolean]

membershipType
オプション

MembershipType

名前

Type

Format

MethodConfig

名前

Type

Format

method
オプション

String

scopes
オプション

List of [string]

scopes-enforcement-mode
オプション

ScopeEnforcementMode

OAuthClientRepresentation

名前

Type

Format

id
オプション

String

clientId
オプション

String

description
オプション

String

type
オプション

String

rootUrl
オプション

String

adminUrl
オプション

String

baseUrl
オプション

String

surrogateAuthRequired
オプション

Boolean

enabled
オプション

Boolean

alwaysDisplayInConsole
オプション

Boolean

clientAuthenticatorType
オプション

String

secret
オプション

String

registrationAccessToken
オプション

String

defaultRoles
オプション

List of [string]

redirectUris
オプション

List of [string]

webOrigins
オプション

List of [string]

notBefore
オプション

Integer

int32

bearerOnly
オプション

Boolean

consentRequired
オプション

Boolean

standardFlowEnabled
オプション

Boolean

implicitFlowEnabled
オプション

Boolean

directAccessGrantsEnabled
オプション

Boolean

serviceAccountsEnabled
オプション

Boolean

authorizationServicesEnabled
オプション

Boolean

directGrantsOnly
オプション

Boolean

publicClient
オプション

Boolean

frontchannelLogout
オプション

Boolean

プロトコル
オプション

String

attributes
オプション

Map of [string]

authenticationFlowBindingOverrides
オプション

Map of [string]

fullScopeAllowed
オプション

Boolean

nodeReRegistrationTimeout
オプション

Integer

int32

registeredNodes
オプション

Map of [integer]

int32

protocolMappers
オプション

clientTemplate
オプション

String

useTemplateConfig
オプション

Boolean

useTemplateScope
オプション

Boolean

useTemplateMappers
オプション

Boolean

defaultClientScopes
オプション

List of [string]

optionalClientScopes
オプション

List of [string]

authorizationSettings
オプション

ResourceServerRepresentation

access
オプション

Map of [boolean]

origin
オプション

String

name
オプション

String

claims
オプション

ApplicationRepresentation_claims

OrganizationDomainRepresentation

名前

Type

Format

name
オプション

String

verified
オプション

Boolean

OrganizationRepresentation

名前

Type

Format

id
オプション

String

name
オプション

String

alias
オプション

String

enabled
オプション

Boolean

description
オプション

String

redirectUrl
オプション

String

attributes
オプション

Map of [array]

domains
オプション

Set of OrganizationDomainRepresentation

members
オプション

List of MemberRepresentation

identityProviders
オプション

List of IdentityProviderRepresentation

PathCacheConfig

名前

Type

Format

max-entries
オプション

Integer

int32

lifespan
オプション

Long

int64

PathConfig

名前

Type

Format

name
オプション

String

type
オプション

String

パス
オプション

String

methods
オプション

List of MethodConfig

scopes
オプション

List of [string]

id
オプション

String

enforcement-mode
オプション

EnforcementMode

claim-information-point
オプション

Map of [map]

invalidated
オプション

Boolean

staticPath
オプション

Boolean

static
オプション

Boolean

Permission

名前

Type

Format

rsid
オプション

String

rsname
オプション

String

scopes
オプション

Set of [string]

claims
オプション

Map of [set]

PolicyEnforcementMode

名前

Type

Format

PolicyEnforcerConfig

名前

Type

Format

enforcement-mode
オプション

EnforcementMode

paths
オプション

List of PathConfig

path-cache
オプション

PathCacheConfig

lazy-load-paths
オプション

Boolean

on-deny-redirect-to
オプション

String

user-managed-access
オプション

Object

claim-information-point
オプション

Map of [map]

http-method-as-scope
オプション

Boolean

realm
オプション

String

auth-server-url
オプション

String

credentials
オプション

Map of [AnyType]

resource
オプション

String

PolicyEvaluationRequest

名前

Type

Format

context
オプション

Map of [map]

resources
オプション

List of ResourceRepresentation

resourceType
オプション

String

clientId
オプション

String

userId
オプション

String

roleIds
オプション

List of [string]

entitlements
オプション

Boolean

PolicyEvaluationResponse

名前

Type

Format

results
オプション

List of EvaluationResultRepresentation

entitlements
オプション

Boolean

status
オプション

DecisionEffect

rpt
オプション

AccessToken

PolicyProviderRepresentation

名前

Type

Format

type
オプション

String

name
オプション

String

group
オプション

String

PolicyRepresentation

名前

Type

Format

id
オプション

String

name
オプション

String

description
オプション

String

type
オプション

String

policies
オプション

Set of [string]

resources
オプション

Set of [string]

scopes
オプション

Set of [string]

logic
オプション

Logic

decisionStrategy
オプション

DecisionStrategy

owner
オプション

String

resourceType
オプション

String

resourcesData
オプション

Set of ResourceRepresentation

scopesData
オプション

config
オプション

Map of [string]

PolicyResultRepresentation

名前

Type

Format

policy
オプション

PolicyRepresentation

status
オプション

DecisionEffect

associatedPolicies
オプション

List of PolicyResultRepresentation

scopes
オプション

Set of [string]

resourceType
オプション

String

PropertyConfig

名前

Type

Format

applicable
オプション

Boolean

value
オプション

oas_any_type_not_mapped

ProtocolMapperEvaluationRepresentation

名前

Type

Format

mapperId
オプション

String

mapperName
オプション

String

containerId
オプション

String

containerName
オプション

String

containerType
オプション

String

protocolMapper
オプション

String

ProtocolMapperRepresentation

名前

Type

Format

id
オプション

String

name
オプション

String

プロトコル
オプション

String

protocolMapper
オプション

String

consentRequired
オプション

Boolean

consentText
オプション

String

config
オプション

Map of [string]

PublishedRealmRepresentation

名前

Type

Format

realm
オプション

String

public_key
オプション

String

token-service
オプション

String

account-service
オプション

String

tokens-not-before
オプション

Integer

int32

RealmEventsConfigRepresentation

名前

Type

Format

eventsEnabled
オプション

Boolean

eventsExpiration
オプション

Long

int64

eventsListeners
オプション

List of [string]

enabledEventTypes
オプション

List of [string]

adminEventsEnabled
オプション

Boolean

adminEventsDetailsEnabled
オプション

Boolean

RealmRepresentation

名前

Type

Format

id
オプション

String

realm
オプション

String

displayName
オプション

String

displayNameHtml
オプション

String

notBefore
オプション

Integer

int32

defaultSignatureAlgorithm
オプション

String

revokeRefreshToken
オプション

Boolean

refreshTokenMaxReuse
オプション

Integer

int32

accessTokenLifespan
オプション

Integer

int32

accessTokenLifespanForImplicitFlow
オプション

Integer

int32

ssoSessionIdleTimeout
オプション

Integer

int32

ssoSessionMaxLifespan
オプション

Integer

int32

ssoSessionIdleTimeoutRememberMe
オプション

Integer

int32

ssoSessionMaxLifespanRememberMe
オプション

Integer

int32

offlineSessionIdleTimeout
オプション

Integer

int32

offlineSessionMaxLifespanEnabled
オプション

Boolean

offlineSessionMaxLifespan
オプション

Integer

int32

clientSessionIdleTimeout
オプション

Integer

int32

clientSessionMaxLifespan
オプション

Integer

int32

clientOfflineSessionIdleTimeout
オプション

Integer

int32

clientOfflineSessionMaxLifespan
オプション

Integer

int32

accessCodeLifespan
オプション

Integer

int32

accessCodeLifespanUserAction
オプション

Integer

int32

accessCodeLifespanLogin
オプション

Integer

int32

actionTokenGeneratedByAdminLifespan
オプション

Integer

int32

actionTokenGeneratedByUserLifespan
オプション

Integer

int32

oauth2DeviceCodeLifespan
オプション

Integer

int32

oauth2DevicePollingInterval
オプション

Integer

int32

enabled
オプション

Boolean

sslRequired
オプション

String

passwordCredentialGrantAllowed
オプション

Boolean

registrationAllowed
オプション

Boolean

registrationEmailAsUsername
オプション

Boolean

rememberMe
オプション

Boolean

verifyEmail
オプション

Boolean

loginWithEmailAllowed
オプション

Boolean

duplicateEmailsAllowed
オプション

Boolean

resetPasswordAllowed
オプション

Boolean

editUsernameAllowed
オプション

Boolean

userCacheEnabled
オプション

Boolean

realmCacheEnabled
オプション

Boolean

bruteForceProtected
オプション

Boolean

permanentLockout
オプション

Boolean

maxTemporaryLockouts
オプション

Integer

int32

bruteForceStrategy
オプション

BruteForceStrategy

maxFailureWaitSeconds
オプション

Integer

int32

minimumQuickLoginWaitSeconds
オプション

Integer

int32

waitIncrementSeconds
オプション

Integer

int32

quickLoginCheckMilliSeconds
オプション

Long

int64

maxDeltaTimeSeconds
オプション

Integer

int32

failureFactor
オプション

Integer

int32

privateKey
オプション

String

publicKey
オプション

String

certificate
オプション

String

codeSecret
オプション

String

roles
オプション

RolesRepresentation

groups
オプション

List of GroupRepresentation

defaultRoles
オプション

List of [string]

defaultRole
オプション

RoleRepresentation

adminPermissionsClient
オプション

ClientRepresentation

defaultGroups
オプション

List of [string]

requiredCredentials
オプション

Set of [string]

passwordPolicy
オプション

String

otpPolicyType
オプション

String

otpPolicyAlgorithm
オプション

String

otpPolicyInitialCounter
オプション

Integer

int32

otpPolicyDigits
オプション

Integer

int32

otpPolicyLookAheadWindow
オプション

Integer

int32

otpPolicyPeriod
オプション

Integer

int32

otpPolicyCodeReusable
オプション

Boolean

otpSupportedApplications
オプション

List of [string]

localizationTexts
オプション

Map of [map]

webAuthnPolicyRpEntityName
オプション

String

webAuthnPolicySignatureAlgorithms
オプション

List of [string]

webAuthnPolicyRpId
オプション

String

webAuthnPolicyAttestationConveyancePreference
オプション

String

webAuthnPolicyAuthenticatorAttachment
オプション

String

webAuthnPolicyRequireResidentKey
オプション

String

webAuthnPolicyUserVerificationRequirement
オプション

String

webAuthnPolicyCreateTimeout
オプション

Integer

int32

webAuthnPolicyAvoidSameAuthenticatorRegister
オプション

Boolean

webAuthnPolicyAcceptableAaguids
オプション

List of [string]

webAuthnPolicyExtraOrigins
オプション

List of [string]

webAuthnPolicyPasswordlessRpEntityName
オプション

String

webAuthnPolicyPasswordlessSignatureAlgorithms
オプション

List of [string]

webAuthnPolicyPasswordlessRpId
オプション

String

webAuthnPolicyPasswordlessAttestationConveyancePreference
オプション

String

webAuthnPolicyPasswordlessAuthenticatorAttachment
オプション

String

webAuthnPolicyPasswordlessRequireResidentKey
オプション

String

webAuthnPolicyPasswordlessUserVerificationRequirement
オプション

String

webAuthnPolicyPasswordlessCreateTimeout
オプション

Integer

int32

webAuthnPolicyPasswordlessAvoidSameAuthenticatorRegister
オプション

Boolean

webAuthnPolicyPasswordlessAcceptableAaguids
オプション

List of [string]

webAuthnPolicyPasswordlessExtraOrigins
オプション

List of [string]

clientProfiles
オプション

ClientProfilesRepresentation

clientPolicies
オプション

ClientPoliciesRepresentation

users
オプション

List of UserRepresentation

federatedUsers
オプション

List of UserRepresentation

scopeMappings
オプション

List of ScopeMappingRepresentation

clientScopeMappings
オプション

Map of [array]

clients
オプション

List of ClientRepresentation

clientScopes
オプション

List of ClientScopeRepresentation

defaultDefaultClientScopes
オプション

List of [string]

defaultOptionalClientScopes
オプション

List of [string]

browserSecurityHeaders
オプション

Map of [string]

smtpServer
オプション

Map of [string]

userFederationProviders
オプション

List of UserFederationProviderRepresentation

userFederationMappers
オプション

List of UserFederationMapperRepresentation

loginTheme
オプション

String

accountTheme
オプション

String

adminTheme
オプション

String

emailTheme
オプション

String

eventsEnabled
オプション

Boolean

eventsExpiration
オプション

Long

int64

eventsListeners
オプション

List of [string]

enabledEventTypes
オプション

List of [string]

adminEventsEnabled
オプション

Boolean

adminEventsDetailsEnabled
オプション

Boolean

identityProviders
オプション

List of IdentityProviderRepresentation

identityProviderMappers
オプション

List of IdentityProviderMapperRepresentation

protocolMappers
オプション

components
オプション

Map of [array]

internationalizationEnabled
オプション

Boolean

supportedLocales
オプション

Set of [string]

defaultLocale
オプション

String

authenticationFlows
オプション

List of AuthenticationFlowRepresentation

authenticatorConfig
オプション

List of AuthenticatorConfigRepresentation

requiredActions
オプション

List of RequiredActionProviderRepresentation

browserFlow
オプション

String

registrationFlow
オプション

String

directGrantFlow
オプション

String

resetCredentialsFlow
オプション

String

clientAuthenticationFlow
オプション

String

dockerAuthenticationFlow
オプション

String

firstBrokerLoginFlow
オプション

String

attributes
オプション

Map of [string]

keycloakVersion
オプション

String

userManagedAccessAllowed
オプション

Boolean

organizationsEnabled
オプション

Boolean

organizations
オプション

List of OrganizationRepresentation

verifiableCredentialsEnabled
オプション

Boolean

adminPermissionsEnabled
オプション

Boolean

social
オプション

Boolean

updateProfileOnInitialSocialLogin
オプション

Boolean

socialProviders
オプション

Map of [string]

applicationScopeMappings
オプション

Map of [array]

applications
オプション

List of ApplicationRepresentation

oauthClients
オプション

List of OAuthClientRepresentation

clientTemplates
オプション

List of ClientTemplateRepresentation

oAuth2DeviceCodeLifespan
オプション

Integer

int32

oAuth2DevicePollingInterval
オプション

Integer

int32

RequiredActionConfigInfoRepresentation

名前

Type

Format

properties
オプション

RequiredActionConfigRepresentation

名前

Type

Format

config
オプション

Map of [string]

RequiredActionProviderRepresentation

名前

Type

Format

alias
オプション

String

name
オプション

String

providerId
オプション

String

enabled
オプション

Boolean

defaultAction
オプション

Boolean

priority
オプション

Integer

int32

config
オプション

Map of [string]

ResourceOwnerRepresentation

名前

Type

Format

id
オプション

String

name
オプション

String

ResourceRepresentation

名前

Type

Format

id
_オプション

String

name
オプション

String

uris
オプション

Set of [string]

type
オプション

String

scopes
オプション

icon_uri
オプション

String

owner
オプション

ResourceRepresentation_owner

ownerManagedAccess
オプション

Boolean

displayName
オプション

String

attributes
オプション

Map of [array]

uri
オプション

String

scopesUma
オプション