Keycloak

https://www.keycloak.org/docs-api/latest/javadocs/
Admin
Keycloak is an open-source identity and access management solution that provides authentication,...
Tokens:2,511,023
Snippets:35,890
Trust Score:9.7
Update:1 week ago
Show doc for...
Tokens:
Raw
### Method: start()

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/jgroups/protocol/OPEN_TELEMETRY.html

Starts the protocol, initializing the OpenTelemetry tracer.

```APIDOC
## Method: start()

### Description
Starts the protocol, initializing the OpenTelemetry tracer. This method is called when the protocol stack is started.

### Signature
`public void start() throws Exception`

### Parameters
None.

### Throws
- `Exception` - If initialization fails.

### Returns
Nothing.
```

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

### GET /clients/{client-uuid}/installation/providers/{providerId}

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/services/resources/admin/ClientResource.html

Retrieves the installation provider for the client.

```APIDOC
## [GET] /clients/{client-uuid}/installation/providers/{providerId}

### Description
Get installation provider.

### Method
GET

### Endpoint
`/clients/{client-uuid}/installation/providers/{providerId}`

### Parameters
#### Path Parameters
- **providerId** (string) - Required - The provider ID.

### Response
#### Success Response (200)
- **Response** - The installation provider response.

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

```

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

### Profile.init(Profile.ProfileName profileName, Map<Profile.Feature,Boolean> features, Map<Profile.Feature,Profile.Enablement> enablements)

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/common/class-use/Profile.Feature.html

Initializes a Profile with the given profile name, feature map, and enablements.

```APIDOC
## Profile.init(Profile.ProfileName profileName, Map<Profile.Feature,Boolean> features, Map<Profile.Feature,Profile.Enablement> enablements)

### Description
Initializes a Profile with the given profile name, feature map, and enablements.

### Method
init

### Parameters
- **profileName** (Profile.ProfileName) - Required - The profile name.
- **features** (Map<Profile.Feature,Boolean>) - Required - A map of features to booleans.
- **enablements** (Map<Profile.Feature,Profile.Enablement>) - Required - A map of feature enablements.

### Returns
- **Profile** - The initialized Profile.

```

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

### GET /oauth/oob

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/protocol/oidc/OIDCLoginProtocolService.html

Callback endpoint for installed applications using the out-of-band flow.

```APIDOC
## [GET] /oauth/oob

### Description
Callback endpoint for installed applications using the out-of-band flow.

### Method
GET

### Endpoint
/oauth/oob

### Parameters
#### Query Parameters
- **code** (String) - Optional - Authorization code.
- **error** (String) - Optional - Error code.
- **error_description** (String) - Optional - Error description.

```

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

### Profile.init(Profile.ProfileName profileName, Map<Profile.Feature,Boolean> features, Map<Profile.Feature,Profile.Enablement> enablements)

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/common/Profile.html

Initializes the profile with the given profile name, feature map, and enablements.

```APIDOC
## init(Profile.ProfileName profileName, Map<Profile.Feature,Boolean> features, Map<Profile.Feature,Profile.Enablement> enablements)

### Description
Initializes the profile with the given profile name, feature map, and enablements.

### Method
public static Profile init(Profile.ProfileName profileName, Map<Profile.Feature,Boolean> features, Map<Profile.Feature,Profile.Enablement> enablements)

### Parameters
- profileName (Profile.ProfileName) - Required - The profile name.
- features (Map<Profile.Feature,Boolean>) - Required - Map of features to their enabled state.
- enablements (Map<Profile.Feature,Profile.Enablement>) - Required - Map of features to their enablement.

### Returns
- Profile - the initialized profile instance
```

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

### GET generate-example-userinfo

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/admin/client/resource/ClientScopeEvaluateResource.html

Generates an example user-info response simulating the specified scope parameter.

```APIDOC
## GET generate-example-userinfo

### Description
Generate example user-info response

### Method
GET

### Endpoint
generate-example-userinfo

### Parameters
#### Query Parameters
- **scope** (String) - Optional - Value of the "scope" parameter. Endpoint simulates generating of the user-info as if the "scope" parameter with specified value is used for generating the access-token, which would then be used for the user-info request. Could be null.
- **userId** (String) - Required - User ID

### Response
#### Success Response (200)
- **Map<String,Object>** - Generated user-info

```

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

