org.keycloak.services.resources.admin

Class ClientResource

java.lang.Object

org.keycloak.services.resources.admin.ClientResource

public class ClientResource
extends Object

Base resource class for managing one particular client of a realm.

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field and Description
protected ClientModel	client
protected KeycloakApplication	keycloak
protected static org.jboss.logging.Logger	logger
protected RealmModel	realm
protected KeycloakSession	session
protected javax.ws.rs.core.UriInfo	uriInfo

Constructor Summary

Constructors

Constructor and Description
ClientResource(RealmModel realm, RealmAuth auth, ClientModel clientModel, KeycloakSession session, AdminEventBuilder adminEvent)

Method Summary

Modifier and Type	Method and Description
void	deleteAllowedOrigins(Set<String> allowedOrigins) Delete the specified origins from current allowed origins This is used for CORS requests.
void	deleteClient() Delete the client
Set<String>	getAllowedOrigins() Get allowed origins This is used for CORS requests.
Map<String,Long>	getApplicationSessionCount() Get application session count Returns a number of user sessions associated with this client { "count": number }
ClientAttributeCertificateResource	getCertficateResource(String attributePrefix) Get representation of certificate resource
ClientRepresentation	getClient() Get representation of the client
CredentialRepresentation	getClientSecret() Get the client secret
String	getInstallation() Deprecated.
javax.ws.rs.core.Response	getInstallationProvider(String providerId)
String	getJBossInstallation() Deprecated.
protected KeycloakApplication	getKeycloakApplication()
Map<String,Long>	getOfflineSessionCount() Get application offline session count Returns a number of offline user sessions associated with this client { "count": number }
List<UserSessionRepresentation>	getOfflineUserSessions(Integer firstResult, Integer maxResults) Get offline sessions for client Returns a list of offline user sessions associated with this client
ProtocolMappersResource	getProtocolMappers()
RoleContainerResource	getRoleContainerResource()
ScopeMappedResource	getScopeMappedResource() Base path for managing the scope mappings for the client
UserRepresentation	getServiceAccountUser() Get a user dedicated to the service account
List<UserSessionRepresentation>	getUserSessions(Integer firstResult, Integer maxResults) Get user sessions for client Returns a list of user sessions associated with this client
void	logout(String username) Logout the user by username If the client has an admin URL, invalidate the sessions for a particular user directly.
GlobalRequestResult	logoutAll() Logout all sessions If the client has an admin URL, invalidate all sessions associated with that client directly.
GlobalRequestResult	pushRevocation() Push the client's revocation policy to its admin URL If the client has an admin URL, push revocation policy to it.
ClientRepresentation	regenerateRegistrationAccessToken() Generate a new registration access token for the client
CredentialRepresentation	regenerateSecret() Generate a new secret for the client
void	registerNode(Map<String,String> formParams) Register a cluster node with the client Manually register cluster node to this client - usually it's not needed to call this directly as adapter should handle by sending registration request to Keycloak
GlobalRequestResult	testNodesAvailable() Test if registered cluster nodes are available Tests availability by sending 'ping' request to all cluster nodes.
void	unregisterNode(String node) Unregister a cluster node from the client
javax.ws.rs.core.Response	update(ClientRepresentation rep) Update the client
void	updateAllowedOrigins(Set<String> allowedOrigins) Update allowed origins This is used for CORS requests.
static void	updateClientFromRep(ClientRepresentation rep, ClientModel client, KeycloakSession session)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.jboss.logging.Logger logger

realm

protected RealmModel realm

client

protected ClientModel client

session

protected KeycloakSession session

uriInfo

@Context
protected javax.ws.rs.core.UriInfo uriInfo

keycloak

@Context
protected KeycloakApplication keycloak

Constructor Detail

ClientResource

public ClientResource(RealmModel realm,
                      RealmAuth auth,
                      ClientModel clientModel,
                      KeycloakSession session,
                      AdminEventBuilder adminEvent)

Method Detail

getKeycloakApplication

protected KeycloakApplication getKeycloakApplication()

getProtocolMappers

public ProtocolMappersResource getProtocolMappers()

update

public javax.ws.rs.core.Response update(ClientRepresentation rep)

Update the client

Parameters:

rep -

Returns:

updateClientFromRep

public static void updateClientFromRep(ClientRepresentation rep,
                                       ClientModel client,
                                       KeycloakSession session)
                                throws ModelDuplicateException

