Overview

This is a REST API reference for the Keycloak Admin

Version information

Version: 1

URI scheme

Host: localhost:8080 BasePath: /auth Schemes: HTTP

Paths

Get accessible realms

Returns a list of accessible realms.
GET /admin/realms

Description

The list is filtered based on what realms the caller is allowed to view.

Responses

HTTP Code Description Schema

default

success

RealmRepresentation array

Produces

  • application/json

Tags

  • admin

Import a realm

Imports a realm from a full representation of that realm.
POST /admin/realms

Description

Realm name must be unique.

Parameters

Type Name Description Required Schema Default

BodyParameter

rep

JSON representation of the realm

true

RealmRepresentation

Responses

HTTP Code Description Schema

default

success

[Response]

Consumes

  • application/json

Tags

  • admin

Get the top-level representation of the realm

It will not include nested information like User and Client representations.
GET /admin/realms/{realm}

Parameters

Type Name Description Required Schema Default

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RealmRepresentation

Produces

  • application/json

Tags

  • admin

Update the top-level information of the realm

Any user, roles or client information in the representation
will be ignored.
PUT /admin/realms/{realm}

Description

This will only update top-level attributes of the realm.

Parameters

Type Name Description Required Schema Default

BodyParameter

rep

true

RealmRepresentation

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Consumes

  • application/json

Tags

  • admin

Delete the realm

DELETE /admin/realms/{realm}

Parameters

Type Name Description Required Schema Default

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

Get admin events

Returns all admin events, or filters events based on URL query parameters listed here
GET /admin/realms/{realm}/admin-events

Parameters

Type Name Description Required Schema Default

QueryParameter

operationTypes

false

csv string array

QueryParameter

authRealm

false

string

QueryParameter

authClient

false

string

QueryParameter

authUser

user id

false

string

QueryParameter

authIpAddress

false

string

QueryParameter

resourcePath

false

string

QueryParameter

dateFrom

false

string

QueryParameter

dateTo

false

string

QueryParameter

first

false

integer (int32)

QueryParameter

max

Maximum results size (defaults to 100)

false

integer (int32)

QueryParameter

resourceTypes

false

csv string array

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

AdminEventRepresentation array

Produces

  • application/json

Tags

  • admin

Delete all admin events

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

Parameters

Type Name Description Required Schema Default

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

Clear any user login failures for all users

This can release temporary disabled users
DELETE /admin/realms/{realm}/attack-detection/brute-force/users

Parameters

Type Name Description Required Schema Default

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

Get status of a username in brute force detection

GET /admin/realms/{realm}/attack-detection/brute-force/users/{userId}

Parameters

Type Name Description Required Schema Default

PathParameter

userId

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Map]

Produces

  • application/json

Tags

  • admin

Clear any user login failures for the user

This can release temporary disabled user
DELETE /admin/realms/{realm}/attack-detection/brute-force/users/{userId}

Parameters

Type Name Description Required Schema Default

PathParameter

userId

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

Get authenticator providers

Returns a list of authenticator providers.
GET /admin/realms/{realm}/authentication/authenticator-providers

Parameters

Type Name Description Required Schema Default

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Map] array

Produces

  • application/json

Tags

  • admin

Get client authenticator providers

Returns a list of client authenticator providers.
GET /admin/realms/{realm}/authentication/client-authenticator-providers

Parameters

Type Name Description Required Schema Default

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Map] array

Produces

  • application/json

Tags

  • admin

Get authenticator provider’s configuration description

GET /admin/realms/{realm}/authentication/config-description/{providerId}

Parameters

Type Name Description Required Schema Default

PathParameter

providerId

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

AuthenticatorConfigInfoRepresentation

Produces

  • application/json

Tags

  • admin

Get authenticator configuration

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

Configuration id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

AuthenticatorConfigRepresentation

Produces

  • application/json

Tags

  • admin

Update authenticator configuration

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

Configuration id

true

string

BodyParameter

rep

JSON describing new state of authenticator configuration

true

AuthenticatorConfigRepresentation

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Delete authenticator configuration

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

Configuration id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

Add new authentication execution

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

Parameters

Type Name Description Required Schema Default

BodyParameter

execution

JSON model describing authentication execution

true

AuthenticationExecutionRepresentation

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Consumes

  • application/json

Tags

  • admin

Delete execution

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

Parameters

Type Name Description Required Schema Default

PathParameter

executionId

Execution id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

Update execution with new configuration

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

Parameters

Type Name Description Required Schema Default

PathParameter

executionId

Execution id

true

string

BodyParameter

json

JSON with new configuration

true

AuthenticatorConfigRepresentation

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Consumes

  • application/json

Tags

  • admin

Lower execution’s priority

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

Parameters

Type Name Description Required Schema Default

PathParameter

executionId

Execution id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

Raise execution’s priority

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

Parameters

Type Name Description Required Schema Default

PathParameter

executionId

Execution id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

Get authentication flows

Returns a list of authentication flows.
GET /admin/realms/{realm}/authentication/flows

Parameters

Type Name Description Required Schema Default

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

AuthenticationFlowRepresentation array

Produces

  • application/json

Tags

  • admin

Create a new authentication flow

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

Parameters

Type Name Description Required Schema Default

BodyParameter

flow

Authentication flow representation

true

AuthenticationFlowRepresentation

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Consumes

  • application/json

Tags

  • admin

Copy existing authentication flow under a new name

The new name is given as 'newName' attribute of the passed JSON object
POST /admin/realms/{realm}/authentication/flows/{flowAlias}/copy

Parameters

Type Name Description Required Schema Default

PathParameter

flowAlias

Name of the existing authentication flow

true

string

BodyParameter

data

JSON containing 'newName' attribute

true

[Map]

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Consumes

  • application/json

Tags

  • admin

Get authentication executions for a flow

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

Parameters

Type Name Description Required Schema Default

PathParameter

flowAlias

Flow alias

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Produces

  • application/json

Tags

  • admin

Update authentication executions of a flow

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

Parameters

Type Name Description Required Schema Default

PathParameter

flowAlias

Flow alias

true

string

BodyParameter

rep

true

AuthenticationExecutionInfoRepresentation

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Add new authentication execution to a flow

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

Parameters

Type Name Description Required Schema Default

PathParameter

flowAlias

Alias of parent flow

true

string

BodyParameter

data

New execution JSON data containing 'provider' attribute

true

[Map]

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Add new flow with new execution to existing flow

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

Parameters

Type Name Description Required Schema Default

PathParameter

flowAlias

Alias of parent authentication flow

true

string

BodyParameter

data

New authentication flow / execution JSON data containing 'alias', 'type', 'provider', and 'description' attributes

true

[Map]

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Consumes

  • application/json

Tags

  • admin

Get authentication flow for id

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

Flow id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

AuthenticationFlowRepresentation

Produces

  • application/json

Tags

  • admin

Delete an authentication flow

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

Flow id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

Get form action providers

Returns a list of form action providers.
GET /admin/realms/{realm}/authentication/form-action-providers

Parameters

Type Name Description Required Schema Default

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Map] array

Produces

  • application/json

Tags

  • admin

Get form providers

Returns a list of form providers.
GET /admin/realms/{realm}/authentication/form-providers

Parameters

Type Name Description Required Schema Default

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Map] array

Produces

  • application/json

Tags

  • admin

Get configuration descriptions for all clients

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

Parameters

Type Name Description Required Schema Default

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Map]

Produces

  • application/json

Tags

  • admin

Register a new required actions

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

Parameters

Type Name Description Required Schema Default

BodyParameter

data

JSON containing 'providerId', and 'name' attributes.

true

[Map]

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Get required actions

Returns a list of required actions.
GET /admin/realms/{realm}/authentication/required-actions

Parameters

Type Name Description Required Schema Default

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RequiredActionProviderRepresentation array

