Uses of Class
org.keycloak.representations.IDToken

Packages that use IDToken

Package	Description
org.keycloak
org.keycloak.admin.client.resource
org.keycloak.authorization.common
org.keycloak.organization.protocol.mappers.oidc
org.keycloak.protocol.oidc
org.keycloak.protocol.oidc.mappers
org.keycloak.representations
org.keycloak.representations.oidc
org.keycloak.services.managers
org.keycloak.services.resources.admin

Uses of IDToken in org.keycloak

Fields in org.keycloak declared as IDToken

Modifier and Type	Field	Description
protected IDToken	KeycloakSecurityContext.idToken

Methods in org.keycloak that return IDToken

Modifier and Type	Method	Description
IDToken	KeycloakSecurityContext.getIdToken()

Constructors in org.keycloak with parameters of type IDToken

Modifier	Constructor	Description
	KeycloakSecurityContext(String tokenString, AccessToken token, String idTokenString, IDToken idToken)

Uses of IDToken in org.keycloak.admin.client.resource

Methods in org.keycloak.admin.client.resource that return IDToken

Modifier and Type	Method	Description
IDToken	ClientScopeEvaluateResource.generateExampleIdToken(String scopeParam, String userId, String audience)	Generate example ID token

Uses of IDToken in org.keycloak.authorization.common

Constructors in org.keycloak.authorization.common with parameters of type IDToken

Modifier	Constructor	Description
	KeycloakIdentity(KeycloakSession keycloakSession, IDToken token)
	KeycloakIdentity(IDToken token, KeycloakSession keycloakSession, RealmModel realm)

Uses of IDToken in org.keycloak.organization.protocol.mappers.oidc

Methods in org.keycloak.organization.protocol.mappers.oidc with parameters of type IDToken

Modifier and Type	Method	Description
protected void	OrganizationMembershipMapper.setClaim(IDToken token, ProtocolMapperModel model, UserSessionModel userSession, KeycloakSession session, ClientSessionContext clientSessionCtx)

Uses of IDToken in org.keycloak.protocol.oidc

Methods in org.keycloak.protocol.oidc that return IDToken

Modifier and Type	Method	Description
IDToken	TokenManager.AccessTokenResponseBuilder.getIdToken()
IDToken	TokenManager.transformIDToken(KeycloakSession session, IDToken token, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
IDToken	TokenManager.verifyIDToken(KeycloakSession session, RealmModel realm, String encodedIDToken)
IDToken	TokenManager.verifyIDTokenSignature(KeycloakSession session, String encodedIDToken)

Methods in org.keycloak.protocol.oidc with parameters of type IDToken

Modifier and Type	Method	Description
IDToken	TokenManager.transformIDToken(KeycloakSession session, IDToken token, UserSessionModel userSession, ClientSessionContext clientSessionCtx)

Uses of IDToken in org.keycloak.protocol.oidc.mappers

Methods in org.keycloak.protocol.oidc.mappers that return IDToken

Modifier and Type	Method	Description
IDToken	AbstractOIDCProtocolMapper.transformIDToken(IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
IDToken	AbstractPairwiseSubMapper.transformIDToken(IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
IDToken	OIDCIDTokenMapper.transformIDToken(IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSession)

Methods in org.keycloak.protocol.oidc.mappers with parameters of type IDToken

Modifier and Type	Method	Description
static void	OIDCAttributeMapperHelper.mapClaim(IDToken token, ProtocolMapperModel mappingModel, Object attributeValue)
protected void	AbstractPairwiseSubMapper.setAccessTokenSubject(IDToken token, String pairwiseSub)
protected void	AbstractOIDCProtocolMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)	Deprecated. override AbstractOIDCProtocolMapper.setClaim(IDToken, ProtocolMapperModel, UserSessionModel, KeycloakSession, ClientSessionContext) instead.
protected void	AbstractOIDCProtocolMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)	Intended to be overridden in ProtocolMapper implementations to add claims to an token.
protected static void	AbstractUserRoleMappingMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, Set<String> rolesToAdd, String clientId, String prefix)	Retrieves all roles of the current user based on direct roles set to the user, its groups and their parent groups.
protected void	AcrProtocolMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
protected void	AddressMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)
protected void	AmrProtocolMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
protected void	AudienceProtocolMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
protected void	ClaimsParameterTokenMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
protected void	ClaimsParameterWithValueIdTokenMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
protected void	FullNameMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)
protected void	GroupMembershipMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)	Adds the group membership information to the JsonWebToken.otherClaims.
protected void	HardcodedClaim.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)
protected void	HardcodedRole.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession session, ClientSessionContext clientSessionCtx)
protected void	RoleNameMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession session, ClientSessionContext clientSessionCtx)
protected void	ScriptBasedOIDCProtocolMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
protected void	SessionStateMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
protected void	SubMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
protected void	UserAttributeMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)
protected void	UserClientRoleMappingMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession session, ClientSessionContext clientSessionCtx)
protected void	UserPropertyMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)
protected void	UserRealmRoleMappingMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession session, ClientSessionContext clientSessionCtx)
protected void	UserSessionNoteMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)
protected void	AbstractPairwiseSubMapper.setIDTokenSubject(IDToken token, String pairwiseSub)
protected void	AbstractPairwiseSubMapper.setUserInfoTokenSubject(IDToken token, String pairwiseSub)
IDToken	AbstractOIDCProtocolMapper.transformIDToken(IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
IDToken	AbstractPairwiseSubMapper.transformIDToken(IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
IDToken	OIDCIDTokenMapper.transformIDToken(IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSession)

Uses of IDToken in org.keycloak.representations

Subclasses of IDToken in org.keycloak.representations

Modifier and Type	Class	Description
class	AccessToken
class	RefreshToken

Uses of IDToken in org.keycloak.representations.oidc

Subclasses of IDToken in org.keycloak.representations.oidc

Modifier and Type	Class	Description
class	TokenMetadataRepresentation

Uses of IDToken in org.keycloak.services.managers

Subclasses of IDToken in org.keycloak.services.managers

Modifier and Type	Class	Description
class	IdentityCookieToken

Uses of IDToken in org.keycloak.services.resources.admin

Methods in org.keycloak.services.resources.admin that return IDToken

Modifier and Type	Method	Description
IDToken	ClientScopeEvaluateResource.generateExampleIdToken(String scopeParam, String userId, String audience)	Create JSON with payload of example id token