Throws:

ModelDuplicateException

getClient

public ClientRepresentation getClient()

Get representation of the client

Returns:

getCertficateResource

public ClientAttributeCertificateResource getCertficateResource(String attributePrefix)

Get representation of certificate resource

Parameters:

attributePrefix -

Returns:

getInstallationProvider

public javax.ws.rs.core.Response getInstallationProvider(String providerId)

getInstallation

@Deprecated
public String getInstallation()
                                   throws IOException

Deprecated.

Get keycloak.json file this method is deprecated, see getInstallationProvider Returns a keycloak.json file to be used to configure the adapter of the specified client.

Returns:

Throws:

IOException

getJBossInstallation

@Deprecated
public String getJBossInstallation()
                                        throws IOException

Deprecated.

Get adapter configuration XML for JBoss / Wildfly Keycloak subsystem this method is deprecated, see getInstallationProvider Returns XML that can be included in the JBoss / Wildfly Keycloak subsystem to configure the adapter of that client.

Returns:

Throws:

IOException

deleteClient

public void deleteClient()

Delete the client

regenerateSecret

public CredentialRepresentation regenerateSecret()

Generate a new secret for the client

Returns:

regenerateRegistrationAccessToken

public ClientRepresentation regenerateRegistrationAccessToken()

Generate a new registration access token for the client

Returns:

getClientSecret

public CredentialRepresentation getClientSecret()

Get the client secret

Returns:

getScopeMappedResource

public ScopeMappedResource getScopeMappedResource()

Base path for managing the scope mappings for the client

Returns:

getRoleContainerResource

public RoleContainerResource getRoleContainerResource()

getAllowedOrigins

public Set<String> getAllowedOrigins()

Get allowed origins This is used for CORS requests. Access tokens will have their allowedOrigins claim set to this value for tokens created for this client.

Returns:

updateAllowedOrigins

public void updateAllowedOrigins(Set<String> allowedOrigins)

Update allowed origins This is used for CORS requests. Access tokens will have their allowedOrigins claim set to this value for tokens created for this client.

Parameters:

allowedOrigins -

deleteAllowedOrigins

public void deleteAllowedOrigins(Set<String> allowedOrigins)

Delete the specified origins from current allowed origins This is used for CORS requests. Access tokens will have their allowedOrigins claim set to this value for tokens created for this client.

Parameters:

allowedOrigins - List of origins to delete

getServiceAccountUser

public UserRepresentation getServiceAccountUser()

Get a user dedicated to the service account

Returns:

pushRevocation

public GlobalRequestResult pushRevocation()

Push the client's revocation policy to its admin URL If the client has an admin URL, push revocation policy to it.

getApplicationSessionCount

public Map<String,Long> getApplicationSessionCount()

Get application session count Returns a number of user sessions associated with this client { "count": number }

Returns:

getUserSessions

public List<UserSessionRepresentation> getUserSessions(Integer firstResult,
                                                       Integer maxResults)

Get user sessions for client Returns a list of user sessions associated with this client

Parameters:

firstResult - Paging offset

maxResults - Paging size

Returns:

getOfflineSessionCount

public Map<String,Long> getOfflineSessionCount()

Get application offline session count Returns a number of offline user sessions associated with this client { "count": number }

Returns:

getOfflineUserSessions

public List<UserSessionRepresentation> getOfflineUserSessions(Integer firstResult,
                                                              Integer maxResults)

Get offline sessions for client Returns a list of offline user sessions associated with this client

Parameters:

firstResult - Paging offset

maxResults - Paging size

Returns:

logoutAll

public GlobalRequestResult logoutAll()

Logout all sessions If the client has an admin URL, invalidate all sessions associated with that client directly.

logout

public void logout(String username)

Logout the user by username If the client has an admin URL, invalidate the sessions for a particular user directly.

registerNode

public void registerNode(Map<String,String> formParams)

Register a cluster node with the client Manually register cluster node to this client - usually it's not needed to call this directly as adapter should handle by sending registration request to Keycloak

Parameters:

formParams -

unregisterNode

public void unregisterNode(String node)

Unregister a cluster node from the client

Parameters:

node -

testNodesAvailable

public GlobalRequestResult testNodesAvailable()

Test if registered cluster nodes are available Tests availability by sending 'ping' request to all cluster nodes.

Returns: