Keycloak

https://www.keycloak.org/docs-api/latest/
Admin
Keycloak is an open-source identity and access management solution that provides authentication,...
Tokens:178,935
Snippets:1,012
Trust Score:9.7
Update:1 week 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 configuration for a specific provider for a client. The providerId is required in the path.

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

### Description
Retrieves the installation configuration for a specific provider for a 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 identifier.

### Response
#### Success Response (200)
- Description: OK

```

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

### 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

Creates JSON with the payload of an example access token for the specified client. Supports query parameters for audience, scope, and user ID.

```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 - The audience for the token.
- **scope** (string) - Optional - The scope for the token.
- **userId** (string) - Optional - The user ID for the token.

### Response
#### Success Response (200)
- **AccessToken** - The example access token payload.

#### Error Responses
- **403** - Forbidden
- **404** - Not Found

#### Response Example
```json
{
  "exp": 1234567890,
  "iat": 1234567890,
  "sub": "user-id"
}
```
```

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

### 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

Creates JSON with the payload of an example ID token for the specified client. Supports query parameters for audience, scope, and user ID.

```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 - The audience for the token.
- **scope** (string) - Optional - The scope for the token.
- **userId** (string) - Optional - The user ID for the token.

### Response
#### Success Response (200)
- **IDToken** - The example ID token payload.

#### Error Responses
- **403** - Forbidden
- **404** - Not Found

#### Response Example
```json
{
  "exp": 1234567890,
  "iat": 1234567890,
  "sub": "user-id"
}
```
```

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

### 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 object with the payload of example user info. This endpoint is used to preview the user info that would be returned for a client with the given scope and user.

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

### Description
Creates a JSON object with the payload of example user info. This endpoint is used to preview the user info that would be returned for a client with the given scope and user.

### 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 - The scope to evaluate.
- **userId** (string) - Optional - The user ID to generate the example for.

### Response
#### Success Response (200)
- Returns a JSON object.

#### Response Example
```json
{}
```

#### Error Response (403)
- Forbidden

```

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

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

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

Creates a JSON object with an example SAML response as the payload. This endpoint is used to preview the SAML response that would be generated for a client with the given scope and audience.

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

### Description
Creates a JSON object with an example SAML response as the payload. This endpoint is used to preview the SAML response that would be generated for a client with the given scope and audience.

### 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 - The audience for the SAML response.
- **scope** (string) - Optional - The scope to evaluate.
- **userId** (string) - Optional - The user ID to generate the example for.

### Response
#### Success Response (200)
- Returns a JSON object of type SamlExampleResponse.

#### Response Example
```json
{
  "type": "SamlExampleResponse"
}
```

```

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

### 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 - The group ID
- **client-id** (string) - Required - The client ID

### Response
#### Success Response (200)
- **array of RoleRepresentation** - The client-level role mappings

#### Response Example
```json
[
  {
    "id": "string",
    "name": "string"
  }
]
```
```

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

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

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

Get authenticator provider's configuration description. Returns the configuration info for the specified provider.

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

### Description
Get authenticator provider's configuration description. Returns the configuration info for the specified provider.

### Method
GET

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

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

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

#### Response Example
```json
{
  "providerId": "string",
  "alias": "string",
  "properties": []
}
```
```

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

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

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

Gets key info for a client attribute certificate. Returns the certificate representation.

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

### Description
Gets key info for a client attribute certificate.

### Method
GET

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

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

### Response
#### Success Response (200)
- Returns a CertificateRepresentation object.
```

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

### 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.

```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!)

### Response
#### Success Response (200)
- **additionalProperties** (array of ConfigPropertyRepresentation) - Configuration descriptions for each client.

#### Response Example
{
  "property1": [
    {
      "name": "string",
      "label": "string",
      "helpText": "string",
      "type": "string",
      "defaultValue": "string",
      "options": ["string"]
    }
  ]
}
```

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

### 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

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

### Response
#### Success Response (200)
- **CredentialRepresentation** (object) - The client secret representation

#### Response Example
{
  "type": "string",
  "value": "string",
  "temporary": false
}