Produces

  • application/json

Tags

  • admin

Get required action for alias

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

Parameters

Type Name Description Required Schema Default

PathParameter

alias

Alias of required action

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RequiredActionProviderRepresentation

Produces

  • application/json

Tags

  • admin

Update required action

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

Parameters

Type Name Description Required Schema Default

PathParameter

alias

Alias of required action

true

string

BodyParameter

rep

JSON describing new state of required action

true

RequiredActionProviderRepresentation

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Delete required action

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

Parameters

Type Name Description Required Schema Default

PathParameter

alias

Alias of required action

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

Get unregistered required actions

Returns a list of unregistered required actions.
GET /admin/realms/{realm}/authentication/unregistered-required-actions

Parameters

Type Name Description Required Schema Default

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Map] array

Produces

  • application/json

Tags

  • admin

Clear cache of external public keys (Public keys of clients or Identity providers)

POST /admin/realms/{realm}/clear-keys-cache

Parameters

Type Name Description Required Schema Default

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

Clear realm cache

POST /admin/realms/{realm}/clear-realm-cache

Parameters

Type Name Description Required Schema Default

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

Clear user cache

POST /admin/realms/{realm}/clear-user-cache

Parameters

Type Name Description Required Schema Default

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

Base path for importing clients under this realm.

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

Parameters

Type Name Description Required Schema Default

BodyParameter

description

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

ClientRepresentation

Consumes

  • application/json

  • application/xml

  • text/plain

Produces

  • application/json

Tags

  • admin

Base path for retrieve providers with the configProperties properly filled

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

Parameters

Type Name Description Required Schema Default

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

ComponentTypeRepresentation array

Produces

  • application/json

Tags

  • admin

Get client session stats

Returns a JSON map.
GET /admin/realms/{realm}/client-session-stats

Description

The key is the client id, the value is the number of sessions that currently are active
with that client. Only clients that actually have a session associated with them will be in this map.

Parameters

Type Name Description Required Schema Default

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Map] array

Produces

  • application/json

Tags

  • admin

Get client templates belonging to the realm

Returns a list of client templates belonging to the realm
GET /admin/realms/{realm}/client-templates

Parameters

Type Name Description Required Schema Default

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

ClientTemplateRepresentation array

Produces

  • application/json

Tags

  • admin

Create a new client template

Client Template's name must be unique!
POST /admin/realms/{realm}/client-templates

Parameters

Type Name Description Required Schema Default

BodyParameter

rep

true

ClientTemplateRepresentation

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Consumes

  • application/json

Tags

  • admin

Get representation of the client template

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

id of client template (not name)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

ClientTemplateRepresentation

Produces

  • application/json

Tags

  • admin

Update the client template

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

Parameters

Type Name Description Required Schema Default

BodyParameter

rep

true

ClientTemplateRepresentation

PathParameter

id

id of client template (not name)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Consumes

  • application/json

Tags

  • admin

Delete the client template

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

id of client template (not name)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Tags

  • admin

Create multiple mappers

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

Parameters

Type Name Description Required Schema Default

BodyParameter

reps

true

ProtocolMapperRepresentation array

PathParameter

id

id of client template (not name)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Get mappers

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

id of client template (not name)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

ProtocolMapperRepresentation array

Produces

  • application/json

Tags

  • admin

Create a mapper

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

Parameters

Type Name Description Required Schema Default

BodyParameter

rep

true

ProtocolMapperRepresentation

PathParameter

id

id of client template (not name)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Consumes

  • application/json

Tags

  • admin

Get mapper by id

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

Mapper id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

ProtocolMapperRepresentation

Produces

  • application/json

Tags

  • admin

Update the mapper

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

Mapper id

true

string

BodyParameter

rep

true

ProtocolMapperRepresentation

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Delete the mapper

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

Mapper id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

Get mappers by name for a specific protocol

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

Parameters

Type Name Description Required Schema Default

PathParameter

protocol

true

string

PathParameter

id

id of client template (not name)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

ProtocolMapperRepresentation array

Produces

  • application/json

Tags

  • admin

Get all scope mappings for the client

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

id of client template (not name)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

MappingsRepresentation

Produces

  • application/json

Tags

  • admin

Get the roles associated with a client’s scope

Returns roles for the client.
GET /admin/realms/{realm}/client-templates/{id}/scope-mappings/clients/{client}

Parameters

Type Name Description Required Schema Default

PathParameter

client

true

string

PathParameter

id

id of client template (not name)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Remove client-level roles from the client’s scope.

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

Parameters

Type Name Description Required Schema Default

BodyParameter

roles

true

RoleRepresentation array

PathParameter

client

true

string

PathParameter

id

id of client template (not name)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Add client-level roles to the client’s scope

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

Parameters

Type Name Description Required Schema Default

BodyParameter

roles

true

RoleRepresentation array

PathParameter

client

true

string

PathParameter

id

id of client template (not name)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

The available client-level roles

Returns the roles for the client that can be associated with the client's scope
GET /admin/realms/{realm}/client-templates/{id}/scope-mappings/clients/{client}/available

Parameters

Type Name Description Required Schema Default

PathParameter

client

true

string

PathParameter

id

id of client template (not name)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Get effective client roles

Returns the roles for the client that are associated with the client's scope.
GET /admin/realms/{realm}/client-templates/{id}/scope-mappings/clients/{client}/composite

Parameters

Type Name Description Required Schema Default

PathParameter

client

true

string

PathParameter

id

id of client template (not name)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Get realm-level roles associated with the client’s scope

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

id of client template (not name)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Remove a set of realm-level roles from the client’s scope

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

Parameters

Type Name Description Required Schema Default

BodyParameter

roles

true

RoleRepresentation array

PathParameter

id

id of client template (not name)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Add a set of realm-level roles to the client’s scope

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

Parameters

Type Name Description Required Schema Default

BodyParameter

roles

true

RoleRepresentation array

PathParameter

id

id of client template (not name)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Get realm-level roles that are available to attach to this client’s scope

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

id of client template (not name)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Get effective realm-level roles associated with the client’s scope

What this does is recurse
any composite roles associated with the client's scope and adds the roles to this lists.
GET /admin/realms/{realm}/client-templates/{id}/scope-mappings/realm/composite

Description

The method is really
to show a comprehensive total view of realm-level roles associated with the client.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id of client template (not name)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Get clients belonging to the realm

Returns a list of clients belonging to the realm
GET /admin/realms/{realm}/clients

Parameters

Type Name Description Required Schema Default

QueryParameter

clientId

filter by clientId

false

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

ClientRepresentation array

Produces

  • application/json

Tags

  • admin

Create a new client

Client's client_id must be unique!
POST /admin/realms/{realm}/clients

Parameters

Type Name Description Required Schema Default

BodyParameter

rep

true

ClientRepresentation

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Consumes

  • application/json

Tags

  • admin

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

Parameters

Type Name Description Required Schema Default

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

ClientInitialAccessPresentation array

Produces

  • application/json

Tags

  • admin

Create a new initial access token.

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

Parameters

Type Name Description Required Schema Default

BodyParameter

config

true

ClientInitialAccessCreatePresentation

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

ClientInitialAccessPresentation

Consumes

  • application/json

Produces

  • application/json

Tags

  • admin

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

Get representation of the client

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

ClientRepresentation

Produces

  • application/json

Tags

  • admin

Update the client

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

Parameters

Type Name Description Required Schema Default

BodyParameter

rep

true

ClientRepresentation

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Consumes

  • application/json

Tags

  • admin

Delete the client

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

Get key info

GET /admin/realms/{realm}/clients/{id}/certificates/{attr}

Parameters

Type Name Description Required Schema Default

PathParameter

attr

true

string

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

CertificateRepresentation

Produces

  • application/json

