Uses of Class
org.keycloak.representations.JsonWebToken

Packages that use JsonWebToken

Package	Description
org.keycloak
org.keycloak.authentication.actiontoken
org.keycloak.authentication.actiontoken.execactions
org.keycloak.authentication.actiontoken.idpverifyemail
org.keycloak.authentication.actiontoken.inviteorg
org.keycloak.authentication.actiontoken.resetcred
org.keycloak.authentication.actiontoken.updateemail
org.keycloak.authentication.actiontoken.verifyemail
org.keycloak.authentication.authenticators.client
org.keycloak.authorization.client.representation
org.keycloak.broker.oidc
org.keycloak.broker.oidc.mappers
org.keycloak.exceptions
org.keycloak.models
org.keycloak.protocol.oid4vc.model
org.keycloak.protocol.oidc
org.keycloak.protocol.oidc.client.authentication
org.keycloak.protocol.oidc.grants.ciba.channel
org.keycloak.representations
org.keycloak.representations.docker
org.keycloak.representations.dpop
org.keycloak.representations.idm.authorization
org.keycloak.representations.oidc
org.keycloak.services.clientpolicy.context
org.keycloak.services.clientregistration
org.keycloak.services.managers
org.keycloak.services.resources
org.keycloak.social.gitlab
org.keycloak.social.google
org.keycloak.util

Uses of JsonWebToken in org.keycloak

Classes in org.keycloak with type parameters of type JsonWebToken

Modifier and Type	Class	Description
class	TokenVerifier<T extends JsonWebToken>
static interface	TokenVerifier.Predicate<T extends JsonWebToken>	Functional interface of checks that verify some part of a JWT.

Fields in org.keycloak with type parameters of type JsonWebToken

Modifier and Type	Field	Description
static final TokenVerifier.Predicate<JsonWebToken>	TokenVerifier.IS_ACTIVE	Check for token being neither expired nor used before it gets valid.
static final TokenVerifier.Predicate<JsonWebToken>	TokenVerifier.SUBJECT_EXISTS_CHECK

Methods in org.keycloak with type parameters of type JsonWebToken

Modifier and Type	Method	Description
static <T extends JsonWebToken> TokenVerifier.Predicate<T>	TokenVerifier.alternative(TokenVerifier.Predicate<? super T>... predicates)	Creates a predicate that will proceed with checks of the given predicates and will pass if and only if at least one of the given predicates passes.
static <T extends JsonWebToken> TokenVerifier<T>	TokenVerifier.create(String tokenString, Class<T> clazz)	Creates an instance of TokenVerifier from the given string on a JWT of the given class.
static <T extends JsonWebToken> TokenVerifier<T>	TokenVerifier.createWithoutSignature(T token)	Creates an instance of TokenVerifier for the given token.
static <T extends JsonWebToken> TokenVerifier.Predicate<T>	TokenVerifier.optional(TokenVerifier.Predicate<T> mandatoryPredicate)	Creates an optional predicate from a predicate that will proceed with check but always pass.

Methods in org.keycloak with parameters of type JsonWebToken

Modifier and Type	Method	Description
boolean	TokenVerifier.AudienceCheck.test(JsonWebToken t)
boolean	TokenVerifier.IssuedForCheck.test(JsonWebToken jsonWebToken)
boolean	TokenVerifier.RealmUrlCheck.test(JsonWebToken t)
boolean	TokenVerifier.TokenTypeCheck.test(JsonWebToken t)

Uses of JsonWebToken in org.keycloak.authentication.actiontoken

Classes in org.keycloak.authentication.actiontoken with type parameters of type JsonWebToken

Modifier and Type	Class	Description
class	AbstractActionTokenHandler<T extends JsonWebToken>
class	ActionTokenContext<T extends JsonWebToken>
interface	ActionTokenHandler<T extends JsonWebToken>	Handler of the action token.
interface	ActionTokenHandlerFactory<T extends JsonWebToken>

Subclasses of JsonWebToken in org.keycloak.authentication.actiontoken

Modifier and Type	Class	Description
class	DefaultActionToken	Part of action token that is intended to be used e.g.

Methods in org.keycloak.authentication.actiontoken with type parameters of type JsonWebToken

Modifier and Type	Method	Description
static <T extends JsonWebToken> TokenVerifier.Predicate<T>	TokenUtils.checkThat(Predicate<T> function, String errorEvent, String errorMessage)	Returns a predicate for use in TokenVerifier using the given boolean-returning function.
static <T extends JsonWebToken> TokenVerifier.Predicate<T>	TokenUtils.onlyIf(Predicate<T> condition, TokenVerifier.Predicate<T> predicate)	Returns a predicate that is applied only if the given condition evaluates to .
static <T extends JsonWebToken> TokenVerifier.Predicate<? super T>[]	TokenUtils.predicates(TokenVerifier.Predicate<? super T>... predicate)

Methods in org.keycloak.authentication.actiontoken that return types with arguments of type JsonWebToken

Modifier and Type	Method	Description
static TokenVerifier.Predicate<JsonWebToken>	TokenUtils.checkThat(BooleanSupplier function, String errorEvent, String errorMessage)	Returns a predicate for use in TokenVerifier using the given boolean-returning function.

Methods in org.keycloak.authentication.actiontoken with parameters of type JsonWebToken

Modifier and Type	Method	Description
static Set<String>	TokenUtils.checkRequestedAudiences(JsonWebToken token, List<String> requestedAudience)	Check that all requested audiences from parameter "requestedAudience" are available in the accessToken.

Constructors in org.keycloak.authentication.actiontoken with parameters of type JsonWebToken

Modifier	Constructor	Description
	ExplainedTokenVerificationException(JsonWebToken token, String errorEvent)
	ExplainedTokenVerificationException(JsonWebToken token, String errorEvent, String message)
	ExplainedTokenVerificationException(JsonWebToken token, String errorEvent, String message, Throwable cause)
	ExplainedTokenVerificationException(JsonWebToken token, String errorEvent, Throwable cause)
	ExplainedTokenVerificationException(JsonWebToken token, ExplainedVerificationException cause)

Uses of JsonWebToken in org.keycloak.authentication.actiontoken.execactions

Subclasses of JsonWebToken in org.keycloak.authentication.actiontoken.execactions

Modifier and Type	Class	Description
class	ExecuteActionsActionToken

Uses of JsonWebToken in org.keycloak.authentication.actiontoken.idpverifyemail

Subclasses of JsonWebToken in org.keycloak.authentication.actiontoken.idpverifyemail

Modifier and Type	Class	Description
class	IdpVerifyAccountLinkActionToken	Representation of a token that represents a time-limited verify e-mail action.

Uses of JsonWebToken in org.keycloak.authentication.actiontoken.inviteorg

Subclasses of JsonWebToken in org.keycloak.authentication.actiontoken.inviteorg

Modifier and Type	Class	Description
class	InviteOrgActionToken	Representation of a token that represents a time-limited verify e-mail action.

Uses of JsonWebToken in org.keycloak.authentication.actiontoken.resetcred

Subclasses of JsonWebToken in org.keycloak.authentication.actiontoken.resetcred

Modifier and Type	Class	Description
class	ResetCredentialsActionToken	Representation of a token that represents a time-limited reset credentials action.

Uses of JsonWebToken in org.keycloak.authentication.actiontoken.updateemail

Subclasses of JsonWebToken in org.keycloak.authentication.actiontoken.updateemail

Modifier and Type	Class	Description
class	UpdateEmailActionToken

Uses of JsonWebToken in org.keycloak.authentication.actiontoken.verifyemail

Subclasses of JsonWebToken in org.keycloak.authentication.actiontoken.verifyemail

Modifier and Type	Class	Description
class	VerifyEmailActionToken	Representation of a token that represents a time-limited verify e-mail action.

Uses of JsonWebToken in org.keycloak.authentication.authenticators.client

Methods in org.keycloak.authentication.authenticators.client that return JsonWebToken

Modifier and Type	Method	Description
JsonWebToken	ClientAssertionState.getToken()

Constructors in org.keycloak.authentication.authenticators.client with parameters of type JsonWebToken

Modifier	Constructor	Description
	ClientAssertionState(ClientModel client, String clientAssertionType, String clientAssertion, JWSInput jws, JsonWebToken token)

Uses of JsonWebToken in org.keycloak.authorization.client.representation

Subclasses of JsonWebToken in org.keycloak.authorization.client.representation

Modifier and Type	Class	Description
class	TokenIntrospectionResponse

Uses of JsonWebToken in org.keycloak.broker.oidc

Methods in org.keycloak.broker.oidc that return JsonWebToken

Modifier and Type	Method	Description
protected JsonWebToken	AbstractOAuth2IdentityProvider.generateToken()
JsonWebToken	OIDCIdentityProvider.validateToken(String encodedToken)
protected JsonWebToken	OIDCIdentityProvider.validateToken(String encodedToken, boolean ignoreAudience)

Methods in org.keycloak.broker.oidc with parameters of type JsonWebToken

Modifier and Type	Method	Description
protected BrokeredIdentityContext	OIDCIdentityProvider.extractIdentity(AccessTokenResponse tokenResponse, String accessToken, JsonWebToken idToken)
protected boolean	OIDCIdentityProvider.isAuthTimeExpired(JsonWebToken idToken, AuthenticationSessionModel authSession)
protected boolean	OIDCIdentityProvider.isTokenTypeSupported(JsonWebToken parsedToken)

Uses of JsonWebToken in org.keycloak.broker.oidc.mappers

Methods in org.keycloak.broker.oidc.mappers with parameters of type JsonWebToken

Modifier and Type	Method	Description
static Object	AbstractClaimMapper.getClaimValue(JsonWebToken token, String claim)

Uses of JsonWebToken in org.keycloak.exceptions

Methods in org.keycloak.exceptions that return JsonWebToken

Modifier and Type	Method	Description
JsonWebToken	TokenVerificationException.getToken()

Constructors in org.keycloak.exceptions with parameters of type JsonWebToken

Modifier	Constructor	Description
	TokenNotActiveException(JsonWebToken token)
	TokenNotActiveException(JsonWebToken token, String message)
	TokenNotActiveException(JsonWebToken token, String message, Throwable cause)
	TokenNotActiveException(JsonWebToken token, Throwable cause)
	TokenSignatureInvalidException(JsonWebToken token)
	TokenSignatureInvalidException(JsonWebToken token, String message)
	TokenSignatureInvalidException(JsonWebToken token, String message, Throwable cause)
	TokenSignatureInvalidException(JsonWebToken token, Throwable cause)
	TokenVerificationException(JsonWebToken token)
	TokenVerificationException(JsonWebToken token, String message)
	TokenVerificationException(JsonWebToken token, String message, Throwable cause)
	TokenVerificationException(JsonWebToken token, Throwable cause)

Uses of JsonWebToken in org.keycloak.models

Subclasses of JsonWebToken in org.keycloak.models

Modifier and Type	Class	Description
class	DefaultActionTokenKey

Uses of JsonWebToken in org.keycloak.protocol.oid4vc.model

Subclasses of JsonWebToken in org.keycloak.protocol.oid4vc.model

Modifier and Type	Class	Description
class	JwtCNonce

Uses of JsonWebToken in org.keycloak.protocol.oidc

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

Modifier and Type	Method	Description
boolean	TokenManager.NotBeforeCheck.test(JsonWebToken t)
boolean	TokenManager.TokenRevocationCheck.test(JsonWebToken token)

