Package org.keycloak.authorization.client.resource

Class AuthorizationResource

java.lang.Object

org.keycloak.authorization.client.resource.AuthorizationResource

public class AuthorizationResource
extends Object

An entry point for obtaining permissions from the server.

Author:

Pedro Igor

Constructor Summary

Constructors

Constructor	Description
AuthorizationResource(Configuration configuration, ServerConfiguration serverConfiguration, Http http, TokenCallable token)

Method Summary

Modifier and Type	Method	Description
org.keycloak.representations.idm.authorization.AuthorizationResponse	authorize()	Query the server for all permissions.
org.keycloak.representations.idm.authorization.AuthorizationResponse	authorize(org.keycloak.representations.idm.authorization.AuthorizationRequest request)	Query the server for permissions given an AuthorizationRequest.
List<org.keycloak.representations.idm.authorization.Permission>	getPermissions(org.keycloak.representations.idm.authorization.AuthorizationRequest request)	Query the server for a list of permissions given an AuthorizationRequest.

Methods inherited from class java.lang.Object

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

Constructor Details

AuthorizationResource

public AuthorizationResource(Configuration configuration,
 ServerConfiguration serverConfiguration,
 Http http,
 TokenCallable token)

Method Details

authorize

public org.keycloak.representations.idm.authorization.AuthorizationResponse authorize()
                                                                               throws AuthorizationDeniedException

Query the server for all permissions.

Returns:

an AuthorizationResponse with a RPT holding all granted permissions

Throws:

AuthorizationDeniedException - in case the request was denied by the server

authorize

public org.keycloak.representations.idm.authorization.AuthorizationResponse authorize(org.keycloak.representations.idm.authorization.AuthorizationRequest request)
                                                                               throws AuthorizationDeniedException

Query the server for permissions given an AuthorizationRequest.

Parameters:

request - an AuthorizationRequest (not null)

Returns:

an AuthorizationResponse with a RPT holding all granted permissions

Throws:

AuthorizationDeniedException - in case the request was denied by the server

getPermissions

public List<org.keycloak.representations.idm.authorization.Permission> getPermissions(org.keycloak.representations.idm.authorization.AuthorizationRequest request)
                                                                               throws AuthorizationDeniedException

Query the server for a list of permissions given an AuthorizationRequest.

Parameters:

request - an AuthorizationRequest (not null)

Returns:

a list of permissions granted by the server

Throws:

AuthorizationDeniedException - in case the request was denied by the server