Package org.keycloak.rar

Class AuthorizationDetails

java.lang.Object

org.keycloak.rar.AuthorizationDetails

All Implemented Interfaces:

Serializable

public class AuthorizationDetails
extends Object
implements Serializable

The internal Keycloak representation of a Rich Authorization Request authorization_details object, together with some extra metadata to make it easier to work with this data in other parts of the codebase. The AuthorizationRequestSource is needed as OAuth scopes are also parsed into AuthorizationDetails to standardize the way authorization data is managed in Keycloak. Scopes parsed as AuthorizationDetails will need to be treated as normal OAuth scopes in places like TokenMappers and included in the "scopes" JWT claim as such.

Author:

Daniel Gozalo

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AuthorizationDetails(ClientScopeModel clientScope)
AuthorizationDetails(ClientScopeModel clientScope, AuthorizationRequestSource source, org.keycloak.representations.AuthorizationDetailsJSONRepresentation authorizationDetails)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
org.keycloak.representations.AuthorizationDetailsJSONRepresentation	getAuthorizationDetails()
ClientScopeModel	getClientScope()
String	getDynamicScopeParam()	Deprecated. Use getParameterizedScopeParam() instead.
String	getParameterizedScopeParam()	Returns the parameterized scope parameter from the underlying AuthorizationDetailsJSONRepresentation representation.
AuthorizationRequestSource	getSource()
int	hashCode()
boolean	isDynamicScope()	Deprecated. Use isParameterizedScope() instead.
boolean	isParameterizedScope()	Returns whether the current AuthorizationDetails object is a parameterized scope.
void	setAuthorizationDetails(org.keycloak.representations.AuthorizationDetailsJSONRepresentation authorizationDetails)
void	setClientScope(ClientScopeModel clientScope)
void	setSource(AuthorizationRequestSource source)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

AuthorizationDetails

public AuthorizationDetails(ClientScopeModel clientScope,
 AuthorizationRequestSource source,
 org.keycloak.representations.AuthorizationDetailsJSONRepresentation authorizationDetails)

AuthorizationDetails

public AuthorizationDetails(ClientScopeModel clientScope)

Method Details

getClientScope

public ClientScopeModel getClientScope()

setClientScope

public void setClientScope(ClientScopeModel clientScope)

getSource

public AuthorizationRequestSource getSource()

setSource

public void setSource(AuthorizationRequestSource source)

getAuthorizationDetails

public org.keycloak.representations.AuthorizationDetailsJSONRepresentation getAuthorizationDetails()

setAuthorizationDetails

public void setAuthorizationDetails(org.keycloak.representations.AuthorizationDetailsJSONRepresentation authorizationDetails)

isParameterizedScope

public boolean isParameterizedScope()

Returns whether the current AuthorizationDetails object is a parameterized scope.

Returns:

see description

getParameterizedScopeParam

public String getParameterizedScopeParam()

Returns the parameterized scope parameter from the underlying AuthorizationDetailsJSONRepresentation representation.

Returns:

see description

isDynamicScope

@Deprecated
public boolean isDynamicScope()

Deprecated.

Use isParameterizedScope() instead.

getDynamicScopeParam

@Deprecated
public String getDynamicScopeParam()

Deprecated.

Use getParameterizedScopeParam() instead.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object