```

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

### 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
Creates a new initial access token for the specified realm.

### Method
POST

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

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

#### Request Body
- **ClientInitialAccessCreatePresentation** (object) - Required - The initial access token creation details.

### Request Example
```json
{
  "expiration": 0,
  "count": 0
}
```

### Response
#### Success Response (201)
- **ClientInitialAccessCreatePresentation** (object) - The created initial access token.

#### Response Example
```json
{
  "id": "string",
  "token": "string",
  "expiration": 0,
  "count": 0,
  "remainingCount": 0
}
```
```

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

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

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

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 - The client scope ID.

### Response
#### Success Response (200)
- Returns a ClientScopeRepresentation object.

#### Error Responses
- **403** - Forbidden

```

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

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

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

Imports a resource server representation for a client.

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

### Description
Imports a resource server representation 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) - Required - The resource server representation to import.

### Request Example
```json
{
  "id": "string",
  "clientId": "string",
  "name": "string"
}
```

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

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

### 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 group.

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

### Description
Get role mappings for a group.

### 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 - The group ID

### Response
#### Success Response (200)
- **MappingsRepresentation** - The role mappings

#### Response Example
```json
{
  "realmMappings": [],
  "clientMappings": {}
}
```

#### Error Response (403)
- **Forbidden** - Access denied
```

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

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

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

Get organization group representation.

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

### Description
Get organization group representation.

### Method
GET

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **org-id** (string) - Required - Organization ID
- **group-id** (string) - Required - Group ID

#### Query Parameters
- **subGroupsCount** (boolean) - Optional - Whether to return the count of subgroups (default: false)

### Responses
- **200** - OK - GroupRepresentation
- **403** - Forbidden

```

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

### 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 at once for a client scope. Accepts an array of ProtocolMapperRepresentation objects and returns 204 on success.

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

### Description
Create multiple mappers for the client scope.

### 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.

#### Request Body
- **body** (array of ProtocolMapperRepresentation) - Required - List of protocol mappers to create.

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

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

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

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

Imports localization from an uploaded JSON file.

```APIDOC
## POST /admin/realms/{realm}/localization/{locale}

### Description
Imports localization from an uploaded JSON file.

### Method
POST

### Endpoint
/admin/realms/{realm}/localization/{locale}

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **locale** (string) - Required - The locale identifier.

#### Request Body
- **body** (object) - Required - Map of message keys to localized strings.

### Request Example
```json
{
  "key": "value"
}
```

### Response
#### Success Response (204)
- **description** - No Content

#### Error Response (400)
- **description** - Bad Request

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

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

### GET /admin/realms/{realm}/authentication/authenticator-providers

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

Get authenticator providers. Returns a stream of authenticator providers.

```APIDOC
## GET /admin/realms/{realm}/authentication/authenticator-providers

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

### Method
GET

### Endpoint
/admin/realms/{realm}/authentication/authenticator-providers

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

### Response
#### Success Response (200)
- **items** (array of object) - List of authenticator providers

#### Response Example
```json
[{}]
```
```

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

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

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

Create a new client scope. Client Scope's name must be unique!

```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
- **body** (ClientScopeRepresentation) - Required - The client scope to create.

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

#### Error Responses
- **403** - Forbidden
- **409** - Conflict

```

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

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

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

Gets realm-level roles that are in the role's composite.

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

### Description
Gets realm-level roles that are in the role's composite.

### Method
GET

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

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

### Response
#### Success Response (200)
- **array of RoleRepresentation** - The realm-level roles in the composite

#### Response Example
```json
[
  {
    "id": "string",
    "name": "string"
  }
]
```

#### Error Responses
- **403** - Forbidden

```

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

### 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 the public certificate. This endpoint is deprecated.

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

### Description
Get a keystore file for the client, containing the public certificate. This endpoint is deprecated.

### 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 - Attribute name

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

### Response
#### Success Response (200)
- **body** (binary) - The keystore file content

#### Response Example
(binary data)

```

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

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

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

Gets the identity provider factory for the specified provider id.

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

### Description
Gets the identity provider factory for the specified provider id.

