Keycloak Admin REST API

https://www.keycloak.org/docs-api/latest/rest-api/
Admin
Keycloak Admin REST API is a comprehensive REST API for managing authentication, authorization,...
Tokens:75,364
Snippets:451
Trust Score:9.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### GET /admin/realms/{realm}/clients/{client-uuid}/installation/providers/{providerId}

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

Retrieves the installation provider configuration for a specific client.

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

### Description
Retrieves the installation provider configuration for a specific client.

### Method
GET

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **client-uuid** (string) - Required - id of client (not client-id!)
- **providerId** (string) - Required - The provider ID

### Response
#### Success Response (200)
- OK
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

Creates a JSON payload containing example user information based on the provided scope and user ID.

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

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

### Method
GET

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **client-uuid** (string) - Required - id of client (not client-id!)

#### Query Parameters
- **scope** (string) - Optional
- **userId** (string) - Optional

### Response
#### Success Response (200)
- **object** (object) - OK

#### Error Response (403)
- Forbidden
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

Generates an example access token payload for scope evaluation.

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

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

### Method
GET

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **client-uuid** (string) - Required - id of client (not client-id!)
#### Query Parameters
- **audience** (string) - Optional
- **scope** (string) - Optional
- **userId** (string) - Optional

### Response
#### Success Response (200)
- **AccessToken** (object)

#### Error Response (403)
- Forbidden

#### Error Response (404)
- Not Found
```

--------------------------------

### GET /admin/realms/{realm}/clients/{client-uuid}/evaluate-scopes/generate-example-saml-response

Source: https://www.keycloak.org/docs-api/latest/rest-api/index.html

Creates a JSON payload containing an example SAML response.

```APIDOC
## GET /admin/realms/{realm}/clients/{client-uuid}/evaluate-scopes/generate-example-saml-response

### Description
Create JSON with an example SAML response as payload

### Method
GET

### Endpoint
/admin/realms/{realm}/clients/{client-uuid}/evaluate-scopes/generate-example-saml-response

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **client-uuid** (string) - Required - id of client (not client-id!)

#### Query Parameters
- **audience** (string) - Optional
- **scope** (string) - Optional
- **userId** (string) - Optional

### Response
#### Success Response (200)
- **SamlExampleResponse** (object) - Example SAML response
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

Generates an example ID token payload for scope evaluation.

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

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

### Method
GET

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **client-uuid** (string) - Required - id of client (not client-id!)
#### Query Parameters
- **audience** (string) - Optional
- **scope** (string) - Optional
- **userId** (string) - Optional

### Response
#### Success Response (200)
- **IDToken** (object)

#### Error Response (403)
- Forbidden

#### Error Response (404)
- Not Found
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/index.html

Get all scope mappings for the client.

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

### Description
Get all scope mappings for the client.

### Method
GET

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **client-scope-id** (string) - Required

### Response
#### Success Response (200)
- **MappingsRepresentation** (object) - Scope mappings representation
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/index.html

Get all scope mappings for the client.

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

### Description
Get all scope mappings for the client.

### Method
GET

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **client-scope-id** (string) - Required

### Response
#### Success Response (200)
- **MappingsRepresentation** (object) - All scope mappings for the client
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

Retrieves configuration descriptions for all clients in the realm.

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

### Description
Get configuration descriptions for all clients.

### Method
GET

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/index.html

Get client-level role mappings for the user or group.

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

### Description
Get client-level role mappings for the user or group, and the app.

### Method
GET

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **group-id** (string) - Required - The group ID
- **client-id** (string) - Required - client id (not clientId!)

### Response
#### Success Response (200)
- **List[RoleRepresentation]** (array) - List of role mappings
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/index.html

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

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

### Description
Get client-level role mappings for the user or group, and the app.

### Method
GET

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **user-id** (string) - Required
- **client-id** (string) - Required - client id (not clientId!)

### Response
#### Success Response (200)
- **List[RoleRepresentation]** (array) - List of client-level role mappings
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

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

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

### Description
Get client-level role mappings for the user or group, and the app.

### Method
GET

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **group-id** (string) - Required
- **client-id** (string) - Required - client id (not clientId!)

### Response
#### Success Response (200)
- **RoleRepresentation[]** (array) - OK
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/index.html

Get representation of the client scope.

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

### Description
Get representation of the client scope.

### Method
GET

### Endpoint
/admin/realms/{realm}/client-scopes/{client-scope-id}

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **client-scope-id** (string) - Required