### Configuration(String authServerUrl, String realm, String clientId, Map<String,Object> clientCredentials, org.apache.http.client.HttpClient httpClient)

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/authorization/client/Configuration.html

Creates a new Configuration instance with the specified server URL, realm, client ID, client credentials, and HTTP client.

```APIDOC
## Configuration(String authServerUrl, String realm, String clientId, Map<String,Object> clientCredentials, org.apache.http.client.HttpClient httpClient)

### Description
Creates a new Configuration instance with the specified parameters.

### Method
Constructor

### Signature
`public Configuration(String authServerUrl, String realm, String clientId, Map<String,Object> clientCredentials, org.apache.http.client.HttpClient httpClient)`

### Parameters
- **authServerUrl** (String) - Required - The server's URL. E.g.: http://{server}:{port}/auth. (not `null`)
- **realm** (String) - Required - The realm name (not `null`)
- **clientId** (String) - Required - The client id (not `null`)
- **clientCredentials** (Map<String,Object>) - Required - A map with the client credentials (not `null`)
- **httpClient** (org.apache.http.client.HttpClient) - Required - The `HttpClient` instance that should be used when sending requests to the server, or `null` if a default instance should be created

```

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

### GET generate-example-id-token

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/admin/client/resource/ClientScopeEvaluateResource.html

Generates an example ID token simulating the specified scope and audience parameters.

```APIDOC
## GET generate-example-id-token

### Description
Generate example ID token

### Method
GET

### Endpoint
generate-example-id-token

### Parameters
#### Query Parameters
- **scope** (String) - Optional - Value of the "scope" parameter. Endpoint simulates generating of the ID-token as if the "scope" parameter with specified value is used. Could be null.
- **userId** (String) - Required - User ID
- **audience** (String) - Optional - Value of the "audience" parameter. Endpoint simulates generating of the access-token as if the "audience" parameter with specified value is used. Audience parameter is supported just for some grants (EG. for the token exchange). For most of the grants where "audience" parameter is not supported, it is better to use the value null to simulate generating of the appropriate token. Parameter is supported since Keycloak 26.2.

### Response
#### Success Response (200)
- **IDToken** - Generated ID token

```

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

### init(String name, Theme.Type type, ClassLoader classLoader)

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/theme/ClassLoaderTheme.html

Initializes the theme with the given name, type, and class loader. Throws IOException if initialization fails.

```APIDOC
## Method: init

### Description
Initializes the ClassLoaderTheme with the specified name, type, and class loader.

### Signature
public void init(String name, Theme.Type type, ClassLoader classLoader) throws IOException

### Parameters
- **name** (String) - Required - The name of the theme.
- **type** (Theme.Type) - Required - The type of the theme.
- **classLoader** (ClassLoader) - Required - The class loader used to load theme resources.

### Throws
- **IOException** - If initialization fails.
```

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

### GET generate-example-access-token

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/admin/client/resource/ClientScopeEvaluateResource.html

Generates an example access token simulating the specified scope and audience parameters.

```APIDOC
## GET generate-example-access-token

### Description
Generate example access token

### Method
GET

### Endpoint
generate-example-access-token

### Parameters
#### Query Parameters
- **scope** (String) - Optional - Value of the "scope" parameter. Endpoint simulates generating of the access-token as if the "scope" parameter with specified value is used. Could be null.
- **userId** (String) - Required - User ID
- **audience** (String) - Optional - Value of the "audience" parameter. Endpoint simulates generating of the access-token as if the "audience" parameter with specified value is used. Audience parameter is supported just for some grants (EG. for the token exchange). For most of the grants where "audience" parameter is not supported, it is better to use the value null to simulate generating of the appropriate token. Parameter is supported since Keycloak 26.2.

### Response
#### Success Response (200)
- **AccessToken** - Generated access token

```

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

### startSpan(String tracerName, String spanName)

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/tracing/TracingProvider.html

Gets or creates a tracer and starts a new span. The span must be manually ended with endSpan().