### Method
GET

### Endpoint
/admin/realms/{realm}/identity-provider/providers/{provider_id}

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **provider_id** (string) - Required - The provider id to get the factory.

### Response
#### Success Response (200)
- **body** (object) - The identity provider factory.

#### Response Example
```json
{}
```
```

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

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

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

Get all scope mappings for the client. This endpoint is deprecated.

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

### Description
Get all scope mappings for the client. This endpoint is deprecated.

### Method
GET

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

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

### Response
#### Success Response (200)
- **MappingsRepresentation** - The scope mappings for the client.

#### Response Example
{
  "clientScopes": [],
  "realmRoles": []
}

```

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

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

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

Returns an object stating whether client Authorization permissions have been initialized or not and a reference.

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

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

### Method
GET

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

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

### Response
#### Success Response (200)
- Description: OK
- Content-Type: application/json
- Schema: ManagementPermissionReference

```

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

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

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

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)
- Returns an array of RoleRepresentation objects.

#### Response Example
```json
[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "composite": false,
    "clientRole": false,
    "containerId": "string"
  }
]
```
```

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

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

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

Retrieves a list of initial access tokens for the specified realm.

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

### Description
Retrieves a list of initial access tokens for the specified realm.

### Method
GET

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

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

### Response
#### Success Response (200)
- **items** (array of ClientInitialAccessPresentation) - List of initial access tokens

#### Response Example
```json
[
  {
    "id": "string",
    "token": "string",
    "expiration": 0,
    "count": 0,
    "remainingCount": 0
  }
]
```
```

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

### GET /admin/realms/{realm}/authentication/client-authenticator-providers

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

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

```APIDOC
## GET /admin/realms/{realm}/authentication/client-authenticator-providers

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

### Method
GET

### Endpoint
/admin/realms/{realm}/authentication/client-authenticator-providers

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

### Response
#### Success Response (200)
- **items** (array of object) - List of client authenticator providers

#### Response Example
```json
[{}]
```
```

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

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

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

Creates multiple protocol mappers for a client.

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

### Description
Creates multiple protocol mappers for a client.

### Method
POST

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

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

#### Request Body
- **array of ProtocolMapperRepresentation** - Required - List of protocol mappers to create

### Request Example
```json
[
  {
    "id": "string",
    "name": "string",
    "protocol": "string",
    "protocolMapper": "string",
    "config": {}
  }
]
```

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

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

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

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

Gets client-level roles for the client that are in the role's composite.

```APIDOC
## GET /admin/realms/{realm}/roles-by-id/{role-id}/composites/clients/{clientUuid}

### Description
Gets client-level roles for the client that are in the role's composite.

### Method
GET

### Endpoint
/admin/realms/{realm}/roles-by-id/{role-id}/composites/clients/{clientUuid}

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **role-id** (string) - Required - Role id
- **clientUuid** (string) - Required - Client UUID

### Response
#### Success Response (200)
- **array of RoleRepresentation** - The client-level roles in the composite

#### Response Example
```json
[
  {
    "id": "string",
    "name": "string"
  }
]
```

#### Error Responses
- **403** - Forbidden
- **404** - Not Found

```

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

### 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. 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. This endpoint is deprecated.

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

### Description
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. Only generated public certificate is saved in Keycloak DB - the private key is not. This endpoint is deprecated.

### 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 - Attribute name

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

### Response
#### Success Response (200)
- **body** (binary) - The private key file content

#### Response Example
(binary data)

```

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

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

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

Generate a new certificate with new key pair.

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

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

### Method
POST

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

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

### Content Type
- `application/json`

### Response
#### Success Response (200)
- **CertificateRepresentation** - The generated certificate representation.

```

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

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

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

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

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

### Description
Get realm-level roles that are available to attach to this client's scope.

### Method
GET

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

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

### Response
#### Success Response (200)
- Returns an array of RoleRepresentation objects.

#### Response Example
```json
[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "composite": false,
    "clientRole": false,
    "containerId": "string"
  }
]
```
```

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

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

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

Creates a new client. The client's client_id must be unique.

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