Uses of JsonWebToken in org.keycloak.protocol.oidc.client.authentication

Methods in org.keycloak.protocol.oidc.client.authentication that return JsonWebToken

Modifier and Type	Method	Description
protected JsonWebToken	JWTClientCredentialsProvider.createRequestToken(String clientId, String realmInfoUrl)
protected JsonWebToken	JWTClientSecretCredentialsProvider.createRequestToken(String clientId, String realmInfoUrl)

Uses of JsonWebToken in org.keycloak.protocol.oidc.grants.ciba.channel

Subclasses of JsonWebToken in org.keycloak.protocol.oidc.grants.ciba.channel

Modifier and Type	Class	Description
class	CIBAAuthenticationRequest	Represents an authentication request sent by a consumption device (CD).

Uses of JsonWebToken in org.keycloak.representations

Subclasses of JsonWebToken in org.keycloak.representations

Modifier and Type	Class	Description
class	AccessToken
class	AuthorizationResponseToken
class	IDToken
class	LogoutToken
class	RefreshToken

Methods in org.keycloak.representations that return JsonWebToken

Modifier and Type	Method	Description
JsonWebToken	JsonWebToken.addAudience(String audience)
JsonWebToken	JsonWebToken.audience(String... audience)
JsonWebToken	JsonWebToken.exp(Long exp)
JsonWebToken	JsonWebToken.iat(Long iat)
JsonWebToken	JsonWebToken.id(String id)
JsonWebToken	JsonWebToken.issuedFor(String issuedFor)
JsonWebToken	JsonWebToken.issuedNow()	Set issuedAt to the current time
JsonWebToken	JsonWebToken.issuer(String issuer)
JsonWebToken	JsonWebToken.nbf(Long nbf)
JsonWebToken	JsonWebToken.subject(String subject)
JsonWebToken	JsonWebToken.type(String type)

Uses of JsonWebToken in org.keycloak.representations.docker

Subclasses of JsonWebToken in org.keycloak.representations.docker

Modifier and Type	Class	Description
class	DockerResponseToken	* { "iss": "auth.docker.com", "sub": "jlhawn", "aud": "registry.docker.com", "exp": 1415387315, "nbf": 1415387015, "iat": 1415387015, "jti": "tYJCO1c6cnyy7kAn0c7rKPgbV1H1bFws", "access": [ { "type": "repository", "name": "samalba/my-app", "actions": [ "push" ] } ] }

Uses of JsonWebToken in org.keycloak.representations.dpop

Subclasses of JsonWebToken in org.keycloak.representations.dpop

Modifier and Type	Class	Description
class	DPoP

Uses of JsonWebToken in org.keycloak.representations.idm.authorization

Subclasses of JsonWebToken in org.keycloak.representations.idm.authorization

Modifier and Type	Class	Description
class	PermissionTicketToken

Uses of JsonWebToken in org.keycloak.representations.oidc

Subclasses of JsonWebToken in org.keycloak.representations.oidc

Modifier and Type	Class	Description
class	TokenMetadataRepresentation

Uses of JsonWebToken in org.keycloak.services.clientpolicy.context

Methods in org.keycloak.services.clientpolicy.context that return JsonWebToken

Modifier and Type	Method	Description
default JsonWebToken	ClientCRUDContext.getToken()	returns JsonWebToken of the token accompanied with the request to register/read/update/unregister client

Constructors in org.keycloak.services.clientpolicy.context with parameters of type JsonWebToken

Modifier	Constructor	Description
	DynamicClientRegisterContext(ClientRegistrationContext context, JsonWebToken token, RealmModel realm)
	DynamicClientRegisteredContext(ClientRegistrationContext context, ClientModel registeredClient, JsonWebToken token, RealmModel realm)
	DynamicClientUnregisterContext(KeycloakSession session, ClientModel targetClient, JsonWebToken token, RealmModel realm)
	DynamicClientUpdateContext(ClientRegistrationContext context, ClientModel proposedClientRepresentation, JsonWebToken token, RealmModel realm)
	DynamicClientUpdatedContext(KeycloakSession session, ClientModel updatedClient, JsonWebToken token, RealmModel realm)
	DynamicClientViewContext(KeycloakSession session, ClientModel targetClient, JsonWebToken token, RealmModel realm)

