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

Interface KeycloakAdminClientConfig

@ConfigMapping(prefix="quarkus.keycloak.admin-client")
@ConfigRoot(phase=RUN_TIME)
public interface KeycloakAdminClientConfig

Keycloak Admin Client

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	KeycloakAdminClientConfig.GrantType

Method Summary

Modifier and Type	Method	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.

Method Details

serverUrl

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

@WithDefault("master")
String realm()

Realm.

clientId

@WithDefault("admin-cli")
String clientId()

Client id.

clientSecret

Optional<String> clientSecret()

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

username

@WithDefault("admin")
Optional<String> username()

Username. Required with a `password` grant type.

password

@WithDefault("admin")
Optional<String> password()

Password. Required with a `password` grant type.

scope

Optional<String> scope()

OAuth 2.0 Access Token Scope.

grantType

@WithDefault("PASSWORD")
KeycloakAdminClientConfig.GrantType grantType()

OAuth Grant Type.