```APIDOC
## startSpan(String tracerName, String spanName)

### Description
Gets or creates a tracer instance, and starts a new `Span`. `Span.end()` **must** be manually called to end this `Span`, or use `trace(String, String, Consumer)` that handles it all.

### Method
`io.opentelemetry.api.trace.Span startSpan(String tracerName, String spanName)`

### Parameters
- **tracerName** (String) - Required - Name of `Tracer` that is obtained.
- **spanName** (String) - Required - Name of `Span` that is used.

### Returns
- `io.opentelemetry.api.trace.Span` - The newly created `Span`.

### Example
```java
class MyClass {
  private final TracingProvider tracing;

  MyClass(KeycloakSession session) {
    tracing = session.getProvider(TracingProvider.class);
  }

  void doWork() {
    tracing.startSpan("MyTracerName", "mySpanName");
    try {
      doSomeWork();
    } finally {
      tracing.endSpan();
    }
  }
}
```
```

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

### init(AdapterConfig, Object)

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/protocol/oidc/client/authentication/ClientIdAndSecretCredentialsProvider.html

Initializes the provider with deployment and configuration.

```APIDOC
## init(AdapterConfig deployment, Object config)

### Description
Called by the adapter during deployment of your application. You can read configuration and initialize your authenticator here.

### Method
`public void init(AdapterConfig deployment, Object config)`

### Parameters
- **deployment** (AdapterConfig) - The adapter configuration.
- **config** (Object) - The configuration of your provider read from keycloak.json. For example, for the kerberos-keytab provider, it returns a map with the single key "keytab" with value "/tmp/foo".

### Usage Example
```java
ClientCredentialsProvider provider = new ClientIdAndSecretCredentialsProvider();
provider.init(deployment, config);
```
```

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

### Start span with custom SpanBuilder

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/tracing/NoopTracingProvider.html

Example usage of startSpan(SpanBuilder) to create a span from a custom SpanBuilder instance. The preferred approach is to use trace() methods that manage the span lifecycle automatically.

```java
tracing.startSpan(tracer.spanBuilder("mySpan"))
```

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

### Profile.init(Profile.ProfileName profileName, Map<Profile.Feature,Boolean> features)

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/common/class-use/Profile.Feature.html

Initializes a Profile with the given profile name and feature map.

```APIDOC
## Profile.init(Profile.ProfileName profileName, Map<Profile.Feature,Boolean> features)

### Description
Initializes a Profile with the given profile name and feature map.

### Method
init

### Parameters
- **profileName** (Profile.ProfileName) - Required - The profile name.
- **features** (Map<Profile.Feature,Boolean>) - Required - A map of features to booleans.

### Returns
- **Profile** - The initialized Profile.

```

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

### GET /lb-check

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/services/resources/LoadBalancerResource.html

Returns the status for a load balancer in a multi-site setup. Returns HTTP 200 with 'UP' when the site should receive traffic, and HTTP 503 with 'DOWN' when it should not. The response is plain text and does not include internal state information.

```APIDOC
## GET /lb-check

### Description
Return the status for a load balancer in a multi-site setup if this Keycloak site should receive traffic. This endpoint is non-blocking and returns minimal information.

### Method
GET

### Endpoint
/lb-check

### Parameters
None

### Request Example
No request body required.

### Response
#### Success Response (200)
- **body** (string) - The text `UP` indicating the site should receive traffic.

#### Response Example
```
UP
```

#### Error Response (503)
- **body** (string) - The text `DOWN` indicating the site should not receive traffic.

#### Response Example
```
DOWN
```
```

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

### getStartTls()

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/representations/idm/TestLdapConnectionRepresentation.html

Returns the startTLS setting.

```APIDOC
## getStartTls()

### Description
Returns the startTLS setting.

### Method
Getter

### Signature
`public String getStartTls()`

### Parameters
None

### Returns
- **String** - The startTLS setting.
```

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

### GET /users/{id}/configured-user-storage-credential-types

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/services/resources/admin/UserResource.html

Return credential types, which are provided by the user storage where user is stored. 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.

```APIDOC
## [GET] /users/{id}/configured-user-storage-credential-types

### Description
Return credential types, which are provided by the user storage where user is stored. 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.

### Method
GET

### Endpoint
/users/{id}/configured-user-storage-credential-types

### Parameters
#### Path Parameters
- **id** (string) - Required - The user ID.

### Response
#### Success Response (200)
- **Stream<String>** - A stream of credential type strings.

#### Response Example
["password", "otp"]
```

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