### Response
#### Success Response (200)
- **ClientScopeRepresentation** (object) - Client scope details
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/index.html

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

```APIDOC
## GET /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}/composites/clients/{targetClientUuid}

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

### Method
GET

### Endpoint
/admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}/composites/clients/{targetClientUuid}

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **client-uuid** (string) - Required - id of client (not client-id!)
- **role-name** (string) - Required - role's name (not id!)
- **targetClientUuid** (string) - Required

### Response
#### Success Response (200)
- **List[RoleRepresentation]** (array) - List of role representations
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

Lists components in a realm or creates a new component.

```APIDOC
## GET /admin/realms/{realm}/components

### Description
List components in the realm.

### Method
GET

### Endpoint
/admin/realms/{realm}/components

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)

#### Query Parameters
- **name** (string) - Optional
- **parent** (string) - Optional
- **providerId** (string) - Optional
- **type** (string) - Optional

### Response
#### Success Response (200)
- **ComponentRepresentation[]** (array) - List of components
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/index.html

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

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

### Description
Get available client-level roles that can be mapped to the user or group.

### Method
GET

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **group-id** (string) - Required - The group ID
- **client-id** (string) - Required - client id (not clientId!)

### Response
#### Success Response (200)
- **List[RoleRepresentation]** (array) - List of available roles
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

Lists all identity providers configured for the specified realm.

```APIDOC
## GET /admin/realms/{realm}/identity-provider/instances

### Description
List identity providers.

### Method
GET

### Endpoint
/admin/realms/{realm}/identity-provider/instances

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)

#### Query Parameters
- **briefRepresentation** (boolean) - Optional - Boolean which defines whether brief representations are returned (default: false)
- **capability** (string) - Optional - Filter by identity providers capability
- **first** (integer) - Optional - Pagination offset
- **max** (integer) - Optional - Maximum results size (defaults to 100)
- **realmOnly** (boolean) - Optional - Boolean which defines if only realm-level IDPs (not associated with orgs) should be returned (default: false)
- **search** (string) - Optional - Filter specific providers by name. Search can be prefix (name*), contains (*name*) or exact ("name"). Default prefixed.
- **type** (string) - Optional - Filter by identity providers type

### Response
#### Success Response (200)
- **array** (array) - OK
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/index.html

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

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

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

### Method
GET

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **client-scope-id** (string) - Required
- **client** (string) - Required

### Response
#### Success Response (200)
- **List[RoleRepresentation]** (array) - List of roles
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

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

```APIDOC
## GET /admin/realms/{realm}/organizations/{org-id}/groups/{group-id}/role-mappings/clients/{client-id}/available

### Description
Get available client-level roles that can be mapped to the user or group.

### Method
GET

### Endpoint
/admin/realms/{realm}/organizations/{org-id}/groups/{group-id}/role-mappings/clients/{client-id}/available

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **org-id** (string) - Required
- **group-id** (string) - Required
- **client-id** (string) - Required - client id (not clientId!)

### Response
#### Success Response (200)
- **roles** (array) - List of available RoleRepresentation objects
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/index.html

Retrieves a list of components for a specific realm.

```APIDOC
## GET /admin/realms/{realm}/components

### Description
Retrieves a list of components for a specific realm.

### Method
GET

### Endpoint
/admin/realms/{realm}/components

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)

#### Query Parameters
- **name** (string) - Optional
- **parent** (string) - Optional
- **providerId** (string) - Optional
- **type** (string) - Optional

### Response
#### Success Response (200)
- **List[ComponentRepresentation]** (array) - List of components
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/index.html

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

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

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

### Method
GET

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **client-uuid** (string) - Required - id of client (not client-id!)

### Response
#### Success Response (200)
- **List[RoleRepresentation]** (array) - List of roles
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

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

```APIDOC
## GET /admin/realms/{realm}/organizations/{org-id}/groups/{group-id}/role-mappings/clients/{client-id}/composite

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

### Method
GET

### Endpoint
/admin/realms/{realm}/organizations/{org-id}/groups/{group-id}/role-mappings/clients/{client-id}/composite

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **org-id** (string) - Required
- **group-id** (string) - Required
- **client-id** (string) - Required - client id (not clientId!)

#### Query Parameters
- **briefRepresentation** (boolean) - Optional - if false, return roles with their attributes (default: true)

### Response
#### Success Response (200)
- **roles** (array) - List of effective RoleRepresentation objects
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

