Make interface for python:
```md
## Resources

### Attack Detection

#### Clear any user login failures for all users This can release temporary disabled users

DELETE /{realm}/attack-detection/brute-force/users

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Get status of a username in brute force detection

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **userId**  <br>_required_ |     | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Map](#_map) |

##### Produces

*   `application/json`
    

#### Clear any user login failures for the user This can release temporary disabled user

DELETE /{realm}/attack-detection/brute-force/users/{userId}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **userId**  <br>_required_ |     | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

### Authentication Management

#### Get authenticator providers Returns a stream of authenticator providers.

GET /{realm}/authentication/authenticator-providers

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Get client authenticator providers Returns a stream of client authenticator providers.

GET /{realm}/authentication/client-authenticator-providers

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Get authenticator provider’s configuration description

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **providerId**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [AuthenticatorConfigInfoRepresentation](#_authenticatorconfiginforepresentation) |

##### Produces

*   `application/json`
    

#### Get authenticator configuration

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | Configuration id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [AuthenticatorConfigRepresentation](#_authenticatorconfigrepresentation) |

##### Produces

*   `application/json`
    

#### Update authenticator configuration

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | Configuration id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **rep**  <br>_required_ | JSON describing new state of authenticator configuration | [AuthenticatorConfigRepresentation](#_authenticatorconfigrepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

#### Delete authenticator configuration

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | Configuration id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Add new authentication execution

POST /{realm}/authentication/executions

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **execution**  <br>_required_ | JSON model describing authentication execution | [AuthenticationExecutionRepresentation](#_authenticationexecutionrepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### Get Single Execution

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **executionId**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Produces

*   `application/json`
    

#### Delete execution

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **executionId**  <br>_required_ | Execution id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Update execution with new configuration

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **executionId**  <br>_required_ | Execution id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **json**  <br>_required_ | JSON with new configuration | [AuthenticatorConfigRepresentation](#_authenticatorconfigrepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### Lower execution’s priority

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **executionId**  <br>_required_ | Execution id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Raise execution’s priority

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **executionId**  <br>_required_ | Execution id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Create a new authentication flow

POST /{realm}/authentication/flows

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **flow**  <br>_required_ | Authentication flow representation | [AuthenticationFlowRepresentation](#_authenticationflowrepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### Get authentication flows Returns a stream of authentication flows.

GET /{realm}/authentication/flows

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Copy existing authentication flow under a new name The new name is given as 'newName' attribute of the passed JSON object

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **flowAlias**  <br>_required_ | Name of the existing authentication flow | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **data**  <br>_required_ | JSON containing 'newName' attribute | [Map](#_map) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### Get authentication executions for a flow

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **flowAlias**  <br>_required_ | Flow alias | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Produces

*   `application/json`
    

#### Update authentication executions of a Flow

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **flowAlias**  <br>_required_ | Flow alias | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **rep**  <br>_required_ | AuthenticationExecutionInfoRepresentation | [AuthenticationExecutionInfoRepresentation](#_authenticationexecutioninforepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

##### Produces

*   `application/json`
    

#### Add new authentication execution to a flow

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **flowAlias**  <br>_required_ | Alias of parent flow | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **data**  <br>_required_ | New execution JSON data containing 'provider' attribute | [Map](#_map) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### Add new flow with new execution to existing flow

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **flowAlias**  <br>_required_ | Alias of parent authentication flow | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **data**  <br>_required_ | New authentication flow / execution JSON data containing 'alias', 'type', 'provider', and 'description' attributes | [Map](#_map) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### Get authentication flow for id

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | Flow id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [AuthenticationFlowRepresentation](#_authenticationflowrepresentation) |

##### Produces

*   `application/json`
    

#### Update an authentication flow

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **flow**  <br>_required_ | Authentication flow representation | [AuthenticationFlowRepresentation](#_authenticationflowrepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

##### Produces

*   `application/json`
    

#### Delete an authentication flow

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | Flow id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Get form action providers Returns a stream of form action providers.

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Get form providers Returns a stream of form providers.

GET /{realm}/authentication/form-providers

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Get configuration descriptions for all clients

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Map](#_map) |

##### Produces

*   `application/json`
    

#### Register a new required actions

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **data**  <br>_required_ | JSON containing 'providerId', and 'name' attributes. | [Map](#_map) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

#### Get required actions Returns a stream of required actions.

GET /{realm}/authentication/required-actions

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Get required action for alias

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **alias**  <br>_required_ | Alias of required action | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [RequiredActionProviderRepresentation](#_requiredactionproviderrepresentation) |

##### Produces

*   `application/json`
    

#### Update required action

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **alias**  <br>_required_ | Alias of required action | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **rep**  <br>_required_ | JSON describing new state of required action | [RequiredActionProviderRepresentation](#_requiredactionproviderrepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

#### Delete required action

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **alias**  <br>_required_ | Alias of required action | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Lower required action’s priority

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **alias**  <br>_required_ | Alias of required action | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Raise required action’s priority

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **alias**  <br>_required_ | Alias of required action | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Get unregistered required actions Returns a stream of unregistered required actions.

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

### Client Attribute Certificate

#### Get key info

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **attr**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [CertificateRepresentation](#_certificaterepresentation) |

##### Produces

*   `application/json`
    

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

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **attr**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **config**  <br>_required_ | Keystore configuration as JSON | [KeyStoreConfig](#_keystoreconfig) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | < string(byte) > array |

##### Consumes

*   `application/json`
    

##### Produces

*   `application/octet-stream`
    

#### Generate a new certificate with new key pair

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **attr**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [CertificateRepresentation](#_certificaterepresentation) |

##### Produces

*   `application/json`
    

#### 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 /{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 | Schema |
| --- | --- | --- | --- |
| **Path** | **attr**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **config**  <br>_required_ | Keystore configuration as JSON | [KeyStoreConfig](#_keystoreconfig) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | < string(byte) > array |

##### Consumes

*   `application/json`
    

##### Produces

*   `application/octet-stream`
    

#### Upload certificate and eventually private key

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **attr**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [CertificateRepresentation](#_certificaterepresentation) |

##### Consumes

*   `multipart/form-data`
    

##### Produces

*   `application/json`
    

#### Upload only certificate, not private key

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **attr**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [CertificateRepresentation](#_certificaterepresentation) |

##### Consumes

*   `multipart/form-data`
    

##### Produces

*   `application/json`
    

### Client Initial Access

#### Create a new initial access token.

POST /{realm}/clients-initial-access

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **config**  <br>_required_ |     | [ClientInitialAccessCreatePresentation](#_clientinitialaccesscreatepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [ClientInitialAccessPresentation](#_clientinitialaccesspresentation) |

##### Consumes

*   `application/json`
    

##### Produces

*   `application/json`
    

#### GET /{realm}/clients-initial-access

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### DELETE /{realm}/clients-initial-access/{id}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

### Client Registration Policy

#### Base path for retrieve providers with the configProperties properly filled

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

### Client Role Mappings

#### Add client-level roles to the user role mapping

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **client**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **roles**  <br>_required_ |     | < [RoleRepresentation](#_rolerepresentation) > array |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

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

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **client**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Delete client-level roles from user role mapping

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **client**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **roles**  <br>_required_ |     | < [RoleRepresentation](#_rolerepresentation) > array |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

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

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **client**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Get effective client-level role mappings This recurses any composite roles

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

##### Parameters

    
| Type | Name | Description | Schema | Default |
| --- | --- | --- | --- | --- |
| **Path** | **client**  <br>_required_ |     | string |     |
| **Path** | **id**  <br>_required_ |     | string |     |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |     |
| **Query** | **briefRepresentation**  <br>_optional_ | if false, return roles with their attributes | boolean | `"true"` |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Add client-level roles to the user role mapping

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **client**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **roles**  <br>_required_ |     | < [RoleRepresentation](#_rolerepresentation) > array |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

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

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **client**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Delete client-level roles from user role mapping

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **client**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **roles**  <br>_required_ |     | < [RoleRepresentation](#_rolerepresentation) > array |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

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

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **client**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Get effective client-level role mappings This recurses any composite roles

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

##### Parameters

    
| Type | Name | Description | Schema | Default |
| --- | --- | --- | --- | --- |
| **Path** | **client**  <br>_required_ |     | string |     |
| **Path** | **id**  <br>_required_ | User id | string |     |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |     |
| **Query** | **briefRepresentation**  <br>_optional_ | if false, return roles with their attributes | boolean | `"true"` |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

### Client Scopes

#### Create a new client scope Client Scope’s name must be unique!

POST /{realm}/client-scopes

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **rep**  <br>_required_ |     | [ClientScopeRepresentation](#_clientscoperepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### Get client scopes belonging to the realm Returns a list of client scopes belonging to the realm

GET /{realm}/client-scopes

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Get representation of the client scope

GET /{realm}/client-scopes/{id}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client scope (not name) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [ClientScopeRepresentation](#_clientscoperepresentation) |

##### Produces

*   `application/json`
    

#### Update the client scope

PUT /{realm}/client-scopes/{id}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client scope (not name) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **rep**  <br>_required_ |     | [ClientScopeRepresentation](#_clientscoperepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### Delete the client scope

DELETE /{realm}/client-scopes/{id}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client scope (not name) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

### Clients

#### Create a new client Client’s client\_id must be unique!

POST /{realm}/clients

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **rep**  <br>_required_ |     | [ClientRepresentation](#_clientrepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### Get clients belonging to the realm.

GET /{realm}/clients

##### Description

If a client can’t be retrieved from the storage due to a problem with the underlying storage, it is silently removed from the returned list. This ensures that concurrent modifications to the list don’t prevent callers from retrieving this list.

##### Parameters

    
| Type | Name | Description | Schema | Default |
| --- | --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |     |
| **Query** | **clientId**  <br>_optional_ | filter by clientId | string |     |
| **Query** | **first**  <br>_optional_ | the first result | integer(int32) |     |
| **Query** | **max**  <br>_optional_ | the max results to return | integer(int32) |     |
| **Query** | **q**  <br>_optional_ |     | string |     |
| **Query** | **search**  <br>_optional_ | whether this is a search query or a getClientById query | boolean | `"false"` |
| **Query** | **viewableOnly**  <br>_optional_ | filter clients that cannot be viewed in full by admin | boolean | `"false"` |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Get representation of the client

GET /{realm}/clients/{id}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [ClientRepresentation](#_clientrepresentation) |

##### Produces

*   `application/json`
    

#### Update the client

PUT /{realm}/clients/{id}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **rep**  <br>_required_ |     | [ClientRepresentation](#_clientrepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### Delete the client

DELETE /{realm}/clients/{id}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Generate a new secret for the client

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [CredentialRepresentation](#_credentialrepresentation) |

##### Consumes

*   `application/json`
    

##### Produces

*   `application/json`
    

#### Get the client secret

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [CredentialRepresentation](#_credentialrepresentation) |

##### Produces

*   `application/json`
    

#### Get the rotated client secret

GET /{realm}/clients/{id}/client-secret/rotated

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [CredentialRepresentation](#_credentialrepresentation) |

##### Produces

*   `application/json`
    

#### Invalidate the rotated secret for the client

DELETE /{realm}/clients/{id}/client-secret/rotated

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

##### Produces

*   `application/json`
    

#### Get default client scopes.

GET /{realm}/clients/{id}/default-client-scopes

##### Description

Only name and ids are returned.

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### PUT /{realm}/clients/{id}/default-client-scopes/{clientScopeId}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **clientScopeId**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### DELETE /{realm}/clients/{id}/default-client-scopes/{clientScopeId}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **clientScopeId**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Create JSON with payload of example access token

GET /{realm}/clients/{id}/evaluate-scopes/generate-example-access-token

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Query** | **scope**  <br>_optional_ |     | string |
| **Query** | **userId**  <br>_optional_ |     | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [AccessToken](#_accesstoken) |

##### Produces

*   `application/json`
    

#### Create JSON with payload of example id token

GET /{realm}/clients/{id}/evaluate-scopes/generate-example-id-token

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Query** | **scope**  <br>_optional_ |     | string |
| **Query** | **userId**  <br>_optional_ |     | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [IDToken](#_idtoken) |

##### Produces

*   `application/json`
    

#### Create JSON with payload of example user info

GET /{realm}/clients/{id}/evaluate-scopes/generate-example-userinfo

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Query** | **scope**  <br>_optional_ |     | string |
| **Query** | **userId**  <br>_optional_ |     | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Map](#_map) |

##### Produces

*   `application/json`
    

#### Return list of all protocol mappers, which will be used when generating tokens issued for particular client.

GET /{realm}/clients/{id}/evaluate-scopes/protocol-mappers

##### Description

This means protocol mappers assigned to this client directly and protocol mappers assigned to all client scopes of this client.

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Query** | **scope**  <br>_optional_ |     | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Get effective scope mapping of all roles of particular role container, which this client is defacto allowed to have in the accessToken issued for him.

GET /{realm}/clients/{id}/evaluate-scopes/scope-mappings/{roleContainerId}/granted

##### Description

This contains scope mappings, which this client has directly, as well as scope mappings, which are granted to all client scopes, which are linked with this client.

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **roleContainerId**  <br>_required_ | either realm name OR client UUID | string |
| **Query** | **scope**  <br>_optional_ |     | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Get roles, which this client doesn’t have scope for and can’t have them in the accessToken issued for him.

GET /{realm}/clients/{id}/evaluate-scopes/scope-mappings/{roleContainerId}/not-granted

##### Description

Defacto all the other roles of particular role container, which are not in {@link #getGrantedScopeMappings()}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **roleContainerId**  <br>_required_ | either realm name OR client UUID | string |
| **Query** | **scope**  <br>_optional_ |     | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### GET /{realm}/clients/{id}/installation/providers/{providerId}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **providerId**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

#### Return object stating whether client Authorization permissions have been initialized or not and a reference

GET /{realm}/clients/{id}/management/permissions

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [ManagementPermissionReference](#_managementpermissionreference) |

##### Produces

*   `application/json`
    

#### Return object stating whether client Authorization permissions have been initialized or not and a reference

PUT /{realm}/clients/{id}/management/permissions

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **ref**  <br>_required_ |     | [ManagementPermissionReference](#_managementpermissionreference) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [ManagementPermissionReference](#_managementpermissionreference) |

##### Consumes

*   `application/json`
    

##### Produces

*   `application/json`
    

#### 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 /{realm}/clients/{id}/nodes

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **formParams**  <br>_required_ |     | [Map](#_map) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

#### Unregister a cluster node from the client

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **node**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Get application offline session count Returns a number of offline user sessions associated with this client { "count": number }

GET /{realm}/clients/{id}/offline-session-count

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Map](#_map) |

##### Produces

*   `application/json`
    

#### Get offline sessions for client Returns a list of offline user sessions associated with this client

GET /{realm}/clients/{id}/offline-sessions

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Query** | **first**  <br>_optional_ | Paging offset | integer(int32) |
| **Query** | **max**  <br>_optional_ | Maximum results size (defaults to 100) | integer(int32) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Get optional client scopes.

GET /{realm}/clients/{id}/optional-client-scopes

##### Description

Only name and ids are returned.

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### PUT /{realm}/clients/{id}/optional-client-scopes/{clientScopeId}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **clientScopeId**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### DELETE /{realm}/clients/{id}/optional-client-scopes/{clientScopeId}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **clientScopeId**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Push the client’s revocation policy to its admin URL If the client has an admin URL, push revocation policy to it.

POST /{realm}/clients/{id}/push-revocation

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [GlobalRequestResult](#_globalrequestresult) |

##### Produces

*   `application/json`
    

#### Generate a new registration access token for the client

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [ClientRepresentation](#_clientrepresentation) |

##### Consumes

*   `application/json`
    

##### Produces

*   `application/json`
    

#### Get a user dedicated to the service account

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [UserRepresentation](#_userrepresentation) |

##### Produces

*   `application/json`
    

#### Get application session count Returns a number of user sessions associated with this client { "count": number }

GET /{realm}/clients/{id}/session-count

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Map](#_map) |

##### Produces

*   `application/json`
    

#### Test if registered cluster nodes are available Tests availability by sending 'ping' request to all cluster nodes.

GET /{realm}/clients/{id}/test-nodes-available

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [GlobalRequestResult](#_globalrequestresult) |

##### Produces

*   `application/json`
    

#### Get user sessions for client Returns a list of user sessions associated with this client

GET /{realm}/clients/{id}/user-sessions

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Query** | **first**  <br>_optional_ | Paging offset | integer(int32) |
| **Query** | **max**  <br>_optional_ | Maximum results size (defaults to 100) | integer(int32) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

### Component

#### POST /{realm}/components

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **rep**  <br>_required_ |     | [ComponentRepresentation](#_componentrepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### GET /{realm}/components

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Query** | **name**  <br>_optional_ |     | string |
| **Query** | **parent**  <br>_optional_ |     | string |
| **Query** | **type**  <br>_optional_ |     | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### GET /{realm}/components/{id}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [ComponentRepresentation](#_componentrepresentation) |

##### Produces

*   `application/json`
    

#### PUT /{realm}/components/{id}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **rep**  <br>_required_ |     | [ComponentRepresentation](#_componentrepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### DELETE /{realm}/components/{id}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

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

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Query** | **type**  <br>_optional_ |     | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

### Groups

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

POST /{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 | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **rep**  <br>_required_ |     | [GroupRepresentation](#_grouprepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### Get group hierarchy.

GET /{realm}/groups

##### Description

Only name and ids are returned.

##### Parameters

    
| Type | Name | Description | Schema | Default |
| --- | --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |     |
| **Query** | **briefRepresentation**  <br>_optional_ |     | boolean | `"true"` |
| **Query** | **exact**  <br>_optional_ |     | boolean | `"false"` |
| **Query** | **first**  <br>_optional_ |     | integer(int32) |     |
| **Query** | **max**  <br>_optional_ |     | integer(int32) |     |
| **Query** | **q**  <br>_optional_ |     | string |     |
| **Query** | **search**  <br>_optional_ |     | string |     |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Returns the groups counts.

GET /{realm}/groups/count

##### Parameters

    
| Type | Name | Description | Schema | Default |
| --- | --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |     |
| **Query** | **search**  <br>_optional_ |     | string |     |
| **Query** | **top**  <br>_optional_ |     | boolean | `"false"` |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Map](#_map) |

##### Produces

*   `application/json`
    

#### GET /{realm}/groups/{id}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [GroupRepresentation](#_grouprepresentation) |

##### Produces

*   `application/json`
    

#### Update group, ignores subgroups.

PUT /{realm}/groups/{id}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **rep**  <br>_required_ |     | [GroupRepresentation](#_grouprepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### DELETE /{realm}/groups/{id}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Set or create child.

POST /{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 | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **rep**  <br>_required_ |     | [GroupRepresentation](#_grouprepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

##### Produces

*   `application/json`
    

#### Return object stating whether client Authorization permissions have been initialized or not and a reference

GET /{realm}/groups/{id}/management/permissions

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [ManagementPermissionReference](#_managementpermissionreference) |

##### Produces

*   `application/json`
    

#### Return object stating whether client Authorization permissions have been initialized or not and a reference

PUT /{realm}/groups/{id}/management/permissions

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **ref**  <br>_required_ |     | [ManagementPermissionReference](#_managementpermissionreference) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [ManagementPermissionReference](#_managementpermissionreference) |

##### Consumes

*   `application/json`
    

##### Produces

*   `application/json`
    

#### Get users Returns a stream of users, filtered according to query parameters

GET /{realm}/groups/{id}/members

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Query** | **briefRepresentation**  <br>_optional_ | Only return basic information (only guaranteed to return id, username, created, first and last name, email, enabled state, email verification state, federation link, and access. Note that it means that namely user attributes, required actions, and not before are not returned.) | boolean |
| **Query** | **first**  <br>_optional_ | Pagination offset | integer(int32) |
| **Query** | **max**  <br>_optional_ | Maximum results size (defaults to 100) | integer(int32) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

### Identity Providers

#### Import identity provider from JSON body

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **data**  <br>_required_ | JSON body | [Map](#_map) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Map](#_map) |

##### Consumes

*   `application/json`
    

##### Produces

*   `application/json`
    

#### Create a new identity provider

POST /{realm}/identity-provider/instances

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **representation**  <br>_required_ | JSON body | [IdentityProviderRepresentation](#_identityproviderrepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### Get identity providers

GET /{realm}/identity-provider/instances

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Get the identity provider

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **alias**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [IdentityProviderRepresentation](#_identityproviderrepresentation) |

##### Produces

*   `application/json`
    

#### Update the identity provider

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **alias**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **providerRep**  <br>_required_ |     | [IdentityProviderRepresentation](#_identityproviderrepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### Delete the identity provider

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **alias**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

#### Export public broker configuration for identity provider

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **alias**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Query** | **format**  <br>_optional_ | Format to use | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

#### Return object stating whether client Authorization permissions have been initialized or not and a reference

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **alias**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [ManagementPermissionReference](#_managementpermissionreference) |

##### Produces

*   `application/json`
    

#### Return object stating whether client Authorization permissions have been initialized or not and a reference

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **alias**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **ref**  <br>_required_ |     | [ManagementPermissionReference](#_managementpermissionreference) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [ManagementPermissionReference](#_managementpermissionreference) |

##### Consumes

*   `application/json`
    

##### Produces

*   `application/json`
    

#### Get mapper types for identity provider

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **alias**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Map](#_map) |

#### Add a mapper to identity provider

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **alias**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **mapper**  <br>_required_ |     | [IdentityProviderMapperRepresentation](#_identityprovidermapperrepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### Get mappers for identity provider

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **alias**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Get mapper by id for the identity provider

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **alias**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [IdentityProviderMapperRepresentation](#_identityprovidermapperrepresentation) |

##### Produces

*   `application/json`
    

#### Update a mapper for the identity provider

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **alias**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ | Mapper id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **rep**  <br>_required_ |     | [IdentityProviderMapperRepresentation](#_identityprovidermapperrepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

#### Delete a mapper for the identity provider

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **alias**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ | Mapper id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Get identity providers

GET /{realm}/identity-provider/providers/{provider\_id}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **provider\_id**  <br>_required_ | Provider id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Produces

*   `application/json`
    

### Key

#### GET /{realm}/keys

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [KeysMetadataRepresentation](#_keysmetadatarepresentation) |

##### Produces

*   `application/json`
    

### Protocol Mappers

#### Create multiple mappers

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client scope (not name) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **reps**  <br>_required_ |     | < [ProtocolMapperRepresentation](#_protocolmapperrepresentation) > array |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

#### Create a mapper

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client scope (not name) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **rep**  <br>_required_ |     | [ProtocolMapperRepresentation](#_protocolmapperrepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### Get mappers

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client scope (not name) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Get mapper by id

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | Mapper id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [ProtocolMapperRepresentation](#_protocolmapperrepresentation) |

##### Produces

*   `application/json`
    

#### Update the mapper

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | Mapper id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **rep**  <br>_required_ |     | [ProtocolMapperRepresentation](#_protocolmapperrepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

#### Delete the mapper

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | Mapper id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Get mappers by name for a specific protocol

GET /{realm}/client-scopes/{id}/protocol-mappers/protocol/{protocol}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client scope (not name) | string |
| **Path** | **protocol**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Create multiple mappers

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **reps**  <br>_required_ |     | < [ProtocolMapperRepresentation](#_protocolmapperrepresentation) > array |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

#### Create a mapper

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **rep**  <br>_required_ |     | [ProtocolMapperRepresentation](#_protocolmapperrepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### Get mappers

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Get mapper by id

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | Mapper id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [ProtocolMapperRepresentation](#_protocolmapperrepresentation) |

##### Produces

*   `application/json`
    

#### Update the mapper

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | Mapper id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **rep**  <br>_required_ |     | [ProtocolMapperRepresentation](#_protocolmapperrepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

#### Delete the mapper

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | Mapper id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Get mappers by name for a specific protocol

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **protocol**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

### Realms Admin

#### Import a realm.

POST /

##### Description

Imports a realm from a full representation of that realm. Realm name must be unique.

##### Parameters

  
| Type | Name | Schema |
| --- | --- | --- |
| **Body** | **requestBody**  <br>_required_ | [InputStream](#_inputstream) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### Get the top-level representation of the realm It will not include nested information like User and Client representations.

GET /{realm}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [RealmRepresentation](#_realmrepresentation) |

##### Produces

*   `application/json`
    

#### Update the top-level information of the realm Any user, roles or client information in the representation will be ignored.

PUT /{realm}

##### Description

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **rep**  <br>_required_ |     | [RealmRepresentation](#_realmrepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### Delete the realm

DELETE /{realm}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Get admin events Returns all admin events, or filters events based on URL query parameters listed here

GET /{realm}/admin-events

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Query** | **authClient**  <br>_optional_ |     | string |
| **Query** | **authIpAddress**  <br>_optional_ |     | string |
| **Query** | **authRealm**  <br>_optional_ |     | string |
| **Query** | **authUser**  <br>_optional_ | user id | string |
| **Query** | **dateFrom**  <br>_optional_ |     | string |
| **Query** | **dateTo**  <br>_optional_ |     | string |
| **Query** | **first**  <br>_optional_ |     | integer(int32) |
| **Query** | **max**  <br>_optional_ | Maximum results size (defaults to 100) | integer(int32) |
| **Query** | **operationTypes**  <br>_optional_ |     | < string > array(csv) |
| **Query** | **resourcePath**  <br>_optional_ |     | string |
| **Query** | **resourceTypes**  <br>_optional_ |     | < string > array(csv) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Delete all admin events

DELETE /{realm}/admin-events

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Base path for importing clients under this realm.

POST /{realm}/client-description-converter

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **description**  <br>_required_ |     | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [ClientRepresentation](#_clientrepresentation) |

##### Consumes

*   `application/json`
    
*   `application/xml`
    
*   `text/plain`
    

##### Produces

*   `application/json`
    

#### GET /{realm}/client-policies/policies

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [ClientPoliciesRepresentation](#_clientpoliciesrepresentation) |

##### Produces

*   `application/json`
    

#### PUT /{realm}/client-policies/policies

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **clientPolicies**  <br>_required_ |     | [ClientPoliciesRepresentation](#_clientpoliciesrepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### GET /{realm}/client-policies/profiles

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Query** | **include-global-profiles**  <br>_optional_ |     | boolean |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [ClientProfilesRepresentation](#_clientprofilesrepresentation) |

##### Produces

*   `application/json`
    

#### PUT /{realm}/client-policies/profiles

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **clientProfiles**  <br>_required_ |     | [ClientProfilesRepresentation](#_clientprofilesrepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### Get client session stats Returns a JSON map.

GET /{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 | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### GET /{realm}/credential-registrators

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Get realm default client scopes.

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

##### Description

Only name and ids are returned.

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### PUT /{realm}/default-default-client-scopes/{clientScopeId}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **clientScopeId**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### DELETE /{realm}/default-default-client-scopes/{clientScopeId}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **clientScopeId**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Get group hierarchy.

GET /{realm}/default-groups

##### Description

Only name and ids are returned.

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### PUT /{realm}/default-groups/{groupId}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **groupId**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### DELETE /{realm}/default-groups/{groupId}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **groupId**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Get realm optional client scopes.

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

##### Description

Only name and ids are returned.

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### PUT /{realm}/default-optional-client-scopes/{clientScopeId}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **clientScopeId**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### DELETE /{realm}/default-optional-client-scopes/{clientScopeId}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **clientScopeId**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Get events Returns all events, or filters them based on URL query parameters listed here

GET /{realm}/events

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Query** | **client**  <br>_optional_ | App or oauth client name | string |
| **Query** | **dateFrom**  <br>_optional_ | From date | string |
| **Query** | **dateTo**  <br>_optional_ | To date | string |
| **Query** | **first**  <br>_optional_ | Paging offset | integer(int32) |
| **Query** | **ipAddress**  <br>_optional_ | IP address | string |
| **Query** | **max**  <br>_optional_ | Maximum results size (defaults to 100) | integer(int32) |
| **Query** | **type**  <br>_optional_ | The types of events to return | < string > array(csv) |
| **Query** | **user**  <br>_optional_ | User id | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Delete all events

DELETE /{realm}/events

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Get the events provider configuration Returns JSON object with events provider configuration

GET /{realm}/events/config

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [RealmEventsConfigRepresentation](#_realmeventsconfigrepresentation) |

##### Produces

*   `application/json`
    

#### Update the events provider Change the events provider and/or its configuration

PUT /{realm}/events/config

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **rep**  <br>_required_ |     | [RealmEventsConfigRepresentation](#_realmeventsconfigrepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

#### GET /{realm}/group-by-path/{path}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **path**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [GroupRepresentation](#_grouprepresentation) |

##### Produces

*   `application/json`
    

#### GET /{realm}/localization

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### POST /{realm}/localization/{locale}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **locale**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **localizationTexts**  <br>_required_ |     | [Map](#_map) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

#### GET /{realm}/localization/{locale}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **locale**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Query** | **useRealmDefaultLocaleFallback**  <br>_optional_ |     | boolean |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Map](#_map) |

##### Produces

*   `application/json`
    

#### DELETE /{realm}/localization/{locale}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **locale**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### GET /{realm}/localization/{locale}/{key}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **key**  <br>_required_ |     | string |
| **Path** | **locale**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | string |

##### Produces

*   `text/plain`
    

#### PUT /{realm}/localization/{locale}/{key}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **key**  <br>_required_ |     | string |
| **Path** | **locale**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **text**  <br>_required_ |     | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `text/plain`
    

#### DELETE /{realm}/localization/{locale}/{key}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **key**  <br>_required_ |     | string |
| **Path** | **locale**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Removes all user sessions.

POST /{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 | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [GlobalRequestResult](#_globalrequestresult) |

##### Produces

*   `application/json`
    

#### Partial export of existing realm into a JSON file.

POST /{realm}/partial-export

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Query** | **exportClients**  <br>_optional_ |     | boolean |
| **Query** | **exportGroupsAndRoles**  <br>_optional_ |     | boolean |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Produces

*   `application/json`
    

#### Partial import from a JSON file to an existing realm.

POST /{realm}/partialImport

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **requestBody**  <br>_required_ |     | [InputStream](#_inputstream) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

##### Produces

*   `application/json`
    

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

POST /{realm}/push-revocation

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [GlobalRequestResult](#_globalrequestresult) |

##### Produces

*   `application/json`
    

#### Remove a specific user session.

DELETE /{realm}/sessions/{session}

##### Description

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **session**  <br>_required_ |     | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### POST /{realm}/testSMTPConnection

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **settings**  <br>_required_ |     | [Map](#_map) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### GET /{realm}/users-management-permissions

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [ManagementPermissionReference](#_managementpermissionreference) |

##### Produces

*   `application/json`
    

#### PUT /{realm}/users-management-permissions

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **ref**  <br>_required_ |     | [ManagementPermissionReference](#_managementpermissionreference) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [ManagementPermissionReference](#_managementpermissionreference) |

##### Consumes

*   `application/json`
    

##### Produces

*   `application/json`
    

### Role Mapper

#### Get role mappings

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [MappingsRepresentation](#_mappingsrepresentation) |

##### Produces

*   `application/json`
    

#### Add realm-level role mappings to the user

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **roles**  <br>_required_ | Roles to add | < [RoleRepresentation](#_rolerepresentation) > array |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

#### Get realm-level role mappings

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Delete realm-level role mappings

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **roles**  <br>_required_ |     | < [RoleRepresentation](#_rolerepresentation) > array |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

#### Get realm-level roles that can be mapped

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Get effective realm-level role mappings This will recurse all composite roles to get the result.

GET /{realm}/groups/{id}/role-mappings/realm/composite

##### Parameters

    
| Type | Name | Description | Schema | Default |
| --- | --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ |     | string |     |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |     |
| **Query** | **briefRepresentation**  <br>_optional_ | if false, return roles with their attributes | boolean | `"true"` |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Get role mappings

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [MappingsRepresentation](#_mappingsrepresentation) |

##### Produces

*   `application/json`
    

#### Add realm-level role mappings to the user

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **roles**  <br>_required_ | Roles to add | < [RoleRepresentation](#_rolerepresentation) > array |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

#### Get realm-level role mappings

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Delete realm-level role mappings

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **roles**  <br>_required_ |     | < [RoleRepresentation](#_rolerepresentation) > array |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

#### Get realm-level roles that can be mapped

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Get effective realm-level role mappings This will recurse all composite roles to get the result.

GET /{realm}/users/{id}/role-mappings/realm/composite

##### Parameters

    
| Type | Name | Description | Schema | Default |
| --- | --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | User id | string |     |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |     |
| **Query** | **briefRepresentation**  <br>_optional_ | if false, return roles with their attributes | boolean | `"true"` |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

### Roles

#### Create a new role for the realm or client

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **rep**  <br>_required_ |     | [RoleRepresentation](#_rolerepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### Get all roles for the realm or client

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

##### Parameters

    
| Type | Name | Description | Schema | Default |
| --- | --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |     |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |     |
| **Query** | **briefRepresentation**  <br>_optional_ |     | boolean | `"true"` |
| **Query** | **first**  <br>_optional_ |     | integer(int32) |     |
| **Query** | **max**  <br>_optional_ |     | integer(int32) |     |
| **Query** | **search**  <br>_optional_ |     | string | `""` |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Get a role by name

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-name**  <br>_required_ | role’s name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [RoleRepresentation](#_rolerepresentation) |

##### Produces

*   `application/json`
    

#### Update a role by name

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-name**  <br>_required_ | role’s name (not id!) | string |
| **Body** | **rep**  <br>_required_ |     | [RoleRepresentation](#_rolerepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### Delete a role by name

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-name**  <br>_required_ | role’s name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Add a composite to the role

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-name**  <br>_required_ | role’s name (not id!) | string |
| **Body** | **roles**  <br>_required_ |     | < [RoleRepresentation](#_rolerepresentation) > array |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

#### Get composites of the role

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-name**  <br>_required_ | role’s name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Remove roles from the role’s composite

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-name**  <br>_required_ | role’s name (not id!) | string |
| **Body** | **roles**  <br>_required_ | roles to remove | < [RoleRepresentation](#_rolerepresentation) > array |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

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

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **clientUuid**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-name**  <br>_required_ | role’s name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Get realm-level roles of the role’s composite

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-name**  <br>_required_ | role’s name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Returns a stream of groups that have the specified role name

GET /{realm}/clients/{id}/roles/{role-name}/groups

##### Parameters

    
| Type | Name | Description | Schema | Default |
| --- | --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |     |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |     |
| **Path** | **role-name**  <br>_required_ | the role name. | string |     |
| **Query** | **briefRepresentation**  <br>_optional_ | if false, return a full representation of the {@code GroupRepresentation} objects. | boolean | `"true"` |
| **Query** | **first**  <br>_optional_ | first result to return. Ignored if negative or {@code null}. | integer(int32) |     |
| **Query** | **max**  <br>_optional_ | maximum number of results to return. Ignored if negative or {@code null}. | integer(int32) |     |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Return object stating whether role Authorization permissions have been initialized or not and a reference

GET /{realm}/clients/{id}/roles/{role-name}/management/permissions

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-name**  <br>_required_ |     | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [ManagementPermissionReference](#_managementpermissionreference) |

##### Produces

*   `application/json`
    

#### Return object stating whether role Authorization permissions have been initialized or not and a reference

PUT /{realm}/clients/{id}/roles/{role-name}/management/permissions

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-name**  <br>_required_ |     | string |
| **Body** | **ref**  <br>_required_ |     | [ManagementPermissionReference](#_managementpermissionreference) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [ManagementPermissionReference](#_managementpermissionreference) |

##### Consumes

*   `application/json`
    

##### Produces

*   `application/json`
    

#### Returns a stream of users that have the specified role name.

GET /{realm}/clients/{id}/roles/{role-name}/users

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-name**  <br>_required_ | the role name. | string |
| **Query** | **first**  <br>_optional_ | first result to return. Ignored if negative or {@code null}. | integer(int32) |
| **Query** | **max**  <br>_optional_ | maximum number of results to return. Ignored if negative or {@code null}. | integer(int32) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Create a new role for the realm or client

POST /{realm}/roles

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **rep**  <br>_required_ |     | [RoleRepresentation](#_rolerepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### Get all roles for the realm or client

GET /{realm}/roles

##### Parameters

    
| Type | Name | Description | Schema | Default |
| --- | --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |     |
| **Query** | **briefRepresentation**  <br>_optional_ |     | boolean | `"true"` |
| **Query** | **first**  <br>_optional_ |     | integer(int32) |     |
| **Query** | **max**  <br>_optional_ |     | integer(int32) |     |
| **Query** | **search**  <br>_optional_ |     | string | `""` |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Get a role by name

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-name**  <br>_required_ | role’s name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [RoleRepresentation](#_rolerepresentation) |

##### Produces

*   `application/json`
    

#### Update a role by name

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-name**  <br>_required_ | role’s name (not id!) | string |
| **Body** | **rep**  <br>_required_ |     | [RoleRepresentation](#_rolerepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### Delete a role by name

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-name**  <br>_required_ | role’s name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Add a composite to the role

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-name**  <br>_required_ | role’s name (not id!) | string |
| **Body** | **roles**  <br>_required_ |     | < [RoleRepresentation](#_rolerepresentation) > array |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

#### Get composites of the role

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-name**  <br>_required_ | role’s name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Remove roles from the role’s composite

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-name**  <br>_required_ | role’s name (not id!) | string |
| **Body** | **roles**  <br>_required_ | roles to remove | < [RoleRepresentation](#_rolerepresentation) > array |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

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

GET /{realm}/roles/{role-name}/composites/clients/{clientUuid}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **clientUuid**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-name**  <br>_required_ | role’s name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Get realm-level roles of the role’s composite

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-name**  <br>_required_ | role’s name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Returns a stream of groups that have the specified role name

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

##### Parameters

    
| Type | Name | Description | Schema | Default |
| --- | --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |     |
| **Path** | **role-name**  <br>_required_ | the role name. | string |     |
| **Query** | **briefRepresentation**  <br>_optional_ | if false, return a full representation of the {@code GroupRepresentation} objects. | boolean | `"true"` |
| **Query** | **first**  <br>_optional_ | first result to return. Ignored if negative or {@code null}. | integer(int32) |     |
| **Query** | **max**  <br>_optional_ | maximum number of results to return. Ignored if negative or {@code null}. | integer(int32) |     |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Return object stating whether role Authorization permissions have been initialized or not and a reference

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-name**  <br>_required_ |     | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [ManagementPermissionReference](#_managementpermissionreference) |

##### Produces

*   `application/json`
    

#### Return object stating whether role Authorization permissions have been initialized or not and a reference

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-name**  <br>_required_ |     | string |
| **Body** | **ref**  <br>_required_ |     | [ManagementPermissionReference](#_managementpermissionreference) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [ManagementPermissionReference](#_managementpermissionreference) |

##### Consumes

*   `application/json`
    

##### Produces

*   `application/json`
    

#### Returns a stream of users that have the specified role name.

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-name**  <br>_required_ | the role name. | string |
| **Query** | **first**  <br>_optional_ | first result to return. Ignored if negative or {@code null}. | integer(int32) |
| **Query** | **max**  <br>_optional_ | maximum number of results to return. Ignored if negative or {@code null}. | integer(int32) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

### Roles (by ID)

#### Get a specific role’s representation

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-id**  <br>_required_ | id of role | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [RoleRepresentation](#_rolerepresentation) |

##### Produces

*   `application/json`
    

#### Update the role

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-id**  <br>_required_ | id of role | string |
| **Body** | **rep**  <br>_required_ |     | [RoleRepresentation](#_rolerepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

#### Delete the role

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-id**  <br>_required_ | id of role | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Make the role a composite role by associating some child roles

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-id**  <br>_required_ |     | string |
| **Body** | **roles**  <br>_required_ |     | < [RoleRepresentation](#_rolerepresentation) > array |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

#### Get role’s children Returns a set of role’s children provided the role is a composite.

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-id**  <br>_required_ |     | string |
| **Query** | **first**  <br>_optional_ |     | integer(int32) |
| **Query** | **max**  <br>_optional_ |     | integer(int32) |
| **Query** | **search**  <br>_optional_ |     | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Remove a set of roles from the role’s composite

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-id**  <br>_required_ | Role id | string |
| **Body** | **roles**  <br>_required_ | A set of roles to be removed | < [RoleRepresentation](#_rolerepresentation) > array |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

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

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **clientUuid**  <br>_required_ |     | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-id**  <br>_required_ |     | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

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

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-id**  <br>_required_ |     | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Return object stating whether role Authoirzation permissions have been initialized or not and a reference

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-id**  <br>_required_ |     | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [ManagementPermissionReference](#_managementpermissionreference) |

##### Produces

*   `application/json`
    

#### Return object stating whether role Authoirzation permissions have been initialized or not and a reference

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Path** | **role-id**  <br>_required_ |     | string |
| **Body** | **ref**  <br>_required_ |     | [ManagementPermissionReference](#_managementpermissionreference) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [ManagementPermissionReference](#_managementpermissionreference) |

##### Consumes

*   `application/json`
    

##### Produces

*   `application/json`
    

### Scope Mappings

#### Add client-level roles to the client’s scope

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **client**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ | id of client scope (not name) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **roles**  <br>_required_ |     | < [RoleRepresentation](#_rolerepresentation) > array |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

#### Get the roles associated with a client’s scope Returns roles for the client.

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **client**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ | id of client scope (not name) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

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

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **client**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ | id of client scope (not name) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **roles**  <br>_required_ |     | < [RoleRepresentation](#_rolerepresentation) > array |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

#### The available client-level roles Returns the roles for the client that can be associated with the client’s scope

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **client**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ | id of client scope (not name) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Get effective client roles Returns the roles for the client that are associated with the client’s scope.

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

##### Parameters

    
| Type | Name | Description | Schema | Default |
| --- | --- | --- | --- | --- |
| **Path** | **client**  <br>_required_ |     | string |     |
| **Path** | **id**  <br>_required_ | id of client scope (not name) | string |     |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |     |
| **Query** | **briefRepresentation**  <br>_optional_ | if false, return roles with their attributes | boolean | `"true"` |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

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

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client scope (not name) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **roles**  <br>_required_ |     | < [RoleRepresentation](#_rolerepresentation) > array |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

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

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client scope (not name) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

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

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client scope (not name) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **roles**  <br>_required_ |     | < [RoleRepresentation](#_rolerepresentation) > array |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

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

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client scope (not name) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### 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 /{realm}/client-scopes/{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 | Schema | Default |
| --- | --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client scope (not name) | string |     |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |     |
| **Query** | **briefRepresentation**  <br>_optional_ | if false, return roles with their attributes | boolean | `"true"` |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Add client-level roles to the client’s scope

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **client**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **roles**  <br>_required_ |     | < [RoleRepresentation](#_rolerepresentation) > array |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

#### Get the roles associated with a client’s scope Returns roles for the client.

GET /{realm}/clients/{id}/scope-mappings/clients/{client}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **client**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

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

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **client**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **roles**  <br>_required_ |     | < [RoleRepresentation](#_rolerepresentation) > array |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

#### The available client-level roles Returns the roles for the client that can be associated with the client’s scope

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **client**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Get effective client roles Returns the roles for the client that are associated with the client’s scope.

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

##### Parameters

    
| Type | Name | Description | Schema | Default |
| --- | --- | --- | --- | --- |
| **Path** | **client**  <br>_required_ |     | string |     |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |     |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |     |
| **Query** | **briefRepresentation**  <br>_optional_ | if false, return roles with their attributes | boolean | `"true"` |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

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

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **roles**  <br>_required_ |     | < [RoleRepresentation](#_rolerepresentation) > array |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

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

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

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

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **roles**  <br>_required_ |     | < [RoleRepresentation](#_rolerepresentation) > array |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

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

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### 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 /{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 | Schema | Default |
| --- | --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | id of client (not client-id) | string |     |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |     |
| **Query** | **briefRepresentation**  <br>_optional_ | if false, return roles with their attributes | boolean | `"true"` |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

### Users

#### Create a new user Username must be unique.

POST /{realm}/users

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **rep**  <br>_required_ |     | [UserRepresentation](#_userrepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### Get users Returns a stream of users, filtered according to query parameters.

GET /{realm}/users

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Query** | **briefRepresentation**  <br>_optional_ | Boolean which defines whether brief representations are returned (default: false) | boolean |
| **Query** | **email**  <br>_optional_ | A String contained in email, or the complete email, if param "exact" is true | string |
| **Query** | **emailVerified**  <br>_optional_ | whether the email has been verified | boolean |
| **Query** | **enabled**  <br>_optional_ | Boolean representing if user is enabled or not | boolean |
| **Query** | **exact**  <br>_optional_ | Boolean which defines whether the params "last", "first", "email" and "username" must match exactly | boolean |
| **Query** | **first**  <br>_optional_ | Pagination offset | integer(int32) |
| **Query** | **firstName**  <br>_optional_ | A String contained in firstName, or the complete firstName, if param "exact" is true | string |
| **Query** | **idpAlias**  <br>_optional_ | The alias of an Identity Provider linked to the user | string |
| **Query** | **idpUserId**  <br>_optional_ | The userId at an Identity Provider linked to the user | string |
| **Query** | **lastName**  <br>_optional_ | A String contained in lastName, or the complete lastName, if param "exact" is true | string |
| **Query** | **max**  <br>_optional_ | Maximum results size (defaults to 100) | integer(int32) |
| **Query** | **q**  <br>_optional_ | A query to search for custom attributes, in the format 'key1:value2 key2:value2' | string |
| **Query** | **search**  <br>_optional_ | A String contained in username, first or last name, or email | string |
| **Query** | **username**  <br>_optional_ | A String contained in username, or the complete username, if param "exact" is true | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Returns the number of users that match the given criteria.

GET /{realm}/users/count

##### Description

It can be called in three different ways. 1. Don’t specify any criteria and pass {@code null}. The number of all users within that realm will be returned. <p> 2. If {@code search} is specified other criteria such as {@code last} will be ignored even though you set them. The {@code search} string will be matched against the first and last name, the username and the email of a user. <p> 3. If {@code search} is unspecified but any of {@code last}, {@code first}, {@code email} or {@code username} those criteria are matched against their respective fields on a user entity. Combined with a logical and.

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Query** | **email**  <br>_optional_ | email filter | string |
| **Query** | **emailVerified**  <br>_optional_ |     | boolean |
| **Query** | **enabled**  <br>_optional_ | Boolean representing if user is enabled or not | boolean |
| **Query** | **firstName**  <br>_optional_ | first name filter | string |
| **Query** | **lastName**  <br>_optional_ | last name filter | string |
| **Query** | **search**  <br>_optional_ | arbitrary search string for all the fields below | string |
| **Query** | **username**  <br>_optional_ | username filter | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | integer(int32) |

##### Produces

*   `application/json`
    

#### GET /{realm}/users/profile

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | string |

##### Produces

*   `application/json`
    

#### PUT /{realm}/users/profile

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **text**  <br>_required_ |     | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### Get representation of the user

GET /{realm}/users/{id}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [UserRepresentation](#_userrepresentation) |

##### Produces

*   `application/json`
    

#### Update the user

PUT /{realm}/users/{id}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **rep**  <br>_required_ |     | [UserRepresentation](#_userrepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### Delete the user

DELETE /{realm}/users/{id}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

#### Return credential types, which are provided by the user storage where user is stored.

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

##### Description

Returned values can contain for example "password", "otp" etc. This will always return empty list for "local" users, which are not backed by any user storage

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Get consents granted by the user

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Revoke consent and offline tokens for particular client from user

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **client**  <br>_required_ | Client id | string |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### GET /{realm}/users/{id}/credentials

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Remove a credential for a user

DELETE /{realm}/users/{id}/credentials/{credentialId}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **credentialId**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Move a credential to a position behind another credential

POST /{realm}/users/{id}/credentials/{credentialId}/moveAfter/{newPreviousCredentialId}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **credentialId**  <br>_required_ | The credential to move | string |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **newPreviousCredentialId**  <br>_required_ | The credential that will be the previous element in the list. If set to null, the moved credential will be the first element in the list. | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Move a credential to a first position in the credentials list of the user

POST /{realm}/users/{id}/credentials/{credentialId}/moveToFirst

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **credentialId**  <br>_required_ | The credential to move | string |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Update a credential label for a user

PUT /{realm}/users/{id}/credentials/{credentialId}/userLabel

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **credentialId**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **userLabel**  <br>_required_ |     | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `text/plain`
    

#### Disable all credentials for a user of a specific type

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **credentialTypes**  <br>_required_ |     | < string > array |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

#### Send an email to the user with a link they can click to execute particular actions.

PUT /{realm}/users/{id}/execute-actions-email

##### Description

An email contains a link the user can click to perform a set of required actions. 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 | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Query** | **client\_id**  <br>_optional_ | Client id | string |
| **Query** | **lifespan**  <br>_optional_ | Number of seconds after which the generated token expires | integer(int32) |
| **Query** | **redirect\_uri**  <br>_optional_ | Redirect uri | string |
| **Body** | **actions**  <br>_required_ | Required actions the user needs to complete | < string > array |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### Get social logins associated with the user

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Add a social login provider to the user

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **provider**  <br>_required_ | Social login provider id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **rep**  <br>_required_ |     | [FederatedIdentityRepresentation](#_federatedidentityrepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

#### Remove a social login provider from user

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **provider**  <br>_required_ | Social login provider id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### GET /{realm}/users/{id}/groups

##### Parameters

    
| Type | Name | Description | Schema | Default |
| --- | --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | User id | string |     |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |     |
| **Query** | **briefRepresentation**  <br>_optional_ |     | boolean | `"true"` |
| **Query** | **first**  <br>_optional_ |     | integer(int32) |     |
| **Query** | **max**  <br>_optional_ |     | integer(int32) |     |
| **Query** | **search**  <br>_optional_ |     | string |     |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### GET /{realm}/users/{id}/groups/count

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Query** | **search**  <br>_optional_ |     | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Map](#_map) |

##### Produces

*   `application/json`
    

#### PUT /{realm}/users/{id}/groups/{groupId}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **groupId**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### DELETE /{realm}/users/{id}/groups/{groupId}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **groupId**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Impersonate the user

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Map](#_map) |

##### Produces

*   `application/json`
    

#### 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 /{realm}/users/{id}/logout

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

#### Get offline sessions associated with the user and client

GET /{realm}/users/{id}/offline-sessions/{clientUuid}

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **clientUuid**  <br>_required_ |     | string |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

#### Set up a new password for the user.

PUT /{realm}/users/{id}/reset-password

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Body** | **cred**  <br>_required_ | The representation must contain a rawPassword with the plain-text password | [CredentialRepresentation](#_credentialrepresentation) |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | No Content |

##### Consumes

*   `application/json`
    

#### Send an email-verification email to the user An email contains a link the user can click to verify their email address.

PUT /{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 | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |
| **Query** | **client\_id**  <br>_optional_ | Client id | string |
| **Query** | **redirect\_uri**  <br>_optional_ | Redirect uri | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

##### Consumes

*   `application/json`
    

#### Get sessions associated with the user

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

##### Parameters

   
| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **id**  <br>_required_ | User id | string |
| **Path** | **realm**  <br>_required_ | realm name (not id!) | string |

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Stream](#_stream) |

##### Produces

*   `application/json`
    

### Admin

#### OPTIONS /admin/{any}

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Object](#_object) |

### Root

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

GET /

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [ServerInfoRepresentation](#_serverinforepresentation) |

##### Produces

*   `application/json`
    

#### CORS preflight

OPTIONS /{any}

##### Responses

  
| HTTP Code | Description | Schema |
| --- | --- | --- |
| **default** | success | [Response](#_response) |

## Definitions

### AccessToken

 
| Name | Schema |
| --- | --- |
| **acr**  <br>_optional_ | string |
| **address**  <br>_optional_ | [AddressClaimSet](#_addressclaimset) |
| **allowed-origins**  <br>_optional_ | < string > array |
| **at\_hash**  <br>_optional_ | string |
| **auth\_time**  <br>_optional_ | integer(int64) |
| **authorization**  <br>_optional_ | [AccessToken-Authorization](#_accesstoken-authorization) |
| **azp**  <br>_optional_ | string |
| **birthdate**  <br>_optional_ | string |
| **c\_hash**  <br>_optional_ | string |
| **category**  <br>_optional_ | enum (INTERNAL, ACCESS, ID, ADMIN, USERINFO, LOGOUT, AUTHORIZATION\_RESPONSE) |
| **claims\_locales**  <br>_optional_ | string |
| **cnf**  <br>_optional_ | [AccessToken-CertConf](#_accesstoken-certconf) |
| **email**  <br>_optional_ | string |
| **email\_verified**  <br>_optional_ | boolean |
| **exp**  <br>_optional_ | integer(int64) |
| **family\_name**  <br>_optional_ | string |
| **gender**  <br>_optional_ | string |
| **given\_name**  <br>_optional_ | string |
| **iat**  <br>_optional_ | integer(int64) |
| **iss**  <br>_optional_ | string |
| **jti**  <br>_optional_ | string |
| **locale**  <br>_optional_ | string |
| **middle\_name**  <br>_optional_ | string |
| **name**  <br>_optional_ | string |
| **nbf**  <br>_optional_ | integer(int64) |
| **nickname**  <br>_optional_ | string |
| **nonce**  <br>_optional_ | string |
| **otherClaims**  <br>_optional_ | [Map](#_map) |
| **phone\_number**  <br>_optional_ | string |
| **phone\_number\_verified**  <br>_optional_ | boolean |
| **picture**  <br>_optional_ | string |
| **preferred\_username**  <br>_optional_ | string |
| **profile**  <br>_optional_ | string |
| **realm\_access**  <br>_optional_ | [AccessToken-Access](#_accesstoken-access) |
| **s\_hash**  <br>_optional_ | string |
| **scope**  <br>_optional_ | string |
| **session\_state**  <br>_optional_ | string |
| **sid**  <br>_optional_ | string |
| **sub**  <br>_optional_ | string |
| **trusted-certs**  <br>_optional_ | < string > array |
| **typ**  <br>_optional_ | string |
| **updated\_at**  <br>_optional_ | integer(int64) |
| **website**  <br>_optional_ | string |
| **zoneinfo**  <br>_optional_ | string |

### AccessToken-Access

 
| Name | Schema |
| --- | --- |
| **roles**  <br>_optional_ | < string > array |
| **verify\_caller**  <br>_optional_ | boolean |

### AccessToken-Authorization

 
| Name | Schema |
| --- | --- |
| **permissions**  <br>_optional_ | < [Permission](#_permission) > array |

### AccessToken-CertConf

 
| Name | Schema |
| --- | --- |
| **x5t#S256**  <br>_optional_ | string |

### AddressClaimSet

 
| Name | Schema |
| --- | --- |
| **country**  <br>_optional_ | string |
| **formatted**  <br>_optional_ | string |
| **locality**  <br>_optional_ | string |
| **postal\_code**  <br>_optional_ | string |
| **region**  <br>_optional_ | string |
| **street\_address**  <br>_optional_ | string |

### AuthenticationExecutionExportRepresentation

 
| Name | Schema |
| --- | --- |
| **authenticator**  <br>_optional_ | string |
| **authenticatorConfig**  <br>_optional_ | string |
| **authenticatorFlow**  <br>_optional_ | boolean |
| **flowAlias**  <br>_optional_ | string |
| **priority**  <br>_optional_ | integer(int32) |
| **requirement**  <br>_optional_ | string |
| **userSetupAllowed**  <br>_optional_ | boolean |

### AuthenticationExecutionInfoRepresentation

 
| Name | Schema |
| --- | --- |
| **alias**  <br>_optional_ | string |
| **authenticationConfig**  <br>_optional_ | string |
| **authenticationFlow**  <br>_optional_ | boolean |
| **configurable**  <br>_optional_ | boolean |
| **description**  <br>_optional_ | string |
| **displayName**  <br>_optional_ | string |
| **flowId**  <br>_optional_ | string |
| **id**  <br>_optional_ | string |
| **index**  <br>_optional_ | integer(int32) |
| **level**  <br>_optional_ | integer(int32) |
| **providerId**  <br>_optional_ | string |
| **requirement**  <br>_optional_ | string |
| **requirementChoices**  <br>_optional_ | < string > array |

### AuthenticationExecutionRepresentation

 
| Name | Schema |
| --- | --- |
| **authenticator**  <br>_optional_ | string |
| **authenticatorConfig**  <br>_optional_ | string |
| **authenticatorFlow**  <br>_optional_ | boolean |
| **flowId**  <br>_optional_ | string |
| **id**  <br>_optional_ | string |
| **parentFlow**  <br>_optional_ | string |
| **priority**  <br>_optional_ | integer(int32) |
| **requirement**  <br>_optional_ | string |

### AuthenticationFlowRepresentation

 
| Name | Schema |
| --- | --- |
| **alias**  <br>_optional_ | string |
| **authenticationExecutions**  <br>_optional_ | < [AuthenticationExecutionExportRepresentation](#_authenticationexecutionexportrepresentation) > array |
| **builtIn**  <br>_optional_ | boolean |
| **description**  <br>_optional_ | string |
| **id**  <br>_optional_ | string |
| **providerId**  <br>_optional_ | string |
| **topLevel**  <br>_optional_ | boolean |

### AuthenticatorConfigInfoRepresentation

 
| Name | Schema |
| --- | --- |
| **helpText**  <br>_optional_ | string |
| **name**  <br>_optional_ | string |
| **properties**  <br>_optional_ | < [ConfigPropertyRepresentation](#_configpropertyrepresentation) > array |
| **providerId**  <br>_optional_ | string |

### AuthenticatorConfigRepresentation

 
| Name | Schema |
| --- | --- |
| **alias**  <br>_optional_ | string |
| **config**  <br>_optional_ | [Map](#_map) |
| **id**  <br>_optional_ | string |

### CertificateRepresentation

 
| Name | Schema |
| --- | --- |
| **certificate**  <br>_optional_ | string |
| **kid**  <br>_optional_ | string |
| **privateKey**  <br>_optional_ | string |
| **publicKey**  <br>_optional_ | string |

### ClientInitialAccessCreatePresentation

 
| Name | Schema |
| --- | --- |
| **count**  <br>_optional_ | integer(int32) |
| **expiration**  <br>_optional_ | integer(int32) |

### ClientInitialAccessPresentation

 
| Name | Schema |
| --- | --- |
| **count**  <br>_optional_ | integer(int32) |
| **expiration**  <br>_optional_ | integer(int32) |
| **id**  <br>_optional_ | string |
| **remainingCount**  <br>_optional_ | integer(int32) |
| **timestamp**  <br>_optional_ | integer(int32) |
| **token**  <br>_optional_ | string |

### ClientMappingsRepresentation

 
| Name | Schema |
| --- | --- |
| **client**  <br>_optional_ | string |
| **id**  <br>_optional_ | string |
| **mappings**  <br>_optional_ | < [RoleRepresentation](#_rolerepresentation) > array |

### ClientPoliciesRepresentation

 
| Name | Schema |
| --- | --- |
| **policies**  <br>_optional_ | < [ClientPolicyRepresentation](#_clientpolicyrepresentation) > array |

### ClientPolicyConditionRepresentation

 
| Name | Schema |
| --- | --- |
| **condition**  <br>_optional_ | string |
| **configuration**  <br>_optional_ | [JsonNode](#_jsonnode) |

### ClientPolicyExecutorRepresentation

 
| Name | Schema |
| --- | --- |
| **configuration**  <br>_optional_ | [JsonNode](#_jsonnode) |
| **executor**  <br>_optional_ | string |

### ClientPolicyRepresentation

 
| Name | Schema |
| --- | --- |
| **conditions**  <br>_optional_ | < [ClientPolicyConditionRepresentation](#_clientpolicyconditionrepresentation) > array |
| **description**  <br>_optional_ | string |
| **enabled**  <br>_optional_ | boolean |
| **name**  <br>_optional_ | string |
| **profiles**  <br>_optional_ | < string > array |

### ClientProfileRepresentation

 
| Name | Schema |
| --- | --- |
| **description**  <br>_optional_ | string |
| **executors**  <br>_optional_ | < [ClientPolicyExecutorRepresentation](#_clientpolicyexecutorrepresentation) > array |
| **name**  <br>_optional_ | string |

### ClientProfilesRepresentation

 
| Name | Schema |
| --- | --- |
| **globalProfiles**  <br>_optional_ | < [ClientProfileRepresentation](#_clientprofilerepresentation) > array |
| **profiles**  <br>_optional_ | < [ClientProfileRepresentation](#_clientprofilerepresentation) > array |

### ClientRepresentation

 
| Name | Schema |
| --- | --- |
| **access**  <br>_optional_ | [Map](#_map) |
| **adminUrl**  <br>_optional_ | string |
| **alwaysDisplayInConsole**  <br>_optional_ | boolean |
| **attributes**  <br>_optional_ | [Map](#_map) |
| **authenticationFlowBindingOverrides**  <br>_optional_ | [Map](#_map) |
| **authorizationServicesEnabled**  <br>_optional_ | boolean |
| **authorizationSettings**  <br>_optional_ | [ResourceServerRepresentation](#_resourceserverrepresentation) |
| **baseUrl**  <br>_optional_ | string |
| **bearerOnly**  <br>_optional_ | boolean |
| **clientAuthenticatorType**  <br>_optional_ | string |
| **clientId**  <br>_optional_ | string |
| **consentRequired**  <br>_optional_ | boolean |
| **defaultClientScopes**  <br>_optional_ | < string > array |
| **description**  <br>_optional_ | string |
| **directAccessGrantsEnabled**  <br>_optional_ | boolean |
| **enabled**  <br>_optional_ | boolean |
| **frontchannelLogout**  <br>_optional_ | boolean |
| **fullScopeAllowed**  <br>_optional_ | boolean |
| **id**  <br>_optional_ | string |
| **implicitFlowEnabled**  <br>_optional_ | boolean |
| **name**  <br>_optional_ | string |
| **nodeReRegistrationTimeout**  <br>_optional_ | integer(int32) |
| **notBefore**  <br>_optional_ | integer(int32) |
| **oauth2DeviceAuthorizationGrantEnabled**  <br>_optional_ | boolean |
| **optionalClientScopes**  <br>_optional_ | < string > array |
| **origin**  <br>_optional_ | string |
| **protocol**  <br>_optional_ | string |
| **protocolMappers**  <br>_optional_ | < [ProtocolMapperRepresentation](#_protocolmapperrepresentation) > array |
| **publicClient**  <br>_optional_ | boolean |
| **redirectUris**  <br>_optional_ | < string > array |
| **registeredNodes**  <br>_optional_ | [Map](#_map) |
| **registrationAccessToken**  <br>_optional_ | string |
| **rootUrl**  <br>_optional_ | string |
| **secret**  <br>_optional_ | string |
| **serviceAccountsEnabled**  <br>_optional_ | boolean |
| **standardFlowEnabled**  <br>_optional_ | boolean |
| **surrogateAuthRequired**  <br>_optional_ | boolean |
| **webOrigins**  <br>_optional_ | < string > array |

### ClientScopeEvaluateResource-ProtocolMapperEvaluationRepresentation

 
| Name | Schema |
| --- | --- |
| **containerId**  <br>_optional_ | string |
| **containerName**  <br>_optional_ | string |
| **containerType**  <br>_optional_ | string |
| **mapperId**  <br>_optional_ | string |
| **mapperName**  <br>_optional_ | string |
| **protocolMapper**  <br>_optional_ | string |

### ClientScopeRepresentation

 
| Name | Schema |
| --- | --- |
| **attributes**  <br>_optional_ | [Map](#_map) |
| **description**  <br>_optional_ | string |
| **id**  <br>_optional_ | string |
| **name**  <br>_optional_ | string |
| **protocol**  <br>_optional_ | string |
| **protocolMappers**  <br>_optional_ | < [ProtocolMapperRepresentation](#_protocolmapperrepresentation) > array |

### ComponentExportRepresentation

 
| Name | Schema |
| --- | --- |
| **config**  <br>_optional_ | [MultivaluedHashMap](#_multivaluedhashmap) |
| **id**  <br>_optional_ | string |
| **name**  <br>_optional_ | string |
| **providerId**  <br>_optional_ | string |
| **subComponents**  <br>_optional_ | [MultivaluedHashMap](#_multivaluedhashmap) |
| **subType**  <br>_optional_ | string |

### ComponentRepresentation

 
| Name | Schema |
| --- | --- |
| **config**  <br>_optional_ | [MultivaluedHashMap](#_multivaluedhashmap) |
| **id**  <br>_optional_ | string |
| **name**  <br>_optional_ | string |
| **parentId**  <br>_optional_ | string |
| **providerId**  <br>_optional_ | string |
| **providerType**  <br>_optional_ | string |
| **subType**  <br>_optional_ | string |

### ConfigPropertyRepresentation

 
| Name | Schema |
| --- | --- |
| **defaultValue**  <br>_optional_ | [Object](#_object) |
| **helpText**  <br>_optional_ | string |
| **label**  <br>_optional_ | string |
| **name**  <br>_optional_ | string |
| **options**  <br>_optional_ | < string > array |
| **readOnly**  <br>_optional_ | boolean |
| **secret**  <br>_optional_ | boolean |
| **type**  <br>_optional_ | string |

### CredentialRepresentation

 
| Name | Schema |
| --- | --- |
| **createdDate**  <br>_optional_ | integer(int64) |
| **credentialData**  <br>_optional_ | string |
| **id**  <br>_optional_ | string |
| **priority**  <br>_optional_ | integer(int32) |
| **secretData**  <br>_optional_ | string |
| **temporary**  <br>_optional_ | boolean |
| **type**  <br>_optional_ | string |
| **userLabel**  <br>_optional_ | string |
| **value**  <br>_optional_ | string |

### CryptoInfoRepresentation

 
| Name | Schema |
| --- | --- |
| **cryptoProvider**  <br>_optional_ | string |
| **supportedKeystoreTypes**  <br>_optional_ | < string > array |

### FederatedIdentityRepresentation

 
| Name | Schema |
| --- | --- |
| **identityProvider**  <br>_optional_ | string |
| **userId**  <br>_optional_ | string |
| **userName**  <br>_optional_ | string |

### GlobalRequestResult

 
| Name | Schema |
| --- | --- |
| **failedRequests**  <br>_optional_ | < string > array |
| **successRequests**  <br>_optional_ | < string > array |

### GroupRepresentation

 
| Name | Schema |
| --- | --- |
| **access**  <br>_optional_ | [Map](#_map) |
| **attributes**  <br>_optional_ | [Map](#_map) |
| **clientRoles**  <br>_optional_ | [Map](#_map) |
| **id**  <br>_optional_ | string |
| **name**  <br>_optional_ | string |
| **path**  <br>_optional_ | string |
| **realmRoles**  <br>_optional_ | < string > array |
| **subGroups**  <br>_optional_ | < [GroupRepresentation](#_grouprepresentation) > array |

### IDToken

 
| Name | Schema |
| --- | --- |
| **acr**  <br>_optional_ | string |
| **address**  <br>_optional_ | [AddressClaimSet](#_addressclaimset) |
| **at\_hash**  <br>_optional_ | string |
| **auth\_time**  <br>_optional_ | integer(int64) |
| **azp**  <br>_optional_ | string |
| **birthdate**  <br>_optional_ | string |
| **c\_hash**  <br>_optional_ | string |
| **category**  <br>_optional_ | enum (INTERNAL, ACCESS, ID, ADMIN, USERINFO, LOGOUT, AUTHORIZATION\_RESPONSE) |
| **claims\_locales**  <br>_optional_ | string |
| **email**  <br>_optional_ | string |
| **email\_verified**  <br>_optional_ | boolean |
| **exp**  <br>_optional_ | integer(int64) |
| **family\_name**  <br>_optional_ | string |
| **gender**  <br>_optional_ | string |
| **given\_name**  <br>_optional_ | string |
| **iat**  <br>_optional_ | integer(int64) |
| **iss**  <br>_optional_ | string |
| **jti**  <br>_optional_ | string |
| **locale**  <br>_optional_ | string |
| **middle\_name**  <br>_optional_ | string |
| **name**  <br>_optional_ | string |
| **nbf**  <br>_optional_ | integer(int64) |
| **nickname**  <br>_optional_ | string |
| **nonce**  <br>_optional_ | string |
| **otherClaims**  <br>_optional_ | [Map](#_map) |
| **phone\_number**  <br>_optional_ | string |
| **phone\_number\_verified**  <br>_optional_ | boolean |
| **picture**  <br>_optional_ | string |
| **preferred\_username**  <br>_optional_ | string |
| **profile**  <br>_optional_ | string |
| **s\_hash**  <br>_optional_ | string |
| **session\_state**  <br>_optional_ | string |
| **sid**  <br>_optional_ | string |
| **sub**  <br>_optional_ | string |
| **typ**  <br>_optional_ | string |
| **updated\_at**  <br>_optional_ | integer(int64) |
| **website**  <br>_optional_ | string |
| **zoneinfo**  <br>_optional_ | string |

### IdentityProviderMapperRepresentation

 
| Name | Schema |
| --- | --- |
| **config**  <br>_optional_ | [Map](#_map) |
| **id**  <br>_optional_ | string |
| **identityProviderAlias**  <br>_optional_ | string |
| **identityProviderMapper**  <br>_optional_ | string |
| **name**  <br>_optional_ | string |

### IdentityProviderRepresentation

 
| Name | Schema |
| --- | --- |
| **addReadTokenRoleOnCreate**  <br>_optional_ | boolean |
| **alias**  <br>_optional_ | string |
| **config**  <br>_optional_ | [Map](#_map) |
| **displayName**  <br>_optional_ | string |
| **enabled**  <br>_optional_ | boolean |
| **firstBrokerLoginFlowAlias**  <br>_optional_ | string |
| **internalId**  <br>_optional_ | string |
| **linkOnly**  <br>_optional_ | boolean |
| **postBrokerLoginFlowAlias**  <br>_optional_ | string |
| **providerId**  <br>_optional_ | string |
| **storeToken**  <br>_optional_ | boolean |
| **trustEmail**  <br>_optional_ | boolean |

### JsonNode

 
| Name | Schema |
| --- | --- |
| **array**  <br>_optional_ | boolean |
| **bigDecimal**  <br>_optional_ | boolean |
| **bigInteger**  <br>_optional_ | boolean |
| **binary**  <br>_optional_ | boolean |
| **boolean**  <br>_optional_ | boolean |
| **containerNode**  <br>_optional_ | boolean |
| **double**  <br>_optional_ | boolean |
| **empty**  <br>_optional_ | boolean |
| **float**  <br>_optional_ | boolean |
| **floatingPointNumber**  <br>_optional_ | boolean |
| **int**  <br>_optional_ | boolean |
| **integralNumber**  <br>_optional_ | boolean |
| **long**  <br>_optional_ | boolean |
| **missingNode**  <br>_optional_ | boolean |
| **nodeType**  <br>_optional_ | enum (ARRAY, BINARY, BOOLEAN, MISSING, NULL, NUMBER, OBJECT, POJO, STRING) |
| **null**  <br>_optional_ | boolean |
| **number**  <br>_optional_ | boolean |
| **object**  <br>_optional_ | boolean |
| **pojo**  <br>_optional_ | boolean |
| **short**  <br>_optional_ | boolean |
| **textual**  <br>_optional_ | boolean |
| **valueNode**  <br>_optional_ | boolean |

### KeyStoreConfig

 
| Name | Schema |
| --- | --- |
| **format**  <br>_optional_ | string |
| **keyAlias**  <br>_optional_ | string |
| **keyPassword**  <br>_optional_ | string |
| **realmAlias**  <br>_optional_ | string |
| **realmCertificate**  <br>_optional_ | boolean |
| **storePassword**  <br>_optional_ | string |

### KeysMetadataRepresentation

 
| Name | Schema |
| --- | --- |
| **active**  <br>_optional_ | [Map](#_map) |
| **keys**  <br>_optional_ | < [KeysMetadataRepresentation-KeyMetadataRepresentation](#_keysmetadatarepresentation-keymetadatarepresentation) > array |

### KeysMetadataRepresentation-KeyMetadataRepresentation

 
| Name | Schema |
| --- | --- |
| **algorithm**  <br>_optional_ | string |
| **certificate**  <br>_optional_ | string |
| **kid**  <br>_optional_ | string |
| **providerId**  <br>_optional_ | string |
| **providerPriority**  <br>_optional_ | integer(int64) |
| **publicKey**  <br>_optional_ | string |
| **status**  <br>_optional_ | string |
| **type**  <br>_optional_ | string |
| **use**  <br>_optional_ | enum (SIG, ENC) |

### ManagementPermissionReference

 
| Name | Schema |
| --- | --- |
| **enabled**  <br>_optional_ | boolean |
| **resource**  <br>_optional_ | string |
| **scopePermissions**  <br>_optional_ | [Map](#_map) |

### MappingsRepresentation

 
| Name | Schema |
| --- | --- |
| **clientMappings**  <br>_optional_ | [Map](#_map) |
| **realmMappings**  <br>_optional_ | < [RoleRepresentation](#_rolerepresentation) > array |

### MemoryInfoRepresentation

 
| Name | Schema |
| --- | --- |
| **free**  <br>_optional_ | integer(int64) |
| **freeFormated**  <br>_optional_ | string |
| **freePercentage**  <br>_optional_ | integer(int64) |
| **total**  <br>_optional_ | integer(int64) |
| **totalFormated**  <br>_optional_ | string |
| **used**  <br>_optional_ | integer(int64) |
| **usedFormated**  <br>_optional_ | string |

### MultivaluedHashMap

 
| Name | Schema |
| --- | --- |
| **empty**  <br>_optional_ | boolean |
| **loadFactor**  <br>_optional_ | number(float) |
| **threshold**  <br>_optional_ | integer(int32) |

### PasswordPolicyTypeRepresentation

 
| Name | Schema |
| --- | --- |
| **configType**  <br>_optional_ | string |
| **defaultValue**  <br>_optional_ | string |
| **displayName**  <br>_optional_ | string |
| **id**  <br>_optional_ | string |
| **multipleSupported**  <br>_optional_ | boolean |

### Permission

 
| Name | Schema |
| --- | --- |
| **claims**  <br>_optional_ | [Map](#_map) |
| **rsid**  <br>_optional_ | string |
| **rsname**  <br>_optional_ | string |
| **scopes**  <br>_optional_ | < string > array |

### PolicyRepresentation

 
| Name | Schema |
| --- | --- |
| **config**  <br>_optional_ | [Map](#_map) |
| **decisionStrategy**  <br>_optional_ | enum (AFFIRMATIVE, UNANIMOUS, CONSENSUS) |
| **description**  <br>_optional_ | string |
| **id**  <br>_optional_ | string |
| **logic**  <br>_optional_ | enum (POSITIVE, NEGATIVE) |
| **name**  <br>_optional_ | string |
| **owner**  <br>_optional_ | string |
| **policies**  <br>_optional_ | < string > array |
| **resources**  <br>_optional_ | < string > array |
| **resourcesData**  <br>_optional_ | < [ResourceRepresentation](#_resourcerepresentation) > array |
| **scopes**  <br>_optional_ | < string > array |
| **scopesData**  <br>_optional_ | < [ScopeRepresentation](#_scoperepresentation) > array |
| **type**  <br>_optional_ | string |

### ProfileInfoRepresentation

 
| Name | Schema |
| --- | --- |
| **disabledFeatures**  <br>_optional_ | < string > array |
| **experimentalFeatures**  <br>_optional_ | < string > array |
| **name**  <br>_optional_ | string |
| **previewFeatures**  <br>_optional_ | < string > array |

### ProtocolMapperRepresentation

 
| Name | Schema |
| --- | --- |
| **config**  <br>_optional_ | [Map](#_map) |
| **id**  <br>_optional_ | string |
| **name**  <br>_optional_ | string |
| **protocol**  <br>_optional_ | string |
| **protocolMapper**  <br>_optional_ | string |

### ProviderRepresentation

 
| Name | Schema |
| --- | --- |
| **operationalInfo**  <br>_optional_ | [Map](#_map) |
| **order**  <br>_optional_ | integer(int32) |

### RealmEventsConfigRepresentation

 
| Name | Schema |
| --- | --- |
| **adminEventsDetailsEnabled**  <br>_optional_ | boolean |
| **adminEventsEnabled**  <br>_optional_ | boolean |
| **enabledEventTypes**  <br>_optional_ | < string > array |
| **eventsEnabled**  <br>_optional_ | boolean |
| **eventsExpiration**  <br>_optional_ | integer(int64) |
| **eventsListeners**  <br>_optional_ | < string > array |

### RealmRepresentation

 
| Name | Schema |
| --- | --- |
| **accessCodeLifespan**  <br>_optional_ | integer(int32) |
| **accessCodeLifespanLogin**  <br>_optional_ | integer(int32) |
| **accessCodeLifespanUserAction**  <br>_optional_ | integer(int32) |
| **accessTokenLifespan**  <br>_optional_ | integer(int32) |
| **accessTokenLifespanForImplicitFlow**  <br>_optional_ | integer(int32) |
| **accountTheme**  <br>_optional_ | string |
| **actionTokenGeneratedByAdminLifespan**  <br>_optional_ | integer(int32) |
| **actionTokenGeneratedByUserLifespan**  <br>_optional_ | integer(int32) |
| **adminEventsDetailsEnabled**  <br>_optional_ | boolean |
| **adminEventsEnabled**  <br>_optional_ | boolean |
| **adminTheme**  <br>_optional_ | string |
| **attributes**  <br>_optional_ | [Map](#_map) |
| **authenticationFlows**  <br>_optional_ | < [AuthenticationFlowRepresentation](#_authenticationflowrepresentation) > array |
| **authenticatorConfig**  <br>_optional_ | < [AuthenticatorConfigRepresentation](#_authenticatorconfigrepresentation) > array |
| **browserFlow**  <br>_optional_ | string |
| **browserSecurityHeaders**  <br>_optional_ | [Map](#_map) |
| **bruteForceProtected**  <br>_optional_ | boolean |
| **clientAuthenticationFlow**  <br>_optional_ | string |
| **clientOfflineSessionIdleTimeout**  <br>_optional_ | integer(int32) |
| **clientOfflineSessionMaxLifespan**  <br>_optional_ | integer(int32) |
| **clientPolicies**  <br>_optional_ | [JsonNode](#_jsonnode) |
| **clientProfiles**  <br>_optional_ | [JsonNode](#_jsonnode) |
| **clientScopeMappings**  <br>_optional_ | [Map](#_map) |
| **clientScopes**  <br>_optional_ | < [ClientScopeRepresentation](#_clientscoperepresentation) > array |
| **clientSessionIdleTimeout**  <br>_optional_ | integer(int32) |
| **clientSessionMaxLifespan**  <br>_optional_ | integer(int32) |
| **clients**  <br>_optional_ | < [ClientRepresentation](#_clientrepresentation) > array |
| **components**  <br>_optional_ | [MultivaluedHashMap](#_multivaluedhashmap) |
| **defaultDefaultClientScopes**  <br>_optional_ | < string > array |
| **defaultGroups**  <br>_optional_ | < string > array |
| **defaultLocale**  <br>_optional_ | string |
| **defaultOptionalClientScopes**  <br>_optional_ | < string > array |
| **defaultRole**  <br>_optional_ | [RoleRepresentation](#_rolerepresentation) |
| **defaultSignatureAlgorithm**  <br>_optional_ | string |
| **directGrantFlow**  <br>_optional_ | string |
| **displayName**  <br>_optional_ | string |
| **displayNameHtml**  <br>_optional_ | string |
| **dockerAuthenticationFlow**  <br>_optional_ | string |
| **duplicateEmailsAllowed**  <br>_optional_ | boolean |
| **editUsernameAllowed**  <br>_optional_ | boolean |
| **emailTheme**  <br>_optional_ | string |
| **enabled**  <br>_optional_ | boolean |
| **enabledEventTypes**  <br>_optional_ | < string > array |
| **eventsEnabled**  <br>_optional_ | boolean |
| **eventsExpiration**  <br>_optional_ | integer(int64) |
| **eventsListeners**  <br>_optional_ | < string > array |
| **failureFactor**  <br>_optional_ | integer(int32) |
| **federatedUsers**  <br>_optional_ | < [UserRepresentation](#_userrepresentation) > array |
| **groups**  <br>_optional_ | < [GroupRepresentation](#_grouprepresentation) > array |
| **id**  <br>_optional_ | string |
| **identityProviderMappers**  <br>_optional_ | < [IdentityProviderMapperRepresentation](#_identityprovidermapperrepresentation) > array |
| **identityProviders**  <br>_optional_ | < [IdentityProviderRepresentation](#_identityproviderrepresentation) > array |
| **internationalizationEnabled**  <br>_optional_ | boolean |
| **keycloakVersion**  <br>_optional_ | string |
| **loginTheme**  <br>_optional_ | string |
| **loginWithEmailAllowed**  <br>_optional_ | boolean |
| **maxDeltaTimeSeconds**  <br>_optional_ | integer(int32) |
| **maxFailureWaitSeconds**  <br>_optional_ | integer(int32) |
| **minimumQuickLoginWaitSeconds**  <br>_optional_ | integer(int32) |
| **notBefore**  <br>_optional_ | integer(int32) |
| **oAuth2DeviceCodeLifespan**  <br>_optional_ | integer(int32) |
| **oAuth2DevicePollingInterval**  <br>_optional_ | integer(int32) |
| **oauth2DeviceCodeLifespan**  <br>_optional_ | integer(int32) |
| **oauth2DevicePollingInterval**  <br>_optional_ | integer(int32) |
| **offlineSessionIdleTimeout**  <br>_optional_ | integer(int32) |
| **offlineSessionMaxLifespan**  <br>_optional_ | integer(int32) |
| **offlineSessionMaxLifespanEnabled**  <br>_optional_ | boolean |
| **otpPolicyAlgorithm**  <br>_optional_ | string |
| **otpPolicyCodeReusable**  <br>_optional_ | boolean |
| **otpPolicyDigits**  <br>_optional_ | integer(int32) |
| **otpPolicyInitialCounter**  <br>_optional_ | integer(int32) |
| **otpPolicyLookAheadWindow**  <br>_optional_ | integer(int32) |
| **otpPolicyPeriod**  <br>_optional_ | integer(int32) |
| **otpPolicyType**  <br>_optional_ | string |
| **otpSupportedApplications**  <br>_optional_ | < string > array |
| **passwordPolicy**  <br>_optional_ | string |
| **permanentLockout**  <br>_optional_ | boolean |
| **protocolMappers**  <br>_optional_ | < [ProtocolMapperRepresentation](#_protocolmapperrepresentation) > array |
| **quickLoginCheckMilliSeconds**  <br>_optional_ | integer(int64) |
| **realm**  <br>_optional_ | string |
| **refreshTokenMaxReuse**  <br>_optional_ | integer(int32) |
| **registrationAllowed**  <br>_optional_ | boolean |
| **registrationEmailAsUsername**  <br>_optional_ | boolean |
| **registrationFlow**  <br>_optional_ | string |
| **rememberMe**  <br>_optional_ | boolean |
| **requiredActions**  <br>_optional_ | < [RequiredActionProviderRepresentation](#_requiredactionproviderrepresentation) > array |
| **resetCredentialsFlow**  <br>_optional_ | string |
| **resetPasswordAllowed**  <br>_optional_ | boolean |
| **revokeRefreshToken**  <br>_optional_ | boolean |
| **roles**  <br>_optional_ | [RolesRepresentation](#_rolesrepresentation) |
| **scopeMappings**  <br>_optional_ | < [ScopeMappingRepresentation](#_scopemappingrepresentation) > array |
| **smtpServer**  <br>_optional_ | [Map](#_map) |
| **sslRequired**  <br>_optional_ | string |
| **ssoSessionIdleTimeout**  <br>_optional_ | integer(int32) |
| **ssoSessionIdleTimeoutRememberMe**  <br>_optional_ | integer(int32) |
| **ssoSessionMaxLifespan**  <br>_optional_ | integer(int32) |
| **ssoSessionMaxLifespanRememberMe**  <br>_optional_ | integer(int32) |
| **supportedLocales**  <br>_optional_ | < string > array |
| **userFederationMappers**  <br>_optional_ | < [UserFederationMapperRepresentation](#_userfederationmapperrepresentation) > array |
| **userFederationProviders**  <br>_optional_ | < [UserFederationProviderRepresentation](#_userfederationproviderrepresentation) > array |
| **userManagedAccessAllowed**  <br>_optional_ | boolean |
| **users**  <br>_optional_ | < [UserRepresentation](#_userrepresentation) > array |
| **verifyEmail**  <br>_optional_ | boolean |
| **waitIncrementSeconds**  <br>_optional_ | integer(int32) |
| **webAuthnPolicyAcceptableAaguids**  <br>_optional_ | < string > array |
| **webAuthnPolicyAttestationConveyancePreference**  <br>_optional_ | string |
| **webAuthnPolicyAuthenticatorAttachment**  <br>_optional_ | string |
| **webAuthnPolicyAvoidSameAuthenticatorRegister**  <br>_optional_ | boolean |
| **webAuthnPolicyCreateTimeout**  <br>_optional_ | integer(int32) |
| **webAuthnPolicyPasswordlessAcceptableAaguids**  <br>_optional_ | < string > array |
| **webAuthnPolicyPasswordlessAttestationConveyancePreference**  <br>_optional_ | string |
| **webAuthnPolicyPasswordlessAuthenticatorAttachment**  <br>_optional_ | string |
| **webAuthnPolicyPasswordlessAvoidSameAuthenticatorRegister**  <br>_optional_ | boolean |
| **webAuthnPolicyPasswordlessCreateTimeout**  <br>_optional_ | integer(int32) |
| **webAuthnPolicyPasswordlessRequireResidentKey**  <br>_optional_ | string |
| **webAuthnPolicyPasswordlessRpEntityName**  <br>_optional_ | string |
| **webAuthnPolicyPasswordlessRpId**  <br>_optional_ | string |
| **webAuthnPolicyPasswordlessSignatureAlgorithms**  <br>_optional_ | < string > array |
| **webAuthnPolicyPasswordlessUserVerificationRequirement**  <br>_optional_ | string |
| **webAuthnPolicyRequireResidentKey**  <br>_optional_ | string |
| **webAuthnPolicyRpEntityName**  <br>_optional_ | string |
| **webAuthnPolicyRpId**  <br>_optional_ | string |
| **webAuthnPolicySignatureAlgorithms**  <br>_optional_ | < string > array |
| **webAuthnPolicyUserVerificationRequirement**  <br>_optional_ | string |

### RequiredActionProviderRepresentation

 
| Name | Schema |
| --- | --- |
| **alias**  <br>_optional_ | string |
| **config**  <br>_optional_ | [Map](#_map) |
| **defaultAction**  <br>_optional_ | boolean |
| **enabled**  <br>_optional_ | boolean |
| **name**  <br>_optional_ | string |
| **priority**  <br>_optional_ | integer(int32) |
| **providerId**  <br>_optional_ | string |

### ResourceRepresentation

 
| Name | Schema |
| --- | --- |
| **_id_**_  <br>\_optional_ | string |
| **attributes**  <br>_optional_ | [Map](#_map) |
| **displayName**  <br>_optional_ | string |
| **icon\_uri**  <br>_optional_ | string |
| **name**  <br>_optional_ | string |
| **ownerManagedAccess**  <br>_optional_ | boolean |
| **scopes**  <br>_optional_ | < [ScopeRepresentation](#_scoperepresentation) > array |
| **type**  <br>_optional_ | string |
| **uris**  <br>_optional_ | < string > array |

### ResourceServerRepresentation

 
| Name | Schema |
| --- | --- |
| **allowRemoteResourceManagement**  <br>_optional_ | boolean |
| **clientId**  <br>_optional_ | string |
| **decisionStrategy**  <br>_optional_ | enum (AFFIRMATIVE, UNANIMOUS, CONSENSUS) |
| **id**  <br>_optional_ | string |
| **name**  <br>_optional_ | string |
| **policies**  <br>_optional_ | < [PolicyRepresentation](#_policyrepresentation) > array |
| **policyEnforcementMode**  <br>_optional_ | enum (ENFORCING, PERMISSIVE, DISABLED) |
| **resources**  <br>_optional_ | < [ResourceRepresentation](#_resourcerepresentation) > array |
| **scopes**  <br>_optional_ | < [ScopeRepresentation](#_scoperepresentation) > array |

### RoleRepresentation

 
| Name | Schema |
| --- | --- |
| **attributes**  <br>_optional_ | [Map](#_map) |
| **clientRole**  <br>_optional_ | boolean |
| **composite**  <br>_optional_ | boolean |
| **composites**  <br>_optional_ | [RoleRepresentation-Composites](#_rolerepresentation-composites) |
| **containerId**  <br>_optional_ | string |
| **description**  <br>_optional_ | string |
| **id**  <br>_optional_ | string |
| **name**  <br>_optional_ | string |

### RoleRepresentation-Composites

 
| Name | Schema |
| --- | --- |
| **client**  <br>_optional_ | [Map](#_map) |
| **realm**  <br>_optional_ | < string > array |

### RolesRepresentation

 
| Name | Schema |
| --- | --- |
| **client**  <br>_optional_ | [Map](#_map) |
| **realm**  <br>_optional_ | < [RoleRepresentation](#_rolerepresentation) > array |

### ScopeMappingRepresentation

 
| Name | Schema |
| --- | --- |
| **client**  <br>_optional_ | string |
| **clientScope**  <br>_optional_ | string |
| **roles**  <br>_optional_ | < string > array |
| **self**  <br>_optional_ | string |

### ScopeRepresentation

 
| Name | Schema |
| --- | --- |
| **displayName**  <br>_optional_ | string |
| **iconUri**  <br>_optional_ | string |
| **id**  <br>_optional_ | string |
| **name**  <br>_optional_ | string |
| **policies**  <br>_optional_ | < [PolicyRepresentation](#_policyrepresentation) > array |
| **resources**  <br>_optional_ | < [ResourceRepresentation](#_resourcerepresentation) > array |

### ServerInfoRepresentation

 
| Name | Schema |
| --- | --- |
| **builtinProtocolMappers**  <br>_optional_ | [Map](#_map) |
| **clientImporters**  <br>_optional_ | < [Map](#_map) > array |
| **clientInstallations**  <br>_optional_ | [Map](#_map) |
| **componentTypes**  <br>_optional_ | [Map](#_map) |
| **cryptoInfo**  <br>_optional_ | [CryptoInfoRepresentation](#_cryptoinforepresentation) |
| **enums**  <br>_optional_ | [Map](#_map) |
| **identityProviders**  <br>_optional_ | < [Map](#_map) > array |
| **memoryInfo**  <br>_optional_ | [MemoryInfoRepresentation](#_memoryinforepresentation) |
| **passwordPolicies**  <br>_optional_ | < [PasswordPolicyTypeRepresentation](#_passwordpolicytyperepresentation) > array |
| **profileInfo**  <br>_optional_ | [ProfileInfoRepresentation](#_profileinforepresentation) |
| **protocolMapperTypes**  <br>_optional_ | [Map](#_map) |
| **providers**  <br>_optional_ | [Map](#_map) |
| **socialProviders**  <br>_optional_ | < [Map](#_map) > array |
| **systemInfo**  <br>_optional_ | [SystemInfoRepresentation](#_systeminforepresentation) |
| **themes**  <br>_optional_ | [Map](#_map) |

### SpiInfoRepresentation

 
| Name | Schema |
| --- | --- |
| **internal**  <br>_optional_ | boolean |
| **providers**  <br>_optional_ | [Map](#_map) |

### SystemInfoRepresentation

 
| Name | Schema |
| --- | --- |
| **fileEncoding**  <br>_optional_ | string |
| **javaHome**  <br>_optional_ | string |
| **javaRuntime**  <br>_optional_ | string |
| **javaVendor**  <br>_optional_ | string |
| **javaVersion**  <br>_optional_ | string |
| **javaVm**  <br>_optional_ | string |
| **javaVmVersion**  <br>_optional_ | string |
| **osArchitecture**  <br>_optional_ | string |
| **osName**  <br>_optional_ | string |
| **osVersion**  <br>_optional_ | string |
| **serverTime**  <br>_optional_ | string |
| **uptime**  <br>_optional_ | string |
| **uptimeMillis**  <br>_optional_ | integer(int64) |
| **userDir**  <br>_optional_ | string |
| **userLocale**  <br>_optional_ | string |
| **userName**  <br>_optional_ | string |
| **userTimezone**  <br>_optional_ | string |
| **version**  <br>_optional_ | string |

### UserConsentRepresentation

 
| Name | Schema |
| --- | --- |
| **clientId**  <br>_optional_ | string |
| **createdDate**  <br>_optional_ | integer(int64) |
| **grantedClientScopes**  <br>_optional_ | < string > array |
| **lastUpdatedDate**  <br>_optional_ | integer(int64) |

### UserFederationMapperRepresentation

 
| Name | Schema |
| --- | --- |
| **config**  <br>_optional_ | [Map](#_map) |
| **federationMapperType**  <br>_optional_ | string |
| **federationProviderDisplayName**  <br>_optional_ | string |
| **id**  <br>_optional_ | string |
| **name**  <br>_optional_ | string |

### UserFederationProviderRepresentation

 
| Name | Schema |
| --- | --- |
| **changedSyncPeriod**  <br>_optional_ | integer(int32) |
| **config**  <br>_optional_ | [Map](#_map) |
| **displayName**  <br>_optional_ | string |
| **fullSyncPeriod**  <br>_optional_ | integer(int32) |
| **id**  <br>_optional_ | string |
| **lastSync**  <br>_optional_ | integer(int32) |
| **priority**  <br>_optional_ | integer(int32) |
| **providerName**  <br>_optional_ | string |

### UserRepresentation

 
| Name | Schema |
| --- | --- |
| **access**  <br>_optional_ | [Map](#_map) |
| **attributes**  <br>_optional_ | [Map](#_map) |
| **clientConsents**  <br>_optional_ | < [UserConsentRepresentation](#_userconsentrepresentation) > array |
| **clientRoles**  <br>_optional_ | [Map](#_map) |
| **createdTimestamp**  <br>_optional_ | integer(int64) |
| **credentials**  <br>_optional_ | < [CredentialRepresentation](#_credentialrepresentation) > array |
| **disableableCredentialTypes**  <br>_optional_ | < string > array |
| **email**  <br>_optional_ | string |
| **emailVerified**  <br>_optional_ | boolean |
| **enabled**  <br>_optional_ | boolean |
| **federatedIdentities**  <br>_optional_ | < [FederatedIdentityRepresentation](#_federatedidentityrepresentation) > array |
| **federationLink**  <br>_optional_ | string |
| **firstName**  <br>_optional_ | string |
| **groups**  <br>_optional_ | < string > array |
| **id**  <br>_optional_ | string |
| **lastName**  <br>_optional_ | string |
| **notBefore**  <br>_optional_ | integer(int32) |
| **origin**  <br>_optional_ | string |
| **realmRoles**  <br>_optional_ | < string > array |
| **requiredActions**  <br>_optional_ | < string > array |
| **self**  <br>_optional_ | string |
| **serviceAccountClientId**  <br>_optional_ | string |
| **username**  <br>_optional_ | string |
```