Tags

  • admin

Get a keystore file for the client, containing private key and public certificate

POST /admin/realms/{realm}/clients/{id}/certificates/{attr}/download

Parameters

Type Name Description Required Schema Default

BodyParameter

config

Keystore configuration as JSON

true

KeyStoreConfig

PathParameter

attr

true

string

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string array

Consumes

  • application/json

Produces

  • application/octet-stream

Tags

  • admin

Generate a new certificate with new key pair

POST /admin/realms/{realm}/clients/{id}/certificates/{attr}/generate

Parameters

Type Name Description Required Schema Default

PathParameter

attr

true

string

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

CertificateRepresentation

Produces

  • application/json

Tags

  • admin

Generate a new keypair and certificate, and get the private key file

Generates a keypair and certificate and serves the private key in a specified keystore format.
POST /admin/realms/{realm}/clients/{id}/certificates/{attr}/generate-and-download

Description

Only generated public certificate is saved in Keycloak DB - the private key is not.

Parameters

Type Name Description Required Schema Default

BodyParameter

config

Keystore configuration as JSON

true

KeyStoreConfig

PathParameter

attr

true

string

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string array

Consumes

  • application/json

Produces

  • application/octet-stream

Tags

  • admin

Upload certificate and eventually private key

POST /admin/realms/{realm}/clients/{id}/certificates/{attr}/upload

Parameters

Type Name Description Required Schema Default

FormDataParameter

input

true

file

PathParameter

attr

true

string

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

CertificateRepresentation

Consumes

  • multipart/form-data

Produces

  • application/json

Tags

  • admin

Upload only certificate, not private key

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

Parameters

Type Name Description Required Schema Default

FormDataParameter

input

true

file

PathParameter

attr

true

string

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

CertificateRepresentation

Consumes

  • multipart/form-data

Produces

  • application/json

Tags

  • admin

Get the client secret

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

CredentialRepresentation

Produces

  • application/json

Tags

  • admin

Generate a new secret for the client

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

CredentialRepresentation

Consumes

  • application/json

Produces

  • application/json

Tags

  • admin

GET /admin/realms/{realm}/clients/{id}/installation/providers/{providerId}

Parameters

Type Name Description Required Schema Default

PathParameter

providerId

true

string

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Tags

  • admin

Register a cluster node with the client

Manually register cluster node to this client - usually it's not needed to call this directly as adapter should handle
by sending registration request to Keycloak
POST /admin/realms/{realm}/clients/{id}/nodes

Parameters

Type Name Description Required Schema Default

BodyParameter

formParams

true

[Map]

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Unregister a cluster node from the client

DELETE /admin/realms/{realm}/clients/{id}/nodes/{node}

Parameters

Type Name Description Required Schema Default

PathParameter

node

true

string

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

Get application offline session count

Returns a number of offline user sessions associated with this client
{
    "count": number
}
GET /admin/realms/{realm}/clients/{id}/offline-session-count

Parameters

Type Name Description Required Schema Default

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Map]

Produces

  • application/json

Tags

  • admin

Get offline sessions for client

Returns a list of offline user sessions associated with this client
GET /admin/realms/{realm}/clients/{id}/offline-sessions

Parameters

Type Name Description Required Schema Default

QueryParameter

first

Paging offset

false

integer (int32)

QueryParameter

max

Maximum results size (defaults to 100)

false

integer (int32)

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

UserSessionRepresentation array

Produces

  • application/json

Tags

  • admin

Create multiple mappers

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

Parameters

Type Name Description Required Schema Default

BodyParameter

reps

true

ProtocolMapperRepresentation array

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Get mappers

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

ProtocolMapperRepresentation array

Produces

  • application/json

Tags

  • admin

Create a mapper

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

Parameters

Type Name Description Required Schema Default

BodyParameter

rep

true

ProtocolMapperRepresentation

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Consumes

  • application/json

Tags

  • admin

Get mapper by id

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

Mapper id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

ProtocolMapperRepresentation

Produces

  • application/json

Tags

  • admin

Update the mapper

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

Mapper id

true

string

BodyParameter

rep

true

ProtocolMapperRepresentation

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Delete the mapper

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

Mapper id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

Get mappers by name for a specific protocol

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

Parameters

Type Name Description Required Schema Default

PathParameter

protocol

true

string

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

ProtocolMapperRepresentation array

Produces

  • application/json

Tags

  • admin

Push the client’s revocation policy to its admin URL

If the client has an admin URL, push revocation policy to it.
POST /admin/realms/{realm}/clients/{id}/push-revocation

Parameters

Type Name Description Required Schema Default

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

GlobalRequestResult

Produces

  • application/json

Tags

  • admin

Generate a new registration access token for the client

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

ClientRepresentation

Consumes

  • application/json

Produces

  • application/json

Tags

  • admin

Get all roles for the realm or client

GET /admin/realms/{realm}/clients/{id}/roles

Parameters

Type Name Description Required Schema Default

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Create a new role for the realm or client

POST /admin/realms/{realm}/clients/{id}/roles

Parameters

Type Name Description Required Schema Default

BodyParameter

rep

true

RoleRepresentation

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Consumes

  • application/json

Tags

  • admin

Get a role by name

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

Parameters

Type Name Description Required Schema Default

PathParameter

role-name

role’s name (not id!)

true

string

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation

Produces

  • application/json

Tags

  • admin

Update a role by name

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

Parameters

Type Name Description Required Schema Default

PathParameter

role-name

role’s name (not id!)

true

string

BodyParameter

rep

true

RoleRepresentation

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Consumes

  • application/json

Tags

  • admin

Delete a role by name

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

Parameters

Type Name Description Required Schema Default

PathParameter

role-name

role’s name (not id!)

true

string

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

Get composites of the role

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

Parameters

Type Name Description Required Schema Default

PathParameter

role-name

role’s name (not id!)

true

string

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Remove roles from the role’s composite

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

Parameters

Type Name Description Required Schema Default

PathParameter

role-name

role’s name (not id!)

true

string

BodyParameter

roles

roles to remove

true

RoleRepresentation array

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Add a composite to the role

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

Parameters

Type Name Description Required Schema Default

PathParameter

role-name

role’s name (not id!)

true

string

BodyParameter

roles

true

RoleRepresentation array

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

An app-level roles for the specified app for the role’s composite

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

Parameters

Type Name Description Required Schema Default

PathParameter

role-name

role’s name (not id!)

true

string

PathParameter

client

true

string

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Get realm-level roles of the role’s composite

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

Parameters

Type Name Description Required Schema Default

PathParameter

role-name

role’s name (not id!)

true

string

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Get all scope mappings for the client

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

MappingsRepresentation

Produces

  • application/json

Tags

  • admin

Get the roles associated with a client’s scope

Returns roles for the client.
GET /admin/realms/{realm}/clients/{id}/scope-mappings/clients/{client}

Parameters

Type Name Description Required Schema Default

PathParameter

client

true

string

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Remove client-level roles from the client’s scope.

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

Parameters

Type Name Description Required Schema Default

BodyParameter

roles

true

RoleRepresentation array

PathParameter

client

true

string

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Add client-level roles to the client’s scope

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

Parameters

Type Name Description Required Schema Default

BodyParameter

roles

true

RoleRepresentation array

PathParameter

client

true

string

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

The available client-level roles

Returns the roles for the client that can be associated with the client's scope
GET /admin/realms/{realm}/clients/{id}/scope-mappings/clients/{client}/available

Parameters

Type Name Description Required Schema Default

PathParameter

client

true

string

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Get effective client roles

Returns the roles for the client that are associated with the client's scope.
GET /admin/realms/{realm}/clients/{id}/scope-mappings/clients/{client}/composite

Parameters

Type Name Description Required Schema Default

PathParameter

client

true