### Profile.init(Profile.ProfileName profileName, Map<Profile.Feature,Boolean> features)

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/common/Profile.html

Initializes the profile with the given profile name and feature map.

```APIDOC
## init(Profile.ProfileName profileName, Map<Profile.Feature,Boolean> features)

### Description
Initializes the profile with the given profile name and feature map.

### Method
public static Profile init(Profile.ProfileName profileName, Map<Profile.Feature,Boolean> features)

### Parameters
- profileName (Profile.ProfileName) - Required - The profile name.
- features (Map<Profile.Feature,Boolean>) - Required - Map of features to their enabled state.

### Returns
- Profile - the initialized profile instance
```

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

### setupKeyPair(KeyPair keyPair, String algorithm)

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/protocol/oidc/client/authentication/JWTClientCredentialsProvider.html

Sets up the key pair and signing algorithm used for JWTs.

```APIDOC
## setupKeyPair(KeyPair keyPair, String algorithm)

### Description
Sets up the key pair and signing algorithm used for JWTs.

### Method
setupKeyPair

### Signature
public void setupKeyPair(KeyPair keyPair, String algorithm)

### Parameters
- **keyPair** (KeyPair) - Required - The key pair to use.
- **algorithm** (String) - Required - The signing algorithm to use.

```

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

### GET /members

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/admin/client/resource/GroupResource.html

Get users belonging to this group.

```APIDOC
## GET /members

### Description
Get users.

### Method
GET

### Endpoint
/members

### Response
#### Success Response (200)
- `List<UserRepresentation>` - The list of users.

#### Response Example
```json
[
  {
    "id": "userId",
    "username": "userName"
  }
]
```
```

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

### setupEncryption(KeycloakSession, SamlClient, BaseSAML2BindingBuilder<?>)

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/protocol/saml/SamlProtocolUtils.html

Sets up encryption for a SAML binding builder using client settings.

```APIDOC
## setupEncryption(KeycloakSession session, SamlClient samlClient, BaseSAML2BindingBuilder<?> bindingBuilder)

### Description
Sets up encryption for a SAML binding builder using client settings.

### Method
static void

### Signature
public static void setupEncryption(KeycloakSession session, SamlClient samlClient, BaseSAML2BindingBuilder<?> bindingBuilder) throws VerificationException

### Parameters
- **session** (KeycloakSession) - Required - The Keycloak session.
- **samlClient** (SamlClient) - Required - The SAML client.
- **bindingBuilder** (BaseSAML2BindingBuilder<?>) - Required - The binding builder to configure.

### Throws
- **VerificationException** - If encryption setup fails.

```

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

### GET /instances/{alias}

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/services/resources/admin/IdentityProvidersResource.html

Get an identity provider by alias.

```APIDOC
## GET /instances/{alias}

### Description
Get an identity provider by alias.

### Method
GET

### Endpoint
/instances/{alias}

### Parameters
#### Path Parameters
- **alias** (string) - Required - The alias of the identity provider

### Response
#### Success Response (200)
- **IdentityProviderResource** - The identity provider resource

### Response Example
```json
{
  "alias": "string"
}
```
```

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

### GET /logout-confirm

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/protocol/oidc/endpoints/LogoutEndpoint.html

Handles logout confirmation GET request.

```APIDOC
## GET /logout-confirm

### Description
Handles logout confirmation GET request.

### Method
GET

### Endpoint
/logout-confirm

### Response
#### Success Response
Returns a jakarta.ws.rs.core.Response.
```

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

### create()

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/provider/KeycloakDeploymentInfo.html

Creates a new KeycloakDeploymentInfo instance.

```APIDOC
## create()

### Description
Creates a new KeycloakDeploymentInfo instance.

### Method
create

### Signature
public static KeycloakDeploymentInfo create()

### Returns
- **KeycloakDeploymentInfo** - a new instance.
```

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

### getInstance(String serverUrl, String realm, String username, String password, String clientId, String clientSecret, SSLContext sslContext, Object customJacksonProvider, boolean disableTrustManager, String authToken, String scope)

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/admin/client/Keycloak.html

Creates a Keycloak admin client instance with full configuration options. This is the primary factory method that other overloads delegate to.

