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 org.keycloak.common.ClientConnection
clientConnection
protected javax.ws.rs.core.HttpHeaders
headers
-
Constructor Summary
Constructors Constructor Description AccountRestService(org.keycloak.models.KeycloakSession session, Auth auth, org.keycloak.events.EventBuilder event, org.keycloak.common.enums.AccountRestApiVersion version)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description org.keycloak.representations.account.UserRepresentation
account(Boolean userProfileMetadata)
Get account information.Stream<org.keycloak.representations.account.ClientRepresentation>
applications(String name)
AccountCredentialResource
credentials()
javax.ws.rs.core.Response
getConsent(String clientId)
Returns the consent for the client with the given client id.javax.ws.rs.core.Response
grantConsent(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.Stream<org.keycloak.representations.idm.GroupRepresentation>
groupMemberships(boolean briefRepresentation)
LinkedAccountsResource
linkedAccounts()
ResourcesService
resources()
javax.ws.rs.core.Response
revokeConsent(String clientId)
Deletes the consent for the client with the given client id.SessionResource
sessions()
Get session information.javax.ws.rs.core.Response
updateAccount(org.keycloak.representations.account.UserRepresentation rep)
javax.ws.rs.core.Response
updateConsent(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.
-
-
-
Constructor Detail
-
AccountRestService
public AccountRestService(org.keycloak.models.KeycloakSession session, Auth auth, org.keycloak.events.EventBuilder event, org.keycloak.common.enums.AccountRestApiVersion version)
-
-
Method Detail
-
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 javax.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()
-
getConsent
@Path("/applications/{clientId}/consent") @GET @Produces("application/json") public javax.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 javax.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 javax.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 forconsent
- requested consent for the client- Returns:
- the created or updated consent
-
updateConsent
@Path("/applications/{clientId}/consent") @PUT @Produces("application/json") public javax.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 forconsent
- 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)
-
-