string

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Get realm-level roles associated with the client’s scope

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Remove a set of realm-level roles from the client’s scope

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

Parameters

Type Name Description Required Schema Default

BodyParameter

roles

true

RoleRepresentation array

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Add a set of realm-level roles to the client’s scope

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

Parameters

Type Name Description Required Schema Default

BodyParameter

roles

true

RoleRepresentation array

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Get realm-level roles that are available to attach to this client’s scope

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Get effective realm-level roles associated with the client’s scope

What this does is recurse
any composite roles associated with the client's scope and adds the roles to this lists.
GET /admin/realms/{realm}/clients/{id}/scope-mappings/realm/composite

Description

The method is really
to show a comprehensive total view of realm-level roles associated with the client.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Get a user dedicated to the service account

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

UserRepresentation

Produces

  • application/json

Tags

  • admin

Get application session count

Returns a number of user sessions associated with this client
{
    "count": number
}
GET /admin/realms/{realm}/clients/{id}/session-count

Parameters

Type Name Description Required Schema Default

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Map]

Produces

  • application/json

Tags

  • admin

Test if registered cluster nodes are available

Tests availability by sending 'ping' request to all cluster nodes.
GET /admin/realms/{realm}/clients/{id}/test-nodes-available

Parameters

Type Name Description Required Schema Default

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

GlobalRequestResult

Produces

  • application/json

Tags

  • admin

Get user sessions for client

Returns a list of user sessions associated with this client
GET /admin/realms/{realm}/clients/{id}/user-sessions

Parameters

Type Name Description Required Schema Default

QueryParameter

first

Paging offset

false

integer (int32)

QueryParameter

max

Maximum results size (defaults to 100)

false

integer (int32)

PathParameter

id

id of client (not client-id)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

UserSessionRepresentation array

Produces

  • application/json

Tags

  • admin

GET /admin/realms/{realm}/components

Parameters

Type Name Description Required Schema Default

QueryParameter

parent

false

string

QueryParameter

type

false

string

QueryParameter

name

false

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

ComponentRepresentation array

Produces

  • application/json

Tags

  • admin

POST /admin/realms/{realm}/components

Parameters

Type Name Description Required Schema Default

BodyParameter

rep

true

ComponentRepresentation

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Consumes

  • application/json

Tags

  • admin

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

ComponentRepresentation

Produces

  • application/json

Tags

  • admin

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

true

string

BodyParameter

rep

true

ComponentRepresentation

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Consumes

  • application/json

Tags

  • admin

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

List of subcomponent types that are available to configure for a particular parent component.

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

true

string

QueryParameter

type

false

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

ComponentTypeRepresentation array

Produces

  • application/json

Tags

  • admin

Get group hierarchy.

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

Description

Only name and ids are returned.

Parameters

Type Name Description Required Schema Default

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

GroupRepresentation array

Produces

  • application/json

Tags

  • admin

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

Parameters

Type Name Description Required Schema Default

PathParameter

groupId

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

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

Parameters

Type Name Description Required Schema Default

PathParameter

groupId

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

Get events

Returns all events, or filters them based on URL query parameters listed here
GET /admin/realms/{realm}/events

Parameters

Type Name Description Required Schema Default

QueryParameter

type

The types of events to return

false

csv string array

QueryParameter

client

App or oauth client name

false

string

QueryParameter

user

User id

false

string

QueryParameter

dateFrom

From date

false

string

QueryParameter

dateTo

To date

false

string

QueryParameter

ipAddress

IP address

false

string

QueryParameter

first

Paging offset

false

integer (int32)

QueryParameter

max

Maximum results size (defaults to 100)

false

integer (int32)

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

EventRepresentation array

Produces

  • application/json

Tags

  • admin

Delete all events

DELETE /admin/realms/{realm}/events

Parameters

Type Name Description Required Schema Default

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

Get the events provider configuration

Returns JSON object with events provider configuration
GET /admin/realms/{realm}/events/config

Parameters

Type Name Description Required Schema Default

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RealmEventsConfigRepresentation

Produces

  • application/json

Tags

  • admin

Update the events provider

Change the events provider and/or its configuration
PUT /admin/realms/{realm}/events/config

Parameters

Type Name Description Required Schema Default

BodyParameter

rep

true

RealmEventsConfigRepresentation

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

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

Parameters

Type Name Description Required Schema Default

PathParameter

path

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

GroupRepresentation

Produces

  • application/json

Tags

  • admin

Get group hierarchy.

GET /admin/realms/{realm}/groups

Description

Only name and ids are returned.

Parameters

Type Name Description Required Schema Default

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

GroupRepresentation array

Produces

  • application/json

Tags

  • admin

create or add a top level realm groupSet or create child.

POST /admin/realms/{realm}/groups

Description

This will update the group and set the parent if it exists. Create it and set the parent
if the group doesn’t exist.

Parameters

Type Name Description Required Schema Default

BodyParameter

rep

true

GroupRepresentation

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Consumes

  • application/json

Tags

  • admin

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

GroupRepresentation

Produces

  • application/json

Tags

  • admin

Update group, ignores subgroups.

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

Parameters

Type Name Description Required Schema Default

BodyParameter

rep

true

GroupRepresentation

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

Set or create child.

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

Description

This will just set the parent if it exists. Create it and set the parent
if the group doesn’t exist.

Parameters

Type Name Description Required Schema Default

BodyParameter

rep

true

GroupRepresentation

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Consumes

  • application/json

Produces

  • application/json

Tags

  • admin

Get users

Returns a list of users, filtered according to query parameters
GET /admin/realms/{realm}/groups/{id}/members

Parameters

Type Name Description Required Schema Default

QueryParameter

first

Pagination offset

false

integer (int32)

QueryParameter

max

Maximum results size (defaults to 100)

false

integer (int32)

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

UserRepresentation array

Produces

  • application/json

Tags

  • admin

Get role mappings

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

MappingsRepresentation

Produces

  • application/json

Tags

  • admin

Get client-level role mappings for the user, and the app

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

Parameters

Type Name Description Required Schema Default

PathParameter

client

true

string

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Delete client-level roles from user role mapping

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

Parameters

Type Name Description Required Schema Default

BodyParameter

roles

true

RoleRepresentation array

PathParameter

client

true

string

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Add client-level roles to the user role mapping

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

Parameters

Type Name Description Required Schema Default

BodyParameter

roles

true

RoleRepresentation array

PathParameter

client

true

string

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Get available client-level roles that can be mapped to the user

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

Parameters

Type Name Description Required Schema Default

PathParameter

client

true

string

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Get effective client-level role mappings

This recurses any composite roles
GET /admin/realms/{realm}/groups/{id}/role-mappings/clients/{client}/composite

Parameters

Type Name Description Required Schema Default

PathParameter

client

true

string

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Get realm-level role mappings

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Delete realm-level role mappings

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

Parameters

Type Name Description Required Schema Default

BodyParameter

roles

true

RoleRepresentation array

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Add realm-level role mappings to the user

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

Parameters

Type Name Description Required Schema Default

BodyParameter

roles

Roles to add

true

RoleRepresentation array

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Get realm-level roles that can be mapped

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Get effective realm-level role mappings

This will recurse all composite roles to get the result.
GET /admin/realms/{realm}/groups/{id}/role-mappings/realm/composite

Parameters

Type Name Description Required Schema Default

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Import identity provider from uploaded JSON file

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

Parameters

Type Name Description Required Schema Default

FormDataParameter

input

true

file

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Map]

Consumes

  • multipart/form-data

Produces

  • application/json

Tags

  • admin

Get identity providers

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

Parameters

Type Name Description Required Schema Default

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

IdentityProviderRepresentation array

Produces

  • application/json

Tags

  • admin

Create a new identity provider

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

Parameters

Type Name Description Required Schema Default

