Package org.keycloak.admin.client

Class Keycloak

java.lang.Object

org.keycloak.admin.client.Keycloak

All Implemented Interfaces:

AutoCloseable

public class Keycloak
extends Object
implements AutoCloseable

Provides a Keycloak client. By default, this implementation uses a the default RestEasy client builder settings. To customize the underling client, use a KeycloakBuilder to create a Keycloak client. To read Responses, you can use CreatedResponseUtil for objects created

Author:

rodrigo.sasaki@icarros.com.br

See Also:

• KeycloakBuilder

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the underlying client.
static ResteasyClientProvider	getClientProvider()
static Keycloak	getInstance(String serverUrl, String realm, String clientId, String authToken)	See getInstance(String, String, String, String, String, String, SSLContext, Object, boolean, String, String) for the details about the parameters and their default values
static Keycloak	getInstance(String serverUrl, String realm, String username, String password, String clientId)	See getInstance(String, String, String, String, String, String, SSLContext, Object, boolean, String, String) for the details about the parameters and their default values
static Keycloak	getInstance(String serverUrl, String realm, String username, String password, String clientId, String clientSecret)	See getInstance(String, String, String, String, String, String, SSLContext, Object, boolean, String, String) for the details about the parameters and their default values
static Keycloak	getInstance(String serverUrl, String realm, String username, String password, String clientId, String clientSecret, SSLContext sslContext)	See getInstance(String, String, String, String, String, String, SSLContext, Object, boolean, String, String) for the details about the parameters and their default values
static Keycloak	getInstance(String serverUrl, String realm, String username, String password, String clientId, String clientSecret, SSLContext sslContext, Object customJacksonProvider)	See getInstance(String, String, String, String, String, String, SSLContext, Object, boolean, String, String) for the details about the parameters and their default values
static Keycloak	getInstance(String serverUrl, String realm, String username, String password, String clientId, String clientSecret, SSLContext sslContext, Object customJacksonProvider, boolean disableTrustManager, String authToken)	See getInstance(String, String, String, String, String, String, SSLContext, Object, boolean, String, String) for the details about the parameters and their default values
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)	Creates the java admin client instance to be used to call admin REST API against Keycloak server.
static Keycloak	getInstance(String serverUrl, String realm, String username, String password, String clientId, SSLContext sslContext)	See getInstance(String, String, String, String, String, String, SSLContext, Object, boolean, String, String) for the details about the parameters and their default values
static Keycloak	getInstance(String serverUrl, String realm, String clientId, String authToken, SSLContext sllSslContext)	See getInstance(String, String, String, String, String, String, SSLContext, Object, boolean, String, String) for the details about the parameters and their default values
boolean	isClosed()
<T> T	proxy(Class<T> proxyClass, URI absoluteURI)	Create a secure proxy based on an absolute URI.
RealmResource	realm(String realmName)
RealmsResource	realms()
ServerInfoResource	serverInfo()
static void	setClientProvider(ResteasyClientProvider provider)
TokenManager	tokenManager()

Methods inherited from class java.lang.Object

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

Method Details

setClientProvider

public static void setClientProvider(ResteasyClientProvider provider)

getClientProvider

public static ResteasyClientProvider getClientProvider()

getInstance

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)

Creates the java admin client instance to be used to call admin REST API against Keycloak server.

Parameters:

serverUrl - Keycloak server URL

realm - realm name

username - username of the admin user to be used.

password - password of the admin user

clientId - client ID

clientSecret - client secret. Could be left null in case that clientId parameter points to the public client, which does not require client authentication

sslContext - ssl context. Could be left null in case that default SSL context should be used.

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

getInstance

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

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

getInstance

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

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

getInstance

public static Keycloak getInstance(String serverUrl,
 String realm,
 String username,
 String password,
 String clientId,
 String clientSecret,
 SSLContext sslContext)

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

getInstance

public static Keycloak getInstance(String serverUrl,
 String realm,
 String username,
 String password,
 String clientId,
 String clientSecret,
 SSLContext sslContext,
 Object customJacksonProvider)

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

getInstance

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

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

getInstance

public static Keycloak getInstance(String serverUrl,
 String realm,
 String username,
 String password,
 String clientId,
 SSLContext sslContext)

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

getInstance

public static Keycloak getInstance(String serverUrl,
 String realm,
 String clientId,
 String authToken)

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

getInstance

public static Keycloak getInstance(String serverUrl,
 String realm,
 String clientId,
 String authToken,
 SSLContext sllSslContext)

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

realms

public RealmsResource realms()

realm

public RealmResource realm(String realmName)

serverInfo

public ServerInfoResource serverInfo()

tokenManager

public TokenManager tokenManager()

proxy

public <T> T proxy(Class<T> proxyClass,
 URI absoluteURI)

Create a secure proxy based on an absolute URI. All set up with appropriate token

Type Parameters:

T -

Parameters:

proxyClass -

absoluteURI -

Returns:

close

public void close()

Closes the underlying client. After calling this method, this Keycloak instance cannot be reused.

Specified by:

close in interface AutoCloseable

isClosed

public boolean isClosed()

Returns:

true if the underlying client is closed.