Package org.keycloak.authorization.common

Class KeycloakIdentity

java.lang.Object

org.keycloak.authorization.common.KeycloakIdentity

All Implemented Interfaces:

Identity

public class KeycloakIdentity
extends Object
implements Identity

Author:

Pedro Igor

Field Summary

Fields

Modifier and Type	Field	Description
protected final AccessToken	accessToken
protected final Attributes	attributes
protected final KeycloakSession	keycloakSession
protected final RealmModel	realm

Constructor Summary

Constructors

Constructor	Description
KeycloakIdentity(KeycloakSession keycloakSession)
KeycloakIdentity(KeycloakSession keycloakSession, IDToken token)
KeycloakIdentity(AccessToken accessToken, KeycloakSession keycloakSession)
KeycloakIdentity(AccessToken accessToken, KeycloakSession keycloakSession, RealmModel realm, boolean ignoreTokenRoles)
KeycloakIdentity(IDToken token, KeycloakSession keycloakSession, RealmModel realm)

Method Summary

Modifier and Type	Method	Description
AccessToken	getAccessToken()
Attributes	getAttributes()	Returns the attributes or claims associated with this identity.
String	getId()	Returns the unique identifier of this identity.
boolean	hasClientRole(String clientId, String roleName)	Indicates if this identity is granted with a client role with the given roleName.
boolean	hasRealmRole(String roleName)	Indicates if this identity is granted with a realm role with the given roleName.
boolean	isResourceServer()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.authorization.identity.Identity

hasOneClientRole

Field Details

accessToken

protected final AccessToken accessToken

realm

protected final RealmModel realm

keycloakSession

protected final KeycloakSession keycloakSession

attributes

protected final Attributes attributes

Constructor Details

KeycloakIdentity

public KeycloakIdentity(KeycloakSession keycloakSession)

KeycloakIdentity

public KeycloakIdentity(KeycloakSession keycloakSession,
 IDToken token)

KeycloakIdentity

public KeycloakIdentity(IDToken token,
 KeycloakSession keycloakSession,
 RealmModel realm)

KeycloakIdentity

public KeycloakIdentity(AccessToken accessToken,
 KeycloakSession keycloakSession)

KeycloakIdentity

public KeycloakIdentity(AccessToken accessToken,
 KeycloakSession keycloakSession,
 RealmModel realm,
 boolean ignoreTokenRoles)

Method Details

getId

public String getId()

Description copied from interface: Identity

Returns the unique identifier of this identity.

Specified by:

getId in interface Identity

Returns:

the unique identifier of this identity

getAttributes

public Attributes getAttributes()

Description copied from interface: Identity

Returns the attributes or claims associated with this identity.

Specified by:

getAttributes in interface Identity

Returns:

the attributes or claims associated with this identity

hasClientRole

public boolean hasClientRole(String clientId,
 String roleName)

Description copied from interface: Identity

Indicates if this identity is granted with a client role with the given roleName.

Specified by:

hasClientRole in interface Identity

Parameters:

clientId - the client id

roleName - the name of the role

Returns:

true if the identity has the given role. Otherwise, it returns false.

hasRealmRole

public boolean hasRealmRole(String roleName)

Description copied from interface: Identity

Indicates if this identity is granted with a realm role with the given roleName.

Specified by:

hasRealmRole in interface Identity

Parameters:

roleName - the name of the role

Returns:

true if the identity has the given role. Otherwise, it returns false.

getAccessToken

public AccessToken getAccessToken()

isResourceServer

public boolean isResourceServer()