BodyParameter

representation

JSON body

true

IdentityProviderRepresentation

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Consumes

  • application/json

Tags

  • admin

Get the identity provider

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

Parameters

Type Name Description Required Schema Default

PathParameter

alias

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

IdentityProviderRepresentation

Produces

  • application/json

Tags

  • admin

Update the identity provider

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

Parameters

Type Name Description Required Schema Default

BodyParameter

providerRep

true

IdentityProviderRepresentation

PathParameter

alias

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Consumes

  • application/json

Tags

  • admin

Delete the identity provider

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

Parameters

Type Name Description Required Schema Default

PathParameter

alias

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Tags

  • admin

Export public broker configuration for identity provider

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

Parameters

Type Name Description Required Schema Default

QueryParameter

format

Format to use

false

string

PathParameter

alias

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Tags

  • admin

Get mapper types for identity provider

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

Parameters

Type Name Description Required Schema Default

PathParameter

alias

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Map]

Tags

  • admin

Get mappers for identity provider

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

Parameters

Type Name Description Required Schema Default

PathParameter

alias

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

IdentityProviderMapperRepresentation array

Produces

  • application/json

Tags

  • admin

Add a mapper to identity provider

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

Parameters

Type Name Description Required Schema Default

BodyParameter

mapper

true

IdentityProviderMapperRepresentation

PathParameter

alias

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Consumes

  • application/json

Tags

  • admin

Get mapper by id for the identity provider

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

true

string

PathParameter

alias

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

IdentityProviderMapperRepresentation

Produces

  • application/json

Tags

  • admin

Update a mapper for the identity provider

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

Mapper id

true

string

BodyParameter

rep

true

IdentityProviderMapperRepresentation

PathParameter

alias

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Delete a mapper for the identity provider

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

Mapper id

true

string

PathParameter

alias

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

Get identity providers

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

Parameters

Type Name Description Required Schema Default

PathParameter

provider_id

Provider id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Produces

  • application/json

Tags

  • admin

GET /admin/realms/{realm}/keys

Parameters

Type Name Description Required Schema Default

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

KeysMetadataRepresentation

Produces

  • application/json

Tags

  • admin

Removes all user sessions.

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

Description

Any client that has an admin url will also be told to invalidate any sessions
they have.

Parameters

Type Name Description Required Schema Default

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

GlobalRequestResult

Tags

  • admin

Partial import from a JSON file to an existing realm.

POST /admin/realms/{realm}/partialImport

Parameters

Type Name Description Required Schema Default

BodyParameter

rep

true

PartialImportRepresentation

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Consumes

  • application/json

Tags

  • admin

Push the realm’s revocation policy to any client that has an admin url associated with it.

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

Parameters

Type Name Description Required Schema Default

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

GlobalRequestResult

Tags

  • admin

Get all roles for the realm or client

GET /admin/realms/{realm}/roles

Parameters

Type Name Description Required Schema Default

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Create a new role for the realm or client

POST /admin/realms/{realm}/roles

Parameters

Type Name Description Required Schema Default

BodyParameter

rep

true

RoleRepresentation

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Consumes

  • application/json

Tags

  • admin

Get a specific role’s representation

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

Parameters

Type Name Description Required Schema Default

PathParameter

role-id

id of role

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation

Produces

  • application/json

Tags

  • admin

Update the role

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

Parameters

Type Name Description Required Schema Default

PathParameter

role-id

id of role

true

string

BodyParameter

rep

true

RoleRepresentation

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Delete the role

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

Parameters

Type Name Description Required Schema Default

PathParameter

role-id

id of role

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

Get role’s children

Returns a set of role's children provided the role is a composite.
GET /admin/realms/{realm}/roles-by-id/{role-id}/composites

Parameters

Type Name Description Required Schema Default

PathParameter

role-id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Remove a set of roles from the role’s composite

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

Parameters

Type Name Description Required Schema Default

PathParameter

role-id

Role id

true

string

BodyParameter

roles

A set of roles to be removed

true

RoleRepresentation array

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Make the role a composite role by associating some child roles

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

Parameters

Type Name Description Required Schema Default

PathParameter

role-id

true

string

BodyParameter

roles

true

RoleRepresentation array

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Get client-level roles for the client that are in the role’s composite

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

Parameters

Type Name Description Required Schema Default

PathParameter

role-id

true

string

PathParameter

client

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Get realm-level roles that are in the role’s composite

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

Parameters

Type Name Description Required Schema Default

PathParameter

role-id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Get a role by name

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

Parameters

Type Name Description Required Schema Default

PathParameter

role-name

role’s name (not id!)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation

Produces

  • application/json

Tags

  • admin

Update a role by name

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

Parameters

Type Name Description Required Schema Default

PathParameter

role-name

role’s name (not id!)

true

string

BodyParameter

rep

true

RoleRepresentation

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Consumes

  • application/json

Tags

  • admin

Delete a role by name

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

Parameters

Type Name Description Required Schema Default

PathParameter

role-name

role’s name (not id!)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

Get composites of the role

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

Parameters

Type Name Description Required Schema Default

PathParameter

role-name

role’s name (not id!)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Remove roles from the role’s composite

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

Parameters

Type Name Description Required Schema Default

PathParameter

role-name

role’s name (not id!)

true

string

BodyParameter

roles

roles to remove

true

RoleRepresentation array

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Add a composite to the role

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

Parameters

Type Name Description Required Schema Default

PathParameter

role-name

role’s name (not id!)

true

string

BodyParameter

roles

true

RoleRepresentation array

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

An app-level roles for the specified app for the role’s composite

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

Parameters

Type Name Description Required Schema Default

PathParameter

role-name

role’s name (not id!)

true

string

PathParameter

client

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Get realm-level roles of the role’s composite

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

Parameters

Type Name Description Required Schema Default

PathParameter

role-name

role’s name (not id!)

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Remove a specific user session.

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

Description

Any client that has an admin url will also be told to invalidate this
particular session.

Parameters

Type Name Description Required Schema Default

PathParameter

session

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

Test LDAP connection

GET /admin/realms/{realm}/testLDAPConnection

Parameters

Type Name Description Required Schema Default

QueryParameter

action

false

string

QueryParameter

connectionUrl

false

string

QueryParameter

bindDn

false

string

QueryParameter

bindCredential

false

string

QueryParameter

useTruststoreSpi

false

string

QueryParameter

connectionTimeout

false

string

QueryParameter

componentId

false

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Tags

  • admin

Trigger sync of users

Action can be "triggerFullSync" or "triggerChangedUsersSync"
POST /admin/realms/{realm}/user-storage/{id}/sync

Parameters

Type Name Description Required Schema Default

PathParameter

id

true

string

QueryParameter

action

false

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

SynchronizationResult

Produces

  • application/json

Tags

  • admin

direction is "fedToKeycloak" or "keycloakToFed"
POST /admin/realms/{realm}/user-storage/{parentId}/mappers/{id}/sync

Parameters

Type Name Description Required Schema Default

PathParameter

parentId

true

string

PathParameter

id

true

string

QueryParameter

direction

false

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

SynchronizationResult

Produces

  • application/json

Tags

  • admin

Get users

Returns a list of users, filtered according to query parameters
GET /admin/realms/{realm}/users

Parameters

Type Name Description Required Schema Default

QueryParameter

search

A String contained in username, first or last name, or email

false

string

QueryParameter

lastName

false

string

QueryParameter

firstName

false

string

QueryParameter

email

false

string

QueryParameter

username

false

string

QueryParameter

first

false

integer (int32)

QueryParameter

max

Maximum results size (defaults to 100)

false

integer (int32)

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

UserRepresentation array

Produces

  • application/json

Tags

  • admin

Create a new user

Username must be unique.
POST /admin/realms/{realm}/users

Parameters

