org.keycloak.admin.client.resource

Interface ClientResource

public interface ClientResource

Author:

rodrigo.sasaki@icarros.com.br

Method Summary

Modifier and Type	Method and Description
void	addDefaultClientScope(String clientScopeId)
void	addOptionalClientScope(String clientScopeId)
AuthorizationResource	authorization()
CredentialRepresentation	generateNewSecret()
Map<String,Integer>	getApplicationSessionCount()
ClientAttributeCertificateResource	getCertficateResource(String attributePrefix) Get representation of certificate resource
List<ClientScopeRepresentation>	getDefaultClientScopes() Get default client scopes.
String	getInstallationProvider(String providerId)
Map<String,Long>	getOfflineSessionCount()
List<UserSessionRepresentation>	getOfflineUserSessions(Integer firstResult, Integer maxResults)
List<ClientScopeRepresentation>	getOptionalClientScopes() Get optional client scopes.
ManagementPermissionReference	getPermissions() Returns indicator if the fine grain permissions are enabled or not.
ProtocolMappersResource	getProtocolMappers()
RoleMappingResource	getScopeMappings()
CredentialRepresentation	getSecret()
UserRepresentation	getServiceAccountUser()
List<UserSessionRepresentation>	getUserSessions(Integer firstResult, Integer maxResults)
void	pushRevocation()
ClientRepresentation	regenerateRegistrationAccessToken() Generate a new registration access token for the client
void	registerNode(Map<String,String> formParams)
void	remove()
void	removeDefaultClientScope(String clientScopeId)
void	removeOptionalClientScope(String clientScopeId)
RolesResource	roles()
ManagementPermissionReference	setPermissions(ManagementPermissionRepresentation status) Enables or disables the fine grain permissions feature.
GlobalRequestResult	testNodesAvailable()
ClientRepresentation	toRepresentation()
void	unregisterNode(String node)
void	update(ClientRepresentation clientRepresentation)

Method Detail

setPermissions

ManagementPermissionReference setPermissions(ManagementPermissionRepresentation status)

Enables or disables the fine grain permissions feature. Returns the updated status of the server in the ManagementPermissionReference.

Parameters:

status - status request to apply

Returns:

permission reference indicating the updated status

getPermissions

ManagementPermissionReference getPermissions()

Returns indicator if the fine grain permissions are enabled or not.

Returns:

current representation of the permissions feature

getProtocolMappers

ProtocolMappersResource getProtocolMappers()

toRepresentation

ClientRepresentation toRepresentation()

update

void update(ClientRepresentation clientRepresentation)

remove

void remove()

generateNewSecret

CredentialRepresentation generateNewSecret()

getSecret

CredentialRepresentation getSecret()

regenerateRegistrationAccessToken

ClientRepresentation regenerateRegistrationAccessToken()

Generate a new registration access token for the client

Returns:

getCertficateResource

ClientAttributeCertificateResource getCertficateResource(String attributePrefix)

Get representation of certificate resource

Parameters:

attributePrefix -

Returns:

getInstallationProvider

String getInstallationProvider(String providerId)

getApplicationSessionCount

Map<String,Integer> getApplicationSessionCount()

getUserSessions

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

getOfflineSessionCount

Map<String,Long> getOfflineSessionCount()

getOfflineUserSessions

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

pushRevocation

void pushRevocation()

getScopeMappings

RoleMappingResource getScopeMappings()

roles

RolesResource roles()

getDefaultClientScopes

List<ClientScopeRepresentation> getDefaultClientScopes()

Get default client scopes. Only name and ids are returned.

Returns:

default client scopes

addDefaultClientScope

void addDefaultClientScope(String clientScopeId)

removeDefaultClientScope

void removeDefaultClientScope(String clientScopeId)

getOptionalClientScopes

List<ClientScopeRepresentation> getOptionalClientScopes()

Get optional client scopes. Only name and ids are returned.

Returns:

optional client scopes

addOptionalClientScope

void addOptionalClientScope(String clientScopeId)

removeOptionalClientScope

void removeOptionalClientScope(String clientScopeId)

getServiceAccountUser

UserRepresentation getServiceAccountUser()

registerNode

void registerNode(Map<String,String> formParams)

unregisterNode

void unregisterNode(String node)

testNodesAvailable

GlobalRequestResult testNodesAvailable()

authorization

AuthorizationResource authorization()