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 Details

    • headers

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

    • clientConnection

      protected final ClientConnection clientConnection

  • Constructor Details

  • Method Details

    • account

      @Path("/") @GET @Produces("application/json") public org.keycloak.representations.account.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(org.keycloak.representations.account.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 @Produces("application/json") 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, org.keycloak.representations.account.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, org.keycloak.representations.account.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<org.keycloak.representations.idm.GroupRepresentation> groupMemberships(@QueryParam("briefRepresentation") @DefaultValue("true") boolean briefRepresentation)

    • applications

      @Path("/applications") @GET @Produces("application/json") public Stream<org.keycloak.representations.account.ClientRepresentation> applications(@QueryParam("name") String name)