Retrieves the configuration for a specific authenticator.

```APIDOC
## GET /admin/realms/{realm}/authentication/config/{id}

### Description
Get authenticator configuration.

### Method
GET

### Endpoint
/admin/realms/{realm}/authentication/config/{id}

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **id** (string) - Required - Configuration id

### Response
#### Success Response (200)
- **AuthenticatorConfigRepresentation** (object) - OK
```

--------------------------------

### GET /admin/realms/{realm}/workflows

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

Lists workflows for a realm, supporting pagination and filtering.

```APIDOC
## GET /admin/realms/{realm}/workflows

### Description
List workflows filtered by name and paginated using first and max parameters.

### Method
GET

### Endpoint
/admin/realms/{realm}/workflows

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)

#### Query Parameters
- **exact** (boolean) - Optional - Boolean which defines whether the param 'search' must match exactly or not
- **first** (integer) - Optional - The position of the first result to be processed
```

--------------------------------

### GET /admin/realms/{realm}/workflows

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

Retrieve a list of workflows for a given realm.

```APIDOC
## GET /admin/realms/{realm}/workflows

### Description
Retrieve a list of workflows for a given realm.

### Method
GET

### Endpoint
/admin/realms/{realm}/workflows

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)

#### Query Parameters
- **offset** (integer) - Optional - defaults to 0
- **max** (integer) - Optional - The maximum number of results to be returned - defaults to 10
- **search** (string) - Optional - A String representing the workflow name - either partial or exact

### Response
#### Success Response (200)
- **WorkflowRepresentation** (object) - OK
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/index.html

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

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

### Description
Get effective realm-level roles associated with the client’s scope. This recurses any composite roles associated with the client’s scope and provides a comprehensive total view.

### Method
GET

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **client-scope-id** (string) - Required

#### Query Parameters
- **briefRepresentation** (boolean) - Optional - if false, return roles with their attributes (default: true)

### Response
#### Success Response (200)
- **List[RoleRepresentation]** (array) - List of effective realm-level roles
```

--------------------------------

### GET /admin/realms

Source: https://www.keycloak.org/docs-api/latest/rest-api/index.html

Retrieves a list of accessible realms.

```APIDOC
## GET /admin/realms

### Description
Get accessible realms. The list is filtered based on what realms the caller is allowed to view.

### Method
GET

### Endpoint
/admin/realms

### Parameters
#### Query Parameters
- **briefRepresentation** (boolean) - Optional - Default: false

### Response
#### Success Response (200)
- **List[RealmRepresentation]** (array) - OK
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

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

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

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

### Method
POST

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **client-uuid** (string) - Required - id of client (not client-id!)
- **attr** (string) - Required

### Request Body
- **KeyStoreConfig** (object) - Required

### Response
#### Success Response (200)
- **binary** (string) - Keystore file
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/index.html

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

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

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

### Method
GET

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **client-uuid** (string) - Required - id of client (not client-id!)

#### Query Parameters
- **first** (integer) - Optional - Paging offset
- **max** (integer) - Optional - Maximum results size

### Response
#### Success Response (200)
- **sessions** (List[UserSessionRepresentation]) - List of offline user sessions
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/index.html

Returns the roles for the client that can be associated with the client’s scope.

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

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

### Method
GET

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **client-scope-id** (string) - Required
- **client** (string) - Required

### Response
#### Success Response (200)
- **List[RoleRepresentation]** (array) - List of available roles
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/index.html

Retrieve a specific group.

```APIDOC
## GET /admin/realms/{realm}/groups/{group-id}

### Method
GET

### Endpoint
/admin/realms/{realm}/groups/{group-id}

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **group-id** (string) - Required

### Response
#### Success Response (200)
- **GroupRepresentation** (object) - Group details
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

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

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

### Description
Generates a keypair and certificate and serves the private key in a specified keystore format. Only generated public certificate is saved in Keycloak DB - the private key is not.

### Method
POST

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **client-uuid** (string) - Required - id of client (not client-id!)
- **attr** (string) - Required

### Request Body
- **KeyStoreConfig** (object) - Required

### Response
#### Success Response (200)
- **binary** (string) - Keystore file
```

--------------------------------

### GET /admin/realms/{realm}/roles

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

Get all roles for the realm or client.

```APIDOC
## GET /admin/realms/{realm}/roles

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

### Method
GET

### Endpoint
/admin/realms/{realm}/roles

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)

