Package org.keycloak.models

Class DefaultActionTokenKey

java.lang.Object

org.keycloak.representations.JsonWebToken

org.keycloak.models.DefaultActionTokenKey

All Implemented Interfaces:

Serializable, SingleUseObjectKeyModel, Token

Direct Known Subclasses:

DefaultActionToken

public class DefaultActionTokenKey
extends JsonWebToken
implements SingleUseObjectKeyModel

Author:

hmlnarik

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACTION_TOKEN_USER_ID	The authenticationSession note with ID of the user authenticated via the action token
static final String	JSON_FIELD_ACTION_VERIFICATION_NONCE

Fields inherited from class org.keycloak.representations.JsonWebToken

audience, AZP, exp, iat, id, issuedFor, issuer, nbf, otherClaims, subject, SUBJECT, type

Constructor Summary

Constructors

Constructor	Description
DefaultActionTokenKey()
DefaultActionTokenKey(String userId, String actionId, int absoluteExpirationInSecs, UUID actionVerificationNonce)

Method Summary

Modifier and Type	Method	Description
static DefaultActionTokenKey	from(String serializedKey)
String	getActionId()
UUID	getActionVerificationNonce()
String	getUserId()

Methods inherited from class org.keycloak.representations.JsonWebToken

addAudience, audience, exp, getAudience, getCategory, getExp, getIat, getId, getIssuedFor, getIssuer, getNbf, getOtherClaims, getSubject, getType, hasAnyAudience, hasAudience, iat, id, isActive, isActive, isExpired, isIssuedBeforeSessionStart, isNotBefore, issuedFor, issuedNow, issuer, nbf, setOtherClaims, setSubject, subject, type

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.models.SingleUseObjectKeyModel

getExp, getExpiration, serializeKey

Field Details

ACTION_TOKEN_USER_ID

public static final String ACTION_TOKEN_USER_ID

The authenticationSession note with ID of the user authenticated via the action token

See Also:

• Constant Field Values

JSON_FIELD_ACTION_VERIFICATION_NONCE

public static final String JSON_FIELD_ACTION_VERIFICATION_NONCE

See Also:

• Constant Field Values

Constructor Details

DefaultActionTokenKey

public DefaultActionTokenKey()

DefaultActionTokenKey

public DefaultActionTokenKey(String userId,
 String actionId,
 int absoluteExpirationInSecs,
 UUID actionVerificationNonce)

Method Details

getUserId

public String getUserId()

Specified by:

getUserId in interface SingleUseObjectKeyModel

Returns:

ID of user which this token is for.

getActionId

public String getActionId()

Specified by:

getActionId in interface SingleUseObjectKeyModel

Returns:

Action identifier this token is for.

getActionVerificationNonce

public UUID getActionVerificationNonce()

Specified by:

getActionVerificationNonce in interface SingleUseObjectKeyModel

Returns:

Single-use random value used for verification whether the relevant action is allowed.

from

public static DefaultActionTokenKey from(String serializedKey)