### Description
Create a new client. Client's client_id must be unique!

### Method
POST

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

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

#### Request Body
- **ClientRepresentation** (object) - Required - The client data to create.

### Request Example
```json
{
  "clientId": "string",
  "name": "string",
  "enabled": true
}
```

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

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

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

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

Gets 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
Gets 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 ID of the group.
- **client-id** (string) - Required - client id (not clientId!)

### Content Type
application/json

### Response
#### Success Response (200)
- Returns a list of RoleRepresentation objects.

#### Response Example
```json
[
  {
    "id": "string",
    "name": "string",
    "description": "string"
  }
]
```
```

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

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

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

Returns an object stating whether client Authorization permissions have been initialized or not and a reference.

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

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

### Method
PUT

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **alias** (string) - Required - No description provided.

#### Request Body
- **ManagementPermissionReference** - Required - The request body is a ManagementPermissionReference object.

### Response
#### Success Response (200)
- **ManagementPermissionReference** - The response body is a ManagementPermissionReference object.

#### Response Example
```json
{
  "enabled": true,
  "resource": "string",
  "scopePermissions": {}
}
```
```

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

### POST /admin/realms/{realm}/workflows/{id}/activate/{type}/{resourceId}

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

Activates the workflow for the given resource type and identifier. Optionally schedules the first step using the notBefore parameter.

```APIDOC
## POST /admin/realms/{realm}/workflows/{id}/activate/{type}/{resourceId}

### Description
Activate the workflow for the given resource type and identifier. Optionally schedule the first step using the notBefore parameter.

### Method
POST

### Endpoint
/admin/realms/{realm}/workflows/{id}/activate/{type}/{resourceId}

### Parameters
#### Path Parameters
- **realm** (string) - Required - realm name (not id!)
- **id** (string) - Required - Workflow identifier
- **type** (object) - Required - Resource type
- **resourceId** (string) - Required - Resource identifier

#### Query Parameters
- **notBefore** (string) - Optional - Not before timestamp for scheduling the first step.

### Response
#### Success Response (200)
OK

#### Error Response (400)
Bad Request
```

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

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

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

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

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

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

### Method
GET

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

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

#### Query Parameters
- **briefRepresentation** (boolean) - 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.)
- **first** (integer) - Optional - Pagination offset
- **max** (integer) - Optional - Maximum results size (defaults to 100)

### Response
#### Success Response (200)
- **array of UserRepresentation** - The list of users

#### Response Example
```json
[
  {
    "id": "string",
    "username": "string",
    "email": "string"
  }
]
```
```

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

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

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

Get composites of the role. Returns a list of role representations.

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

### Description
Get composites of the role.

### Method
GET

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

### 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!)

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

#### Response Example
[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "composite": false,
    "composites": {},
    "clientRole": true,
    "containerId": "string",
    "attributes": {}
  }
]

#### Error Responses
- **403** - Forbidden
- **404** - Not Found
```

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

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

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

Creates a single protocol mapper for a client.

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

### Description
Creates a single protocol mapper for a client.

### Method
POST

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

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

#### Request Body
- **ProtocolMapperRepresentation** - Required - Protocol mapper to create

### Request Example
```json
{
  "id": "string",
  "name": "string",
  "protocol": "string",
  "protocolMapper": "string",
  "config": {}
}
```

### Response
#### Success Response (201)
Created

#### Error Response (409)
Conflict
```

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

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

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

Get a role by name from a specific client. Returns the role representation.

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

### Description
Get a role by name from a specific client.

### Method
GET

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

### 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!)

### Response
#### Success Response (200)
- **RoleRepresentation** - The role representation.

#### Response Example
{
  "id": "string",
  "name": "string",
  "description": "string",
  "composite": false,
  "composites": {},
  "clientRole": true,
  "containerId": "string",
  "attributes": {}
}

#### Error Responses
- **403** - Forbidden
- **404** - Not Found
```

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

### 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 resource server settings for a client. Returns the resource server representation.

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

### Description
Retrieves the resource server settings for a 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)
- Returns a ResourceServerRepresentation object.
```
Tokens:
Raw