Type Name Description Required Schema Default

BodyParameter

rep

true

UserRepresentation

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Consumes

  • application/json

Tags

  • admin

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

Parameters

Type Name Description Required Schema Default

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

integer (int32)

Produces

  • application/json

Tags

  • admin

Get representation of the user

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

User id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

UserRepresentation

Produces

  • application/json

Tags

  • admin

Update the user

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

User id

true

string

BodyParameter

rep

true

UserRepresentation

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Consumes

  • application/json

Tags

  • admin

Delete the user

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

User id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Tags

  • admin

Get consents granted by the user

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

User id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Map] array

Produces

  • application/json

Tags

  • admin

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

User id

true

string

PathParameter

client

Client id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

Disable all credentials for a user of a specific type

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

true

string

BodyParameter

credentialTypes

true

string array

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Send a update account email to the user

An email contains a link the user can click to perform a set of required actions.
PUT /admin/realms/{realm}/users/{id}/execute-actions-email

Description

The redirectUri and clientId parameters are optional. If no redirect is given, then there will
be no link back to click after actions have completed. Redirect uri must be a valid uri for the
particular clientId.

Parameters

Type Name Description Required Schema Default

PathParameter

id

User is

true

string

QueryParameter

redirect_uri

Redirect uri

false

string

QueryParameter

client_id

Client id

false

string

BodyParameter

actions

required actions the user needs to complete

true

string array

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Consumes

  • application/json

Tags

  • admin

Get social logins associated with the user

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

User id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

FederatedIdentityRepresentation array

Produces

  • application/json

Tags

  • admin

Remove a social login provider from user

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

User id

true

string

PathParameter

provider

Social login provider id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

Add a social login provider to the user

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

User id

true

string

PathParameter

provider

Social login provider id

true

string

BodyParameter

rep

true

FederatedIdentityRepresentation

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Tags

  • admin

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

GroupRepresentation array

Produces

  • application/json

Tags

  • admin

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

true

string

PathParameter

groupId

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

true

string

PathParameter

groupId

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

Impersonate the user

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

User id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Map]

Produces

  • application/json

Tags

  • admin

Remove all user sessions associated with the user

Also send notification to all clients that have an admin URL to invalidate the sessions for the particular user.
POST /admin/realms/{realm}/users/{id}/logout

Parameters

Type Name Description Required Schema Default

PathParameter

id

User id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Tags

  • admin

Get offline sessions associated with the user and client

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

User id

true

string

PathParameter

clientId

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

UserSessionRepresentation array

Produces

  • application/json

Tags

  • admin

Remove TOTP from the user

PUT /admin/realms/{realm}/users/{id}/remove-totp

Parameters

Type Name Description Required Schema Default

PathParameter

id

User id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Set up a temporary password for the user

User will have to reset the temporary password next time they log in.
PUT /admin/realms/{realm}/users/{id}/reset-password

Parameters

Type Name Description Required Schema Default

PathParameter

id

User id

true

string

BodyParameter

pass

A Temporary password

true

CredentialRepresentation

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Get role mappings

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

MappingsRepresentation

Produces

  • application/json

Tags

  • admin

Get client-level role mappings for the user, and the app

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

Parameters

Type Name Description Required Schema Default

PathParameter

client

true

string

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Delete client-level roles from user role mapping

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

Parameters

Type Name Description Required Schema Default

BodyParameter

roles

true

RoleRepresentation array

PathParameter

client

true

string

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Add client-level roles to the user role mapping

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

Parameters

Type Name Description Required Schema Default

BodyParameter

roles

true

RoleRepresentation array

PathParameter

client

true

string

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Get available client-level roles that can be mapped to the user

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

Parameters

Type Name Description Required Schema Default

PathParameter

client

true

string

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Get effective client-level role mappings

This recurses any composite roles
GET /admin/realms/{realm}/users/{id}/role-mappings/clients/{client}/composite

Parameters

Type Name Description Required Schema Default

PathParameter

client

true

string

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Get realm-level role mappings

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Delete realm-level role mappings

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

Parameters

Type Name Description Required Schema Default

BodyParameter

roles

true

RoleRepresentation array

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Add realm-level role mappings to the user

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

Parameters

Type Name Description Required Schema Default

BodyParameter

roles

Roles to add

true

RoleRepresentation array

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

string

Consumes

  • application/json

Tags

  • admin

Get realm-level roles that can be mapped

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Get effective realm-level role mappings

This will recurse all composite roles to get the result.
GET /admin/realms/{realm}/users/{id}/role-mappings/realm/composite

Parameters

Type Name Description Required Schema Default

PathParameter

id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

RoleRepresentation array

Produces

  • application/json

Tags

  • admin

Send an email-verification email to the user

An email contains a link the user can click to verify their email address.
PUT /admin/realms/{realm}/users/{id}/send-verify-email

Description

The redirectUri and clientId parameters are optional. The default for the
redirect is the account client.

Parameters

Type Name Description Required Schema Default

PathParameter

id

User id

true

string

QueryParameter

redirect_uri

Redirect uri

false

string

QueryParameter

client_id

Client id

false

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

[Response]

Consumes

  • application/json

Tags

  • admin

Get sessions associated with the user

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

Parameters

Type Name Description Required Schema Default

PathParameter

id

User id

true

string

PathParameter

realm

realm name (not id!)

true

string

Responses

HTTP Code Description Schema

default

success

UserSessionRepresentation array

Produces

  • application/json

Tags

  • admin

Get themes, social providers, auth providers, and event listeners available on this server

GET /admin/serverinfo

Responses

HTTP Code Description Schema

default

success

ServerInfoRepresentation

Produces

  • application/json

Tags

  • admin

Definitions

RealmEventsConfigRepresentation

Name Description Required Schema Default

eventsEnabled

false

boolean

eventsExpiration

false

integer (int64)

eventsListeners

false

string array

enabledEventTypes

false

string array

adminEventsEnabled

false

boolean

adminEventsDetailsEnabled

false

boolean

KeysMetadataRepresentation

Name Description Required Schema Default

active

false

[Map]

keys

false

KeysMetadataRepresentation-KeyMetadataRepresentation array

IdentityProviderMapperRepresentation

Name Description Required Schema Default

id

false

string

name

false

string

identityProviderAlias

false

string

identityProviderMapper

false

string

config

false

[Map]

UserSessionRepresentation

Name Description Required Schema Default

id

false

string

username

false

string

userId

false

string

ipAddress

false

string

start

false

integer (int64)

lastAccess

false

integer (int64)

clients

false

[Map]

ScopeMappingRepresentation

Name Description Required Schema Default

self

false

string

client

false

string

clientTemplate

false

string

roles

false

string array

AuthenticationExecutionRepresentation

Name Description Required Schema Default

authenticatorConfig

false

string

authenticator

false

string

authenticatorFlow

false

boolean

requirement

false

string

priority

false

integer (int32)

autheticatorFlow

false

boolean

id

false

string

flowId

false

string

parentFlow

false

string

AuthDetailsRepresentation

Name Description Required Schema Default

realmId

false

string

clientId

false

string

userId

false

string

ipAddress

false

string

MultivaluedHashMap

Name Description Required Schema Default

empty

false

boolean

threshold

false

integer (int32)

loadFactor

false

number (float)

PartialImportRepresentation

Name Description Required Schema Default

policy

false

enum (SKIP, OVERWRITE, FAIL)

ifResourceExists

false

string

users

false

UserRepresentation array

groups

false

GroupRepresentation array

clients

false

ClientRepresentation array

identityProviders

false

IdentityProviderRepresentation array

roles

false

RolesRepresentation

UserFederationProviderRepresentation

Name Description Required Schema Default

id

false

string

displayName

false

string

providerName

false

string

config

false

[Map]

priority

false

integer (int32)