Uses of JsonWebToken in org.keycloak.services.clientregistration

Subclasses of JsonWebToken in org.keycloak.services.clientregistration

Modifier and Type	Class	Description
class	InitialAccessToken
class	RegistrationAccessToken

Uses of JsonWebToken in org.keycloak.services.managers

Subclasses of JsonWebToken in org.keycloak.services.managers

Modifier and Type	Class	Description
class	IdentityCookieToken

Uses of JsonWebToken in org.keycloak.services.resources

Methods in org.keycloak.services.resources with type parameters of type JsonWebToken

Modifier and Type	Method	Description
static <T extends JsonWebToken> void	LoginActionsServiceChecks.checkIsClientValid(T token, ActionTokenContext<T> context)	Verifies whether the client denoted by client ID in token's iss (issuedFor) field both exists and is enabled.
static <T extends JsonWebToken & SingleUseObjectKeyModel> void	LoginActionsServiceChecks.checkIsUserValid(T token, ActionTokenContext<T> context, EventBuilder event)	Verifies whether the user given by ID both exists in the current realm.
static <T extends JsonWebToken & SingleUseObjectKeyModel> void	LoginActionsServiceChecks.checkTokenWasNotUsedYet(T token, ActionTokenContext<T> context)
static <T extends JsonWebToken> boolean	LoginActionsServiceChecks.doesAuthenticationSessionFromCookieMatchOneFromToken(ActionTokenContext<T> context, AuthenticationSessionModel authSessionFromCookie, String authSessionCompoundIdFromToken)	This check verifies that current authentication session is consistent with the one specified in token.
protected <T extends JsonWebToken & SingleUseObjectKeyModel> jakarta.ws.rs.core.Response	LoginActionsService.handleActionToken(String tokenString, String execution, String clientId, String tabId, String clientData, TriFunction<ActionTokenHandler<T>,T,ActionTokenContext<T>,jakarta.ws.rs.core.Response> preHandleToken)

Methods in org.keycloak.services.resources with parameters of type JsonWebToken

Modifier and Type	Method	Description
boolean	LoginActionsServiceChecks.AuthenticationSessionUserIdMatchesOneFromToken.test(JsonWebToken t)
boolean	LoginActionsServiceChecks.IsActionRequired.test(JsonWebToken t)
boolean	LoginActionsServiceChecks.IsRedirectValid.test(JsonWebToken t)

Uses of JsonWebToken in org.keycloak.social.gitlab

Methods in org.keycloak.social.gitlab with parameters of type JsonWebToken

Modifier and Type	Method	Description
protected BrokeredIdentityContext	GitLabIdentityProvider.extractIdentity(AccessTokenResponse tokenResponse, String accessToken, JsonWebToken idToken)

Uses of JsonWebToken in org.keycloak.social.google

Methods in org.keycloak.social.google that return JsonWebToken

Modifier and Type	Method	Description
protected JsonWebToken	GoogleIdentityProvider.validateToken(String encodedToken, boolean ignoreAudience)

Uses of JsonWebToken in org.keycloak.util

Methods in org.keycloak.util with type parameters of type JsonWebToken

Modifier and Type	Method	Description
static <T extends JsonWebToken> T	TokenUtil.jweDirectVerifyAndDecode(Key aesKey, Key hmacKey, String jweStr, Class<T> expectedClass)

Methods in org.keycloak.util with parameters of type JsonWebToken

Modifier and Type	Method	Description
static String	TokenUtil.jweDirectEncode(Key aesKey, Key hmacKey, JsonWebToken jwt)