Package org.keycloak.services.resources.account

Class AccountRestService

java.lang.Object

org.keycloak.services.resources.account.AccountRestService

public class AccountRestService
extends Object

Author:

Stian Thorgersen

Field Summary

Fields

Modifier and Type	Field	Description
protected final ClientConnection	clientConnection
protected final jakarta.ws.rs.core.HttpHeaders	headers

Constructor Summary

Constructors

Constructor	Description
AccountRestService(KeycloakSession session, Auth auth, EventBuilder event, AccountRestApiVersion version)

Method Summary

Modifier and Type	Method	Description
UserRepresentation	account(Boolean userProfileMetadata)	Get account information.
Stream<ClientRepresentation>	applications(String name)
AccountCredentialResource	credentials()
jakarta.ws.rs.core.Response	getConsent(String clientId)	Returns the consent for the client with the given client id.
jakarta.ws.rs.core.Response	grantConsent(String clientId, ConsentRepresentation consent)	Creates or updates the consent of the given, requested consent for the client with the given client id.
Stream<GroupRepresentation>	groupMemberships(boolean briefRepresentation)
LinkedAccountsResource	linkedAccounts()
OrganizationsResource	organizations()
ResourcesService	resources()
jakarta.ws.rs.core.Response	revokeConsent(String clientId)	Deletes the consent for the client with the given client id.
SessionResource	sessions()	Get session information.
List<String>	supportedLocales()
jakarta.ws.rs.core.Response	updateAccount(UserRepresentation rep)
jakarta.ws.rs.core.Response	updateConsent(String clientId, ConsentRepresentation consent)	Creates or updates the consent of the given, requested consent for the client with the given client id.

Methods inherited from class java.lang.Object

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

Field Details

headers

protected final jakarta.ws.rs.core.HttpHeaders headers

clientConnection

protected final ClientConnection clientConnection

Constructor Details

AccountRestService

public AccountRestService(KeycloakSession session,
 Auth auth,
 EventBuilder event,
 AccountRestApiVersion version)

Method Details

account

@Path("/")
@GET
@Produces("application/json")
public UserRepresentation account(@QueryParam("userProfileMetadata")
 Boolean userProfileMetadata)

Get account information.

Returns:

updateAccount

@Path("/")
@POST
@Consumes("application/json")
@Produces("application/json")
public jakarta.ws.rs.core.Response updateAccount(UserRepresentation rep)

sessions

@Path("/sessions")
public SessionResource sessions()

Get session information.

Returns:

credentials

@Path("/credentials")
public AccountCredentialResource credentials()

resources

@Path("/resources")
public ResourcesService resources()

supportedLocales

@Path("supportedLocales")
@GET
public List<String> supportedLocales()

organizations

@Path("/organizations")
public OrganizationsResource organizations()

getConsent

@Path("/applications/{clientId}/consent")
@GET
@Produces("application/json")
public jakarta.ws.rs.core.Response getConsent(@PathParam("clientId")
 String clientId)

Returns the consent for the client with the given client id.

Parameters:

clientId - client id to return the consent for

Returns:

consent of the client

revokeConsent

@Path("/applications/{clientId}/consent")
@DELETE
public jakarta.ws.rs.core.Response revokeConsent(@PathParam("clientId")
 String clientId)

Deletes the consent for the client with the given client id.

Parameters:

clientId - client id to delete a consent for

Returns:

returns 202 if deleted

grantConsent

@Path("/applications/{clientId}/consent")
@POST
@Produces("application/json")
public jakarta.ws.rs.core.Response grantConsent(@PathParam("clientId")
 String clientId,
 ConsentRepresentation consent)

Creates or updates the consent of the given, requested consent for the client with the given client id. Returns the appropriate REST response.

Parameters:

clientId - client id to set a consent for

consent - requested consent for the client

Returns:

the created or updated consent

updateConsent

@Path("/applications/{clientId}/consent")
@PUT
@Produces("application/json")
public jakarta.ws.rs.core.Response updateConsent(@PathParam("clientId")
 String clientId,
 ConsentRepresentation consent)

Creates or updates the consent of the given, requested consent for the client with the given client id. Returns the appropriate REST response.

Parameters:

clientId - client id to set a consent for

consent - requested consent for the client

Returns:

the created or updated consent

linkedAccounts

@Path("/linked-accounts")
public LinkedAccountsResource linkedAccounts()

groupMemberships

@Path("/groups")
@GET
@Produces("application/json")
public Stream<GroupRepresentation> groupMemberships(@QueryParam("briefRepresentation") @DefaultValue("true")
 boolean briefRepresentation)

applications

@Path("/applications")
@GET
@Produces("application/json")
public Stream<ClientRepresentation> applications(@QueryParam("name")
 String name)