org.keycloak.admin.client.resource

Interface ClientResource

public interface ClientResource

Author:

rodrigo.sasaki@icarros.com.br

Method Summary

Modifier and Type	Method and Description
CredentialRepresentation	generateNewSecret()
Map<String,Integer>	getApplicationSessionCount()
ClientAttributeCertificateResource	getCertficateResource(String attributePrefix) Get representation of certificate resource
String	getInstallationProvider(String providerId)
ProtocolMappersResource	getProtocolMappers()
RoleMappingResource	getScopeMappings()
CredentialRepresentation	getSecret()
List<UserSessionRepresentation>	getUserSessions(Integer firstResult, Integer maxResults)
void	pushRevocation()
ClientRepresentation	regenerateRegistrationAccessToken() Generate a new registration access token for the client
void	remove()
RolesResource	roles()
ClientRepresentation	toRepresentation()
void	update(ClientRepresentation clientRepresentation)

Method Detail

getProtocolMappers

@Path(value="protocol-mappers")
ProtocolMappersResource getProtocolMappers()

toRepresentation

@GET
 @Produces(value="application/json")
ClientRepresentation toRepresentation()

update

@PUT
 @Consumes(value="application/json")
void update(ClientRepresentation clientRepresentation)

remove

@DELETE
void remove()

generateNewSecret

@POST
 @Path(value="client-secret")
 @Produces(value="application/json")
CredentialRepresentation generateNewSecret()

getSecret

@GET
 @Path(value="client-secret")
 @Produces(value="application/json")
CredentialRepresentation getSecret()

regenerateRegistrationAccessToken

@Path(value="registration-access-token")
 @POST
 @Produces(value="application/json")
 @Consumes(value="application/json")
ClientRepresentation regenerateRegistrationAccessToken()

Generate a new registration access token for the client

Returns:

getCertficateResource

@Path(value="certificates/{attr}")
ClientAttributeCertificateResource getCertficateResource(@PathParam(value="attr")
                                                                                            String attributePrefix)

Get representation of certificate resource

Parameters:

attributePrefix -

Returns:

getInstallationProvider

@GET
 @Path(value="installation/providers/{providerId}")
String getInstallationProvider(@PathParam(value="providerId")
                                                                                        String providerId)

getApplicationSessionCount

@Path(value="session-count")
 @GET
 @Produces(value="application/json")
Map<String,Integer> getApplicationSessionCount()

getUserSessions

@Path(value="user-sessions")
 @GET
 @Produces(value="application/json")
List<UserSessionRepresentation> getUserSessions(@QueryParam(value="first")
                                                                                                                        Integer firstResult,
                                                                                                                        @QueryParam(value="max")
                                                                                                                        Integer maxResults)

pushRevocation

@POST
 @Path(value="push-revocation")
void pushRevocation()

getScopeMappings

@Path(value="/scope-mappings")
RoleMappingResource getScopeMappings()

roles

@Path(value="/roles")
RolesResource roles()