#### Query Parameters
- **briefRepresentation** (boolean) - Optional
- **first** (integer) - Optional
- **max** (integer) - Optional
- **search** (string) - Optional

### Response
#### Success Response (200)
- **Array** (RoleRepresentation) - OK
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

Retrieves the authorization settings for a client.

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

### Description
Returns the resource server settings for the client.

### Method
GET

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **client-uuid** (string) - Required - id of client (not client-id!)

### Response
#### Success Response (200)
- **Object** (ResourceServerRepresentation) - Authorization settings
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/index.html

Retrieve client registration policy providers with their configuration properties.

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

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

### Method
GET

### Endpoint
/admin/realms/{realm}/client-registration-policy/providers

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)

### Response
#### Success Response (200)
- **List[ComponentTypeRepresentation]** (array) - List of component type representations
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/index.html

Retrieves the configuration description for a specific authenticator provider.

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

### Description
Get authenticator provider’s configuration description.

### Method
GET

### Endpoint
/admin/realms/{realm}/authentication/config-description/{providerId}

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **providerId** (string) - Required

### Response
#### Success Response (200)
- **AuthenticatorConfigInfoRepresentation** (object) - Configuration description
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

Returns the initialization status and reference for client Authorization permissions.

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

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

### Method
GET

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **client-uuid** (string) - Required - id of client (not client-id!)

### Response
#### Success Response (200)
- ManagementPermissionReference (object) - The permission reference object
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

Get the client secret.

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

### Description
Get the client secret.

### Method
GET

### Endpoint
/admin/realms/{realm}/clients/{client-uuid}/client-secret

### Response
#### Success Response (200)
- **CredentialRepresentation** (object) - Client secret details
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

Retrieves the details of a specific identity provider by its alias.

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

### Description
Get the identity provider.

### Method
GET

### Endpoint
/admin/realms/{realm}/identity-provider/instances/{alias}

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **alias** (string) - Required - Identity provider alias

### Response
#### Success Response (200)
- **object** (object) - OK
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/index.html

Retrieves a specific component by its ID.

```APIDOC
## GET /admin/realms/{realm}/components/{id}

### Description
Retrieves a specific component by its ID.

### Method
GET

### Endpoint
/admin/realms/{realm}/components/{id}

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **id** (string) - Required

### Response
#### Success Response (200)
- **ComponentRepresentation** (object) - The component details
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

Upload certificate and eventually private key.

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

### Description
Upload certificate and eventually private key.

### Method
POST

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **client-uuid** (string) - Required - id of client (not client-id!)
- **attr** (string) - Required

### Response
#### Success Response (200)
- **CertificateRepresentation** (object) - Certificate details
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/index.html

Retrieves the client profiles for the specified realm.

```APIDOC
## GET /admin/realms/{realm}/client-policies/profiles

### Method
GET

### Endpoint
/admin/realms/{realm}/client-policies/profiles

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)

#### Query Parameters
- **include-global-profiles** (string) - Optional

### Response
#### Success Response (200)
- **ClientProfilesRepresentation** (object) - OK
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

Retrieves the configuration for a specific required action.

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

### Description
Retrieves the configuration details for the specified required action.

### Method
GET

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **alias** (string) - Required - Alias of required action

### Response
#### Success Response (200)
- **RequiredActionConfigRepresentation** (object) - The configuration representation.
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/index.html

Imports an authorization resource server configuration for a client.

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

### Description
Imports an authorization resource server configuration for a client.

### Method
POST

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **client-uuid** (string) - Required - id of client (not client-id!)

#### Request Body
- **ResourceServerRepresentation** (object) - Optional - Resource server configuration

### Response
#### Success Response (204)
- No Content
```

--------------------------------

### POST /admin/realms/{realm}/components

Source: https://www.keycloak.org/docs-api/latest/rest-api/index.html

Creates a new component.

```APIDOC
## POST /admin/realms/{realm}/components

### Description
Creates a new component.

### Method
POST

### Endpoint
/admin/realms/{realm}/components

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)

#### Request Body
- **ComponentRepresentation** (object) - Optional - Component representation data

### Response
#### Success Response (200)
- OK
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

Get role mappings for a specific group.

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

### Description
Get role mappings.

### Method
GET

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **group-id** (string) - Required

### Response
#### Success Response (200)
- **MappingsRepresentation** (object)

#### Error Response (403)
- Forbidden
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

Get application session count for a client.

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

### Description
Returns a number of user sessions associated with this client.

### Method
GET

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **client-uuid** (string) - Required - id of client (not client-id!)