```APIDOC
## getInstance(String serverUrl, String realm, String username, String password, String clientId, String clientSecret, SSLContext sslContext, Object customJacksonProvider, boolean disableTrustManager, String authToken, String scope)

### Description
Creates a Keycloak admin client instance with full configuration options. This is the primary factory method that other overloads delegate to.

### Method
STATIC

### Signature
public static Keycloak getInstance(String serverUrl, String realm, String username, String password, String clientId, String clientSecret, SSLContext sslContext, Object customJacksonProvider, boolean disableTrustManager, String authToken, String scope)

### Parameters
- **serverUrl** (String) - Required - Keycloak server URL
- **realm** (String) - Required - realm name
- **username** (String) - Required - username of the admin user to be used.
- **password** (String) - Required - password of the admin user
- **clientId** (String) - Required - client ID
- **clientSecret** (String) - Required - client secret. Could be left null in case that clientId parameter points to the public client, which does not require client authentication
- **sslContext** (SSLContext) - Required - ssl context. Could be left null in case that default SSL context should be used.
- **customJacksonProvider** (Object) - Required - custom Jackson provider. Could be left null in case that Jackson provider will be automatically provided by the admin client. Please see the documentation for additional details regarding the compatibility
- **disableTrustManager** (boolean) - Required - If to disable trust manager for SSL checks. It is false by default. The value true should be used just for the development purposes, but should not be used in production
- **authToken** (String) - Required - access token to be used to call admin REST API. This can be left null if you want admin client to login the user (based on the parameters username, password, clientId and clientSecret) and manage it's own login session. But in case you already have existing session, you can inject the existing access token with the use of this parameter. In that case, it is recommended to leave the properties username, password, clientId or clientSecret empty
- **scope** (String) - Required - Custom "scope" parameter to be used. Could be left null in case of default scope should be used. That is sufficient for most of the cases.

### Returns
Java admin client instance
```

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

### ScriptProviderMetadata(String name, String fileName, String description)

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/representations/provider/ScriptProviderMetadata.html

Constructor that initializes a ScriptProviderMetadata instance with the given name, file name, and description.

```APIDOC
## ScriptProviderMetadata(String name, String fileName, String description)

### Description
Constructor that initializes a ScriptProviderMetadata instance with the given name, file name, and description.

### Method
Constructor

### Signature
`public ScriptProviderMetadata(String name, String fileName, String description)`

### Parameters
- **name** (String) - Required - The name of the script provider.
- **fileName** (String) - Required - The file name of the script provider.
- **description** (String) - Required - The description of the script provider.

```

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

### GET getKeyMetadata

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/admin/client/resource/KeyResource.html

Retrieves the key metadata for the realm. This method is annotated with @GET and @Produces("application/json"), indicating it is an HTTP GET request that returns JSON.

```APIDOC
## GET getKeyMetadata

### Description
Retrieves the key metadata for the realm.

### Method
GET

### Endpoint
Not specified in source.

### Parameters
None

### Response
#### Success Response (200)
- **KeysMetadataRepresentation** - The key metadata representation.

#### Response Example
Not provided in source.
```

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

### GET /users/{id}/credentials

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/services/resources/admin/UserResource.html

Get credentials associated with the user.

```APIDOC
## [GET] /users/{id}/credentials

### Description
Get credentials associated with the user.

### Method
GET

### Endpoint
/users/{id}/credentials

### Parameters
#### Path Parameters
- **id** (string) - Required - The user ID.

### Response
#### Success Response (200)
- **Stream<CredentialRepresentation>** - A stream of credential representations.

#### Response Example
[
  {
    "type": "password",
    "createdDate": 1234567890
  }
]
```

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

### setupKeyPair(KeyPair keyPair)

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/protocol/oidc/client/authentication/JWTClientCredentialsProvider.html

Sets up the key pair used for signing JWTs.

```APIDOC
## setupKeyPair(KeyPair keyPair)

### Description
Sets up the key pair used for signing JWTs.

### Method
setupKeyPair

### Signature
public void setupKeyPair(KeyPair keyPair)

### Parameters
- **keyPair** (KeyPair) - Required - The key pair to use.

```

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

### setupAuthorizationServices

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/models/utils/KeycloakModelUtils.html

Sets up authorization services for a realm.

