Package io.quarkus.keycloak.admin.client.common

Class KeycloakAdminClientConfig

java.lang.Object

io.quarkus.keycloak.admin.client.common.KeycloakAdminClientConfig

@ConfigRoot(phase=RUN_TIME,
            name="keycloak.admin-client")
public class KeycloakAdminClientConfig
extends Object

Keycloak Admin Client

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	KeycloakAdminClientConfig.GrantType

Field Summary

Fields

Modifier and Type	Field	Description
String	clientId	Client id.
Optional<String>	clientSecret	Client secret.
KeycloakAdminClientConfig.GrantType	grantType	OAuth Grant Type.
Optional<String>	password	Password.
String	realm	Realm.
Optional<String>	scope	OAuth 2.0 Access Token Scope.
Optional<String>	serverUrl	Keycloak server URL, for example, `https://host:port`.
Optional<String>	username	Username.

Constructor Summary

Constructors

Constructor	Description
KeycloakAdminClientConfig()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

serverUrl

@ConfigItem
public Optional<String> serverUrl

Keycloak server URL, for example, `https://host:port`. If this property is not set then the Keycloak Admin Client injection will fail - use org.keycloak.admin.client.KeycloakBuilder to create it instead.

realm

@ConfigItem(defaultValue="master")
public String realm

Realm.

clientId

@ConfigItem(defaultValue="admin-cli")
public String clientId

Client id.

clientSecret

@ConfigItem
public Optional<String> clientSecret

Client secret. Required with a `client_credentials` grant type.

username

@ConfigItem(defaultValue="admin")
public Optional<String> username

Username. Required with a `password` grant type.

password

@ConfigItem(defaultValue="admin")
public Optional<String> password

Password. Required with a `password` grant type.

scope

@ConfigItem
public Optional<String> scope

OAuth 2.0 Access Token Scope.

grantType

@ConfigItem(defaultValue="PASSWORD")
public KeycloakAdminClientConfig.GrantType grantType

OAuth Grant Type.

Constructor Details

KeycloakAdminClientConfig

public KeycloakAdminClientConfig()