Uses of Class
org.keycloak.representations.JsonWebToken
-
-
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 TokenVerifier.Predicate<JsonWebToken>
TokenVerifier. IS_ACTIVE
Check for token being neither expired nor used before it gets valid.static 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 ofTokenVerifier
from the given string on a JWT of the given class.static <T extends JsonWebToken>
TokenVerifier<T>TokenVerifier. createWithoutSignature(T token)
Creates an instance ofTokenVerifier
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 inTokenVerifier
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 givencondition
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 inTokenVerifier
using the given boolean-returning function.Constructors in org.keycloak.authentication.actiontoken with parameters of type JsonWebToken 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.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.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)
-
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 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.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.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. expiration(int expiration)
Deprecated.int will overflow with values after 2038.JsonWebToken
JsonWebToken. iat(Long iat)
JsonWebToken
JsonWebToken. id(String id)
JsonWebToken
JsonWebToken. issuedAt(int issuedAt)
Deprecated.int will overflow with values after 2038.JsonWebToken
JsonWebToken. issuedFor(String issuedFor)
JsonWebToken
JsonWebToken. issuedNow()
Set issuedAt to the current timeJsonWebToken
JsonWebToken. issuer(String issuer)
JsonWebToken
JsonWebToken. nbf(Long nbf)
JsonWebToken
JsonWebToken. notBefore(int notBefore)
Deprecated.int will overflow with values after 2038.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.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()
returnsJsonWebToken
of the token accompanied with the request to register/read/update/unregister clientConstructors in org.keycloak.services.clientpolicy.context with parameters of type JsonWebToken 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
Methods in org.keycloak.services.clientregistration that return JsonWebToken Modifier and Type Method Description JsonWebToken
ClientRegistrationAuth. getJwt()
JsonWebToken
ClientRegistrationTokenUtils.TokenVerification. getJwt()
Methods in org.keycloak.services.clientregistration with parameters of type JsonWebToken Modifier and Type Method Description static ClientRegistrationTokenUtils.TokenVerification
ClientRegistrationTokenUtils.TokenVerification. success(String kid, JsonWebToken jwt)
-
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>
voidLoginActionsServiceChecks. checkIsClientValid(T token, ActionTokenContext<T> context)
Verifies whether the client denoted by client ID in token'siss
(issuedFor
) field both exists and is enabled.static <T extends JsonWebToken & SingleUseObjectKeyModel>
voidLoginActionsServiceChecks. checkIsUserValid(T token, ActionTokenContext<T> context)
Verifies whether the user given by ID both exists in the current realm.static <T extends JsonWebToken>
voidLoginActionsServiceChecks. checkNotLoggedInYet(ActionTokenContext<T> context, AuthenticationSessionModel authSessionFromCookie, String authSessionId)
Verifies that the authentication session has not yet been converted to user session, in other words that the user has not yet completed authentication and logged in.static <T extends JsonWebToken & SingleUseObjectKeyModel>
voidLoginActionsServiceChecks. checkTokenWasNotUsedYet(T token, ActionTokenContext<T> context)
static <T extends JsonWebToken>
booleanLoginActionsServiceChecks. 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>
javax.ws.rs.core.ResponseLoginActionsService. handleActionToken(String tokenString, String execution, String clientId, String tabId)
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>
TTokenUtil. 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)
-