```APIDOC
## setupAuthorizationServices

### Description
Sets up authorization services for a realm.

### Method
STATIC

### Signature
public static void setupAuthorizationServices(RealmModel realm)

### Parameters
- `realm` (RealmModel) - Required - The realm for which to set up authorization services.
```

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

### GET /users/{id}/consents

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/services/resources/admin/UserResource.html

Get consents granted by the user.

```APIDOC
## [GET] /users/{id}/consents

### Description
Get consents granted by the user.

### Method
GET

### Endpoint
/users/{id}/consents

### Parameters
#### Path Parameters
- **id** (string) - Required - The user ID.

### Response
#### Success Response (200)
- **Stream<Map<String,Object>>** - A stream of consent maps.

#### Response Example
[
  {
    "clientId": "my-client",
    "grantedScopes": ["profile"]
  }
]
```

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

### GET /users/{id}/sessions

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/services/resources/admin/UserResource.html

Get sessions associated with the user.

```APIDOC
## [GET] /users/{id}/sessions

### Description
Get sessions associated with the user.

### Method
GET

### Endpoint
/users/{id}/sessions

### Parameters
#### Path Parameters
- **id** (string) - Required - The user ID.

### Response
#### Success Response (200)
- **Stream<UserSessionRepresentation>** - A stream of user session representations.

#### Response Example
[
  {
    "id": "session-id",
    "start": 1234567890
  }
]
```

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

### Configuration(String authServerUrl, String realm, String clientId, Map<String,Object> clientCredentials, org.apache.http.client.HttpClient httpClient)

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/authorization/client/Configuration.html

Creates a new Configuration instance with the specified authorization server URL, realm, client ID, client credentials, and HTTP client. This constructor is used to initialize the client configuration for authorization requests.

```APIDOC
## Configuration(String authServerUrl, String realm, String clientId, Map<String,Object> clientCredentials, org.apache.http.client.HttpClient httpClient)

### Description
Creates a new Configuration instance with the specified authorization server URL, realm, client ID, client credentials, and HTTP client.

### Constructor Parameters
- **authServerUrl** (String) - Required - The URL of the Keycloak authorization server.
- **realm** (String) - Required - The realm name.
- **clientId** (String) - Required - The client ID.
- **clientCredentials** (Map<String,Object>) - Required - A map of client credentials.
- **httpClient** (org.apache.http.client.HttpClient) - Required - The HTTP client to use for requests.

### Usage Example
```java
Configuration config = new Configuration(
    "https://auth.example.com",
    "my-realm",
    "my-client",
    clientCredentials,
    httpClient
);
```
```

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

### getHelpText()

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/representations/idm/UserFederationProviderFactoryRepresentation.html

Returns the help text for the user federation provider factory.

```APIDOC
## getHelpText()

### Description
Retrieves the help text for the user federation provider factory.

### Method
Getter

### Signature
`public String getHelpText()`

### Parameters
None

### Returns
- **String** - The help text.
```

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

### GET /members (with pagination)

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/admin/client/resource/GroupResource.html

Get users belonging to this group with pagination.

```APIDOC
## GET /members

### Description
Get users.

### Method
GET

### Endpoint
/members

### Parameters
#### Query Parameters
- `firstResult` (Integer) - Optional - The position of the first result to be returned.
- `maxResults` (Integer) - Optional - The maximum number of results that are to be returned.

### Response
#### Success Response (200)
- `List<UserRepresentation>` - The list of users.

#### Response Example
```json
[
  {
    "id": "userId",
    "username": "userName"
  }
]
```
```

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

### init(Config.ConfigProvider configProvider)

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/Config.html

Initializes the configuration with a provided config provider. This method must be called before using other configuration methods.

```APIDOC
## init(Config.ConfigProvider configProvider)

### Description
Initializes the configuration with a provided config provider. This method must be called before using other configuration methods.

### Method
static void

### Signature
public static void init(Config.ConfigProvider configProvider)

### Parameters
- **configProvider** (Config.ConfigProvider) - Required - The configuration provider to use.

### Returns
void
```

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

### GET /users/{id}/federated-identity

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/services/resources/admin/UserResource.html

Get social logins associated with the user.