fullSyncPeriod

false

integer (int32)

changedSyncPeriod

false

integer (int32)

lastSync

false

integer (int32)

SystemInfoRepresentation

Name Description Required Schema Default

version

false

string

serverTime

false

string

uptime

false

string

uptimeMillis

false

integer (int64)

javaVersion

false

string

javaVendor

false

string

javaVm

false

string

javaVmVersion

false

string

javaRuntime

false

string

javaHome

false

string

osName

false

string

osArchitecture

false

string

osVersion

false

string

fileEncoding

false

string

userName

false

string

userDir

false

string

userTimezone

false

string

userLocale

false

string

PasswordPolicyTypeRepresentation

Name Description Required Schema Default

id

false

string

displayName

false

string

configType

false

string

defaultValue

false

string

multipleSupported

false

boolean

KeysMetadataRepresentation-KeyMetadataRepresentation

Name Description Required Schema Default

providerId

false

string

providerPriority

false

integer (int64)

kid

false

string

status

false

string

type

false

string

publicKey

false

string

certificate

false

string

ProtocolMapperRepresentation

Name Description Required Schema Default

id

false

string

name

false

string

protocol

false

string

protocolMapper

false

string

consentRequired

false

boolean

consentText

false

string

config

false

[Map]

IdentityProviderRepresentation

Name Description Required Schema Default

alias

false

string

displayName

false

string

internalId

false

string

providerId

false

string

enabled

false

boolean

trustEmail

false

boolean

storeToken

false

boolean

addReadTokenRoleOnCreate

false

boolean

firstBrokerLoginFlowAlias

false

string

postBrokerLoginFlowAlias

false

string

config

false

[Map]

MemoryInfoRepresentation

Name Description Required Schema Default

total

false

integer (int64)

totalFormated

false

string

used

false

integer (int64)

usedFormated

false

string

free

false

integer (int64)

freePercentage

false

integer (int64)

freeFormated

false

string

SpiInfoRepresentation

Name Description Required Schema Default

internal

false

boolean

providers

false

[Map]

RealmRepresentation

Name Description Required Schema Default

id

false

string

realm

false

string

displayName

false

string

displayNameHtml

false

string

notBefore

false

integer (int32)

revokeRefreshToken

false

boolean

accessTokenLifespan

false

integer (int32)

accessTokenLifespanForImplicitFlow

false

integer (int32)

ssoSessionIdleTimeout

false

integer (int32)

ssoSessionMaxLifespan

false

integer (int32)

offlineSessionIdleTimeout

false

integer (int32)

accessCodeLifespan

false

integer (int32)

accessCodeLifespanUserAction

false

integer (int32)

accessCodeLifespanLogin

false

integer (int32)

enabled

false

boolean

sslRequired

false

string

registrationAllowed

false

boolean

registrationEmailAsUsername

false

boolean

rememberMe

false

boolean

verifyEmail

false

boolean

loginWithEmailAllowed

false

boolean

duplicateEmailsAllowed

false

boolean

resetPasswordAllowed

false

boolean

editUsernameAllowed

false

boolean

bruteForceProtected

false

boolean

maxFailureWaitSeconds

false

integer (int32)

minimumQuickLoginWaitSeconds

false

integer (int32)

waitIncrementSeconds

false

integer (int32)

quickLoginCheckMilliSeconds

false

integer (int64)

maxDeltaTimeSeconds

false

integer (int32)

failureFactor

false

integer (int32)

roles

false

RolesRepresentation

groups

false

GroupRepresentation array

defaultRoles

false

string array

defaultGroups

false

string array

passwordPolicy

false

string

otpPolicyType

false

string

otpPolicyAlgorithm

false

string

otpPolicyInitialCounter

false

integer (int32)

otpPolicyDigits

false

integer (int32)

otpPolicyLookAheadWindow

false

integer (int32)

otpPolicyPeriod

false

integer (int32)

users

false

UserRepresentation array

federatedUsers

false

UserRepresentation array

scopeMappings

false

ScopeMappingRepresentation array

clientScopeMappings

false

[Map]

clients

false

ClientRepresentation array

clientTemplates

false

ClientTemplateRepresentation array

browserSecurityHeaders

false

[Map]

smtpServer

false

[Map]

userFederationProviders

false

UserFederationProviderRepresentation array

userFederationMappers

false

UserFederationMapperRepresentation array

loginTheme

false

string

accountTheme

false

string

adminTheme

false

string

emailTheme

false

string

eventsEnabled

false

boolean

eventsExpiration

false

integer (int64)

eventsListeners

false

string array

enabledEventTypes

false

string array

adminEventsEnabled

false

boolean

adminEventsDetailsEnabled

false

boolean

identityProviders

false

IdentityProviderRepresentation array

identityProviderMappers

false

IdentityProviderMapperRepresentation array

protocolMappers

false

ProtocolMapperRepresentation array

components

false

MultivaluedHashMap

internationalizationEnabled

false

boolean

supportedLocales

false

string array

defaultLocale

false

string

authenticationFlows

false

AuthenticationFlowRepresentation array

authenticatorConfig

false

AuthenticatorConfigRepresentation array

requiredActions

false

RequiredActionProviderRepresentation array

browserFlow

false

string

registrationFlow

false

string

directGrantFlow

false

string

resetCredentialsFlow

false

string

clientAuthenticationFlow

false

string

attributes

false

[Map]

keycloakVersion

false

string

ServerInfoRepresentation

Name Description Required Schema Default

systemInfo

false

SystemInfoRepresentation

memoryInfo

false

MemoryInfoRepresentation

profileInfo

false

ProfileInfoRepresentation

themes

false

[Map]

socialProviders

false

[Map] array

identityProviders

false

[Map] array

clientImporters

false

[Map] array

providers

false

[Map]

protocolMapperTypes

false

[Map]

builtinProtocolMappers

false

[Map]

clientInstallations

false

[Map]

componentTypes

false

[Map]

passwordPolicies

false

PasswordPolicyTypeRepresentation array

enums

false

[Map]

RolesRepresentation

Name Description Required Schema Default

realm

false

RoleRepresentation array

client

false

[Map]

ComponentExportRepresentation

Name Description Required Schema Default

id

false

string

name

false

string

providerId

false

string

subType

false

string

subComponents

false

MultivaluedHashMap

config

false

MultivaluedHashMap

RoleRepresentation-Composites

Name Description Required Schema Default

realm

false

string array

client

false

[Map]

PolicyRepresentation

Name Description Required Schema Default

id

false

string

name

false

string

description

false

string

type

false

string

logic

false

enum (POSITIVE, NEGATIVE)

decisionStrategy

false

enum (AFFIRMATIVE, UNANIMOUS, CONSENSUS)

config

false

[Map]

GlobalRequestResult

Name Description Required Schema Default

successRequests

false

string array

failedRequests

false

string array

ClientInitialAccessCreatePresentation

Name Description Required Schema Default

expiration

false

integer (int32)

count

false

integer (int32)

SynchronizationResult

Name Description Required Schema Default

ignored

false

boolean

added

false

integer (int32)

updated

false

integer (int32)

removed

false

integer (int32)

failed

false

integer (int32)

status

false

string

FederatedIdentityRepresentation

Name Description Required Schema Default

identityProvider

false

string

userId

false

string

userName

false

string

KeyStoreConfig

Name Description Required Schema Default

realmCertificate

false

boolean

storePassword

false

string

keyPassword

false

string

keyAlias

false

string

realmAlias

false

string

format

false

string

RoleRepresentation

Name Description Required Schema Default

id

false

string

name

false

string

description

false

string

scopeParamRequired

false

boolean

composite

false

boolean

composites

false

RoleRepresentation-Composites

clientRole

false

boolean

containerId

false

string

GroupRepresentation

Name Description Required Schema Default