### Response
#### Success Response (200)
- **count** (integer) - Number of user sessions
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

Creates a new initial access token for the specified realm.

```APIDOC
## POST /admin/realms/{realm}/clients-initial-access

### Description
Create a new initial access token.

### Method
POST

### Endpoint
/admin/realms/{realm}/clients-initial-access

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)

#### Request Body
- **body** (ClientInitialAccessCreatePresentation) - Required - The initial access token configuration

### Response
#### Success Response (201)
- **body** (ClientInitialAccessCreatePresentation) - Created token representation
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

Creates multiple protocol mappers for a specific client template.

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

### Description
Create multiple mappers for the specified client template.

### Method
POST

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **client-scope-id** (string) - Required - The ID of the client scope

### Response
#### Success Response (204)
- No Content
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

Get a user dedicated to the service account.

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

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

### Method
GET

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **client-uuid** (string) - Required - id of client (not client-id!)

### Response
#### Success Response (200)
- **user** (object) - UserRepresentation object
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

Get realm-level roles of the role's composite.

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

### Description
Get realm-level roles of the role's composite.

### Method
GET

### Endpoint
/admin/realms/{realm}/roles/{role-name}/composites/realm

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **role-name** (string) - Required - role's name (not id!)

### Response
#### Success Response (200)
- **roles** (array) - List of RoleRepresentation objects.
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/index.html

Retrieves resources for a resource server.

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

### Description
Retrieves a list of resources associated with the resource server.

### Method
GET

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **client-uuid** (string) - Required - id of client (not client-id!)

### Response
#### Success Response (200)
- **List[ResourceRepresentation]** (array) - List of resources
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

Get realm-level role mappings.

```APIDOC
## GET /admin/realms/{realm}/organizations/{org-id}/groups/{group-id}/role-mappings/realm

### Description
Get realm-level role mappings.

### Method
GET

### Endpoint
/admin/realms/{realm}/organizations/{org-id}/groups/{group-id}/role-mappings/realm

### Response
#### Success Response (200)
- **roles** (array) - List of RoleRepresentation objects
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/index.html

Creates a new resource.

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

### Description
Creates a new resource for the specified resource server.

### Method
POST

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **client-uuid** (string) - Required - id of client (not client-id!)

#### Request Body
- **ResourceRepresentation** (object) - Optional - ResourceRepresentation

### Response
#### Success Response (201)
- **ResourceRepresentation** (object) - Created resource
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

Retrieves the initialization status and reference for role authorization permissions.

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

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

### Method
GET

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **client-uuid** (string) - Required - id of client (not client-id!)
- **role-name** (string) - Required - the role name.

### Response
#### Success Response (200)
- **ManagementPermissionReference** (object) - Object containing permission status and reference.
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

Retrieves a list of policies for the specified client.

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

### Description
Retrieves policies based on various filter criteria.

### Method
GET

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **client-uuid** (string) - Required - id of client (not client-id!)

#### Query Parameters
- **first** (integer) - Optional - Pagination offset
- **max** (integer) - Optional - Max results (default 100)
- **name** (string) - Optional - Policy name
- **owner** (string) - Optional - Policy owner

### Response
#### Success Response (200)
- **array** (AbstractPolicyRepresentation[]) - List of policies.
```

--------------------------------

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

Source: https://www.keycloak.org/docs-api/latest/rest-api/index.html

Create a new client scope.

```APIDOC
## POST /admin/realms/{realm}/client-scopes

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

### Method
POST

### Endpoint
/admin/realms/{realm}/client-scopes

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)

#### Request Body
- **ClientScopeRepresentation** (object) - Optional - ClientScopeRepresentation

### Response
#### Success Response (201)
- Created
```

--------------------------------

### GET /admin/realms/{realm}/workflows/{id}

Source: https://www.keycloak.org/docs-api/latest/rest-api/openapi.yaml

Get the workflow representation. Optionally exclude the workflow id from the response.

```APIDOC
## GET /admin/realms/{realm}/workflows/{id}

### Description
Get the workflow representation. Optionally exclude the workflow id from the response.

### Method
GET

### Endpoint
/admin/realms/{realm}/workflows/{id}

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)

#### Query Parameters
- **includeId** (boolean) - Optional - Indicates whether the workflow and step ids should be included in the representation or not - defaults to true

### Response
#### Success Response (200)
- **WorkflowRepresentation** (object) - OK
```
Tokens:
Raw