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

Interface KeycloakAdminClientConfig

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

  • Method Details

    • serverUrl

      Optional<String> serverUrl()
      Keycloak server URL, for example, `https://host:port`. When the Keycloak Dev Services is started and this property is not configured, Quarkus points the 'quarkus.keycloak.admin-client.server-url' configuration property to started Keycloak container. In other cases, when this property is not set then the Keycloak Admin Client injection will fail - use
      invalid reference 
      org.keycloak.admin.client.KeycloakBuilder
      to create the client 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.

    • tlsConfigurationName

      Optional<String> tlsConfigurationName()
      The name of the TLS configuration to use.

      If a name is configured, it uses the configuration from quarkus.tls.<name>.* If a name is configured, but no TLS configuration is found with that name then an error will be thrown.

      The default TLS configuration is not used by default.