```APIDOC
## [GET] /users/{id}/federated-identity

### Description
Get social logins associated with the user.

### Method
GET

### Endpoint
/users/{id}/federated-identity

### Parameters
#### Path Parameters
- **id** (string) - Required - The user ID.

### Response
#### Success Response (200)
- **Stream<FederatedIdentityRepresentation>** - A non-null stream of social logins (federated identities).

#### Response Example
[
  {
    "identityProvider": "google",
    "userId": "google-user-id"
  }
]
```

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

### getInstance(String serverUrl, String realm, String username, String password, String clientId, String clientSecret)

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/admin/client/Keycloak.html

Creates a Keycloak admin client instance with minimal configuration. Delegates to the full getInstance method with default values for optional parameters.

```APIDOC
## getInstance(String serverUrl, String realm, String username, String password, String clientId, String clientSecret)

### Description
Creates a Keycloak admin client instance with minimal configuration. Delegates to the full getInstance method with default values for optional parameters.

### Method
STATIC

### Signature
public static Keycloak getInstance(String serverUrl, String realm, String username, String password, String clientId, String clientSecret)

### Parameters
See `getInstance(String, String, String, String, String, String, SSLContext, Object, boolean, String, String)` for the details about the parameters and their default values

### Returns
Java admin client instance
```

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

### GET /providers/{provider_id}

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/services/resources/admin/IdentityProvidersResource.html

Get the identity provider factory for a provider id.

```APIDOC
## GET /providers/{provider_id}

### Description
Get the identity provider factory for a provider id.

### Method
GET

### Endpoint
/providers/{provider_id}

### Parameters
#### Path Parameters
- **provider_id** (string) - Required - Provider id

### Response
#### Success Response (200)
- **IdentityProviderFactory** - The identity provider factory

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

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

### getStartupTime

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/models/UserSessionProvider.html

Returns the startup time of the realm.

```APIDOC
## getStartupTime

### Description
Returns the startup time of the realm.

### Method
int getStartupTime(RealmModel realm)

### Parameters
- **realm** (RealmModel) - Required - A reference to the realm.

### Returns
- **int** - The startup time.
```

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

### get(String path)

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/authorization/client/util/Http.html

Creates an HTTP GET request to the specified path.

```APIDOC
## get(String path)

### Description
Creates an HTTP GET request to the specified path.

### Method
GET

### Parameters
- **path** (String) - Required - The path to send the GET request to.

### Returns
- **HttpMethod<R>** - A request object that can be executed to obtain the response.

### Example
```java
HttpMethod<String> request = http.get("/realms/{realm}/protocol/openid-connect/userinfo");
```
```

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

### get(id) - Get invitation by ID

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/admin/client/resource/OrganizationInvitationsResource.html

Returns a single invitation by its ID.

```APIDOC
## GET /organizations/{orgId}/invitations/{id}

### Description
Get invitation by ID.

### Method
GET

### Endpoint
/organizations/{orgId}/invitations/{id}

### Parameters
#### Path Parameters
- **orgId** (string) - Required - The organization ID.
- **id** (string) - Required - The invitation ID.

### Response
#### Success Response (200)
- **OrganizationInvitationRepresentation** - The invitation representation.

#### Response Example
```json
{
  "id": "string",
  "email": "string",
  "status": "string"
}
```
```

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

### getInstance(String serverUrl, String realm, String username, String password, String clientId, String clientSecret, SSLContext sslContext, Object customJacksonProvider, boolean disableTrustManager, String authToken)

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/admin/client/Keycloak.html

Creates a Keycloak admin client instance with a subset of configuration options. Delegates to the full getInstance method with default scope.

```APIDOC
## getInstance(String serverUrl, String realm, String username, String password, String clientId, String clientSecret, SSLContext sslContext, Object customJacksonProvider, boolean disableTrustManager, String authToken)

### Description
Creates a Keycloak admin client instance with a subset of configuration options. Delegates to the full getInstance method with default scope.

### Method
STATIC

### Signature
public static Keycloak getInstance(String serverUrl, String realm, String username, String password, String clientId, String clientSecret, SSLContext sslContext, Object customJacksonProvider, boolean disableTrustManager, String authToken)

### Parameters
See `getInstance(String, String, String, String, String, String, SSLContext, Object, boolean, String, String)` for the details about the parameters and their default values