id

false

string

name

false

string

path

false

string

attributes

false

[Map]

realmRoles

false

string array

clientRoles

false

[Map]

subGroups

false

GroupRepresentation array

AuthenticatorConfigInfoRepresentation

Name Description Required Schema Default

name

false

string

providerId

false

string

helpText

false

string

properties

false

ConfigPropertyRepresentation array

AuthenticationFlowRepresentation

Name Description Required Schema Default

id

false

string

alias

false

string

description

false

string

providerId

false

string

topLevel

false

boolean

builtIn

false

boolean

authenticationExecutions

false

AuthenticationExecutionExportRepresentation array

AuthenticationExecutionInfoRepresentation

Name Description Required Schema Default

id

false

string

requirement

false

string

displayName

false

string

alias

false

string

requirementChoices

false

string array

configurable

false

boolean

authenticationFlow

false

boolean

providerId

false

string

authenticationConfig

false

string

flowId

false

string

level

false

integer (int32)

index

false

integer (int32)

ResourceRepresentation

Name Description Required Schema Default

_id

false

string

name

false

string

uri

false

string

type

false

string

scopes

false

ScopeRepresentation array

icon_uri

false

string

owner

false

ResourceOwnerRepresentation

policies

false

PolicyRepresentation array

typedScopes

false

ScopeRepresentation array

CredentialRepresentation

Name Description Required Schema Default

type

false

string

device

false

string

value

false

string

hashedSaltedValue

false

string

salt

false

string

hashIterations

false

integer (int32)

counter

false

integer (int32)

algorithm

false

string

digits

false

integer (int32)

period

false

integer (int32)

createdDate

false

integer (int64)

config

false

MultivaluedHashMap

temporary

false

boolean

ComponentRepresentation

Name Description Required Schema Default

id

false

string

name

false

string

providerId

false

string

providerType

false

string

parentId

false

string

subType

false

string

config

false

MultivaluedHashMap

MappingsRepresentation

Name Description Required Schema Default

realmMappings

false

RoleRepresentation array

clientMappings

false

[Map]

AdminEventRepresentation

Name Description Required Schema Default

time

false

integer (int64)

realmId

false

string

authDetails

false

AuthDetailsRepresentation

operationType

false

string

resourceType

false

string

resourcePath

false

string

representation

false

string

error

false

string

ScopeRepresentation

Name Description Required Schema Default

id

false

string

name

false

string

iconUri

false

string

policies

false

PolicyRepresentation array

resources

false

ResourceRepresentation array

UserFederationMapperRepresentation

Name Description Required Schema Default

id

false

string

name

false

string

federationProviderDisplayName

false

string

federationMapperType

false

string

config

false

[Map]

AuthenticationExecutionExportRepresentation

Name Description Required Schema Default

authenticatorConfig

false

string

authenticator

false

string

authenticatorFlow

false

boolean

requirement

false

string

priority

false

integer (int32)

autheticatorFlow

false

boolean

flowAlias

false

string

userSetupAllowed

false

boolean

AuthenticatorConfigRepresentation

Name Description Required Schema Default

id

false

string

alias

false

string

config

false

[Map]

UserRepresentation

Name Description Required Schema Default

self

false

string

id

false

string

origin

false

string

createdTimestamp

false

integer (int64)

username

false

string

enabled

false

boolean

emailVerified

false

boolean

firstName

false

string

lastName

false

string

email

false

string

federationLink

false

string

serviceAccountClientId

false

string

attributes

false

[Map]

credentials

false

CredentialRepresentation array

disableableCredentialTypes

false

string array

requiredActions

false

string array

federatedIdentities

false

FederatedIdentityRepresentation array

realmRoles

false

string array

clientRoles

false

[Map]

clientConsents

false

UserConsentRepresentation array

groups

false

string array

RequiredActionProviderRepresentation

Name Description Required Schema Default

alias

false

string

name

false

string

providerId

false

string

enabled

false

boolean

defaultAction

false

boolean

config

false

[Map]

ResourceServerRepresentation

Name Description Required Schema Default

id

false

string

clientId

false

string

name

false

string

allowRemoteResourceManagement

false

boolean

policyEnforcementMode

false

enum (ENFORCING, PERMISSIVE, DISABLED)

resources

false

ResourceRepresentation array

policies

false

PolicyRepresentation array

scopes

false

ScopeRepresentation array

CertificateRepresentation

Name Description Required Schema Default

privateKey

false

string

publicKey

false

string

certificate

false

string

kid

false

string

EventRepresentation

Name Description Required Schema Default

time

false

integer (int64)

type

false

string

realmId

false

string

clientId

false

string

userId

false

string

sessionId

false

string

ipAddress

false

string

error

false

string

details

false

[Map]

ProviderRepresentation

Name Description Required Schema Default

operationalInfo

false

[Map]

ResourceOwnerRepresentation

Name Description Required Schema Default

id

false

string

name

false

string

ProfileInfoRepresentation

Name Description Required Schema Default

name

false

string

disabledFeatures

false

string array

UserConsentRepresentation

Name Description Required Schema Default

clientId

false

string

grantedProtocolMappers

false

[Map]

grantedRealmRoles

false

string array

grantedClientRoles

false

[Map]

createdDate

false

integer (int64)

lastUpdatedDate

false

integer (int64)

ClientRepresentation

Name Description Required Schema Default

id

false

string

clientId

false

string

name

false

string

description

false

string

rootUrl

false

string

adminUrl

false

string

baseUrl

false

string

surrogateAuthRequired

false

boolean

enabled

false

boolean

clientAuthenticatorType

false

string

secret

false

string

registrationAccessToken

false

string

defaultRoles

false

object array

redirectUris

false

string array

webOrigins

false

string array

notBefore

false

integer (int32)

bearerOnly

false

boolean

consentRequired

false

boolean

standardFlowEnabled

false

boolean

implicitFlowEnabled

false

boolean

directAccessGrantsEnabled

false

boolean

serviceAccountsEnabled

false

boolean

authorizationServicesEnabled

false

boolean

publicClient

false

boolean

frontchannelLogout

false

boolean

protocol

false

string

attributes

false

[Map]

fullScopeAllowed

false

boolean

nodeReRegistrationTimeout

false

integer (int32)

registeredNodes

false

[Map]

protocolMappers

false

ProtocolMapperRepresentation array

clientTemplate

false

string

useTemplateConfig

false

boolean

useTemplateScope

false

boolean

useTemplateMappers

false

boolean

authorizationSettings

false

ResourceServerRepresentation

ComponentTypeRepresentation

Name Description Required Schema Default

id

false

string

helpText

false

string

properties

false

ConfigPropertyRepresentation array

metadata

false

[Map]

ClientTemplateRepresentation

Name Description Required Schema Default

id

false

string

name

false

string

description

false

string

protocol

false

string

fullScopeAllowed

false

boolean

bearerOnly

false

boolean

consentRequired

false

boolean

standardFlowEnabled

false

boolean

implicitFlowEnabled

false

boolean

directAccessGrantsEnabled

false

boolean

serviceAccountsEnabled

false

boolean

publicClient

false

boolean

frontchannelLogout

false

boolean

attributes

false

[Map]

protocolMappers

false

ProtocolMapperRepresentation array

ClientInitialAccessPresentation

Name Description Required Schema Default

id

false

string

token

false

string

timestamp

false

integer (int32)

expiration

false

integer (int32)

count

false

integer (int32)

remainingCount

false

integer (int32)

ClientMappingsRepresentation

Name Description Required Schema Default

id

false

string

client

false

string

mappings

false

RoleRepresentation array

ConfigPropertyRepresentation

Name Description Required Schema Default

name

false

string

label

false

string

helpText

false

string

type

false

string

defaultValue

false

[Object]

options

false

string array

secret

false

boolean