### Returns
Java admin client instance
```

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

### GET /users/{id}/offline-sessions/{clientUuid}

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/services/resources/admin/UserResource.html

Get offline sessions associated with the user and client.

```APIDOC
## [GET] /users/{id}/offline-sessions/{clientUuid}

### Description
Get offline sessions associated with the user and client.

### Method
GET

### Endpoint
/users/{id}/offline-sessions/{clientUuid}

### Parameters
#### Path Parameters
- **id** (string) - Required - The user ID.
- **clientUuid** (string) - Required - The client UUID.

### Response
#### Success Response (200)
- **Stream<UserSessionRepresentation>** - A stream of user session representations.

#### Response Example
[
  {
    "id": "offline-session-id",
    "start": 1234567890
  }
]
```

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

### getHelpText

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/credential/CredentialTypeMetadata.html

Returns the help text shown to users on screens like the login screen with available authentication mechanisms.

```APIDOC
## getHelpText

### Description
Returns the help text shown to users on screens like the login screen with available authentication mechanisms. This text references this particular authenticator type. It can be a message key for localization.

### Method
public String getHelpText()

### Returns
- **String** - The help text or message key.
```

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

### GET /admin/realms/{realm}/default-optional-client-scopes

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/services/resources/admin/RealmAdminResource.html

Get realm optional client scopes. Only name and ids are returned.

```APIDOC
## GET /admin/realms/{realm}/default-optional-client-scopes

### Description
Get realm optional client scopes. Only name and ids are returned.

### Method
GET

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - The realm name.

### Response
#### Success Response (200)
- **Stream<ClientScopeRepresentation>** - A list of client scope representations.

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

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

### getInstance(String serverUrl, String realm, String username, String password, String clientId)

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/admin/client/Keycloak.html

Creates a Keycloak admin client instance with basic authentication parameters. Delegates to the full getInstance method with default values for optional parameters.

```APIDOC
## getInstance(String serverUrl, String realm, String username, String password, String clientId)

### Description
Creates a Keycloak admin client instance with basic authentication parameters. Delegates to the full getInstance method with default values for optional parameters.

### Method
STATIC

### Signature
public static Keycloak getInstance(String serverUrl, String realm, String username, String password, String clientId)

### Parameters
See `getInstance(String, String, String, String, String, String, SSLContext, Object, boolean, String, String)` for the details about the parameters and their default values

### Returns
Java admin client instance
```

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

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

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/services/resources/admin/RealmAdminResource.html

Get realm default client scopes. Only name and ids are returned.

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

### Description
Get realm default client scopes. Only name and ids are returned.

### Method
GET

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

### Parameters
#### Path Parameters
- **realm** (string) - Required - The realm name.

### Response
#### Success Response (200)
- **Stream<ClientScopeRepresentation>** - A list of client scope representations.

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

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

### isRegisterNodeAtStartup()

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/representations/adapters/config/AdapterConfig.html

Checks whether the node should be registered at startup.

```APIDOC
## isRegisterNodeAtStartup()

### Description
Checks whether the node should be registered at startup.

### Method
isRegisterNodeAtStartup

### Parameters
None.

### Response
- **boolean** - Returns true if the node should be registered at startup, false otherwise.
```

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

### create()

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/authorization/client/AuthzClient.html

Creates a new AuthzClient instance using a keycloak.json file from the classpath.

```APIDOC
## create()

### Description
Creates a new AuthzClient instance. This method expects a `keycloak.json` in the classpath, otherwise an exception will be thrown.

### Method
create

### Signature
public static AuthzClient create() throws RuntimeException

### Returns
- a new instance

### Throws
- `RuntimeException` - in case there is no `keycloak.json` file in the classpath or the file could not be parsed
```

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

### GET /users/profile

Source: https://www.keycloak.org/docs-api/latest/javadocs/org/keycloak/services/resources/admin/UsersResource.html

Get representation of the user profile. This endpoint returns a UserProfileResource for the given user id.

```APIDOC
## GET /users/profile

### Description
Get representation of the user profile. This endpoint returns a UserProfileResource for the given user id.

### Method
GET

### Endpoint
/users/profile

### Parameters
#### Path Parameters
- **id** (String) - Required - User id

### Response
#### Success Response (200)
- Returns a UserProfileResource representation

#### Response Example
```json
{
  "userProfileResource": {}
}
```
```
Tokens:
Raw