Keycloak Core 24.0.0 · org.keycloak.representations.JsonWebToken

Modifier and Type	Field and Description
protected String[]	audience
public static final String	AZP
protected Long	exp
protected Long	iat
protected String	id
public String	issuedFor
protected String	issuer
protected Long	nbf
protected Map<String, Object>	otherClaims
public static final String	SUBJECT
protected String	subject
protected String	type

Access	Constructor and Description
public	JsonWebToken()

Method Summary

Modifier and Type	Method and Description
public JsonWebToken	addAudience(String audience)
public JsonWebToken	audience(String... audience)
public JsonWebToken	exp(Long exp)
public JsonWebToken	expiration(int expiration) Deprecated int will overflow with values after 2038. Use `exp(Long)` instead.
public String[]	getAudience()
public TokenCategory	getCategory() Implements org.keycloak.Token.getCategory.
public Long	getExp()
public int	getExpiration() Deprecated int will overflow with values after 2038. Use `getExp()` instead.
public Long	getIat()
public String	getId()
public int	getIssuedAt() Deprecated int will overflow with values after 2038. Use `getIat()` instead.
public String	getIssuedFor() OAuth client the token was issued for.
public String	getIssuer()
public Long	getNbf()
public int	getNotBefore() Deprecated int will overflow with values after 2038. Use `getNbf()` instead.
public Map<String, Object>	getOtherClaims() This is a map of any other claims and data that might be in the IDToken.
public String	getSubject()
public String	getType()
public boolean	hasAnyAudience(List<String> audiences)
public boolean	hasAudience(String audience)
public JsonWebToken	iat(Long iat)
public JsonWebToken	id(String id)
public boolean	isActive() Tests that the token is not expired and is not-before.
public boolean	isActive(int allowedTimeSkew)
public boolean	isExpired()
public boolean	Returns: true if the particular token was issued before the given session start time. Which means that token cannot be issued by the particular session isIssuedBeforeSessionStart(long Time in seconds sessionStarted)
public boolean	isNotBefore(int allowedTimeSkew)
public JsonWebToken	issuedAt(int issuedAt) Deprecated int will overflow with values after 2038. Use `iat(Long)` ()} instead.
public JsonWebToken	issuedFor(String issuedFor)
public JsonWebToken	issuedNow() Set issuedAt to the current time
public JsonWebToken	issuer(String issuer)
public JsonWebToken	nbf(Long nbf)
public JsonWebToken	notBefore(int notBefore) Deprecated int will overflow with values after 2038. Use `nbf(Long)` instead.
public void	setOtherClaims(String name, Object value)
public void	setSubject(String subject)
public JsonWebToken	subject(String subject)
public JsonWebToken	type(String type)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

audience	back to summary
protected String[] audience Annotations @JsonProperty:aud @JsonSerialize using:StringOrArraySerializer @JsonDeserialize using:StringOrArrayDeserializer

AZP	back to summary
public static final String AZP

exp	back to summary
protected Long exp

iat	back to summary
protected Long iat

id	back to summary
protected String id Annotations @JsonProperty:jti

issuedFor	back to summary
public String issuedFor Annotations @JsonProperty:azp

issuer	back to summary
protected String issuer Annotations @JsonProperty:iss

nbf	back to summary
protected Long nbf

otherClaims	back to summary
protected Map<String, Object> otherClaims

SUBJECT	back to summary
public static final String SUBJECT

subject	back to summary
protected String subject Annotations @JsonProperty:sub

type	back to summary
protected String type Annotations @JsonProperty:typ

JsonWebToken	back to summary
public JsonWebToken()

Method Detail

addAudience	back to summary
public JsonWebToken addAudience(String audience)

audience	back to summary
public JsonWebToken audience(String... audience)

exp	back to summary
public JsonWebToken exp(Long exp)

expiration	back to summary
public JsonWebToken expiration(int expiration) Deprecated int will overflow with values after 2038. Use `exp(Long)` instead.

getAudience	back to summary
public String[] getAudience() Annotations @JsonIgnore

getCategory	back to summary
public TokenCategory getCategory() Implements org.keycloak.Token.getCategory. Annotations @Override

getCategory

back to summary

public TokenCategory getCategory()

Implements org.keycloak.Token.getCategory.

Annotations

@Override

getExp	back to summary
public Long getExp()

getExpiration	back to summary
public int getExpiration() Deprecated int will overflow with values after 2038. Use `getExp()` instead. Annotations @Deprecated @JsonIgnore

getIat	back to summary
public Long getIat()

getId	back to summary
public String getId()

getIssuedAt	back to summary
public int getIssuedAt() Deprecated int will overflow with values after 2038. Use `getIat()` instead. Annotations @Deprecated @JsonIgnore

getIssuedFor	back to summary
public String getIssuedFor() OAuth client the token was issued for.

getIssuer	back to summary
public String getIssuer()

getNbf	back to summary
public Long getNbf()

getNotBefore	back to summary
public int getNotBefore() Deprecated int will overflow with values after 2038. Use `getNbf()` instead. Annotations @Deprecated @JsonIgnore

getOtherClaims	back to summary
public Map<String, Object> getOtherClaims() This is a map of any other claims and data that might be in the IDToken. Could be custom claims set up by the auth server Annotations @JsonAnyGetter

getOtherClaims

back to summary

public Map<String, Object> getOtherClaims()

This is a map of any other claims and data that might be in the IDToken. Could be custom claims set up by the auth server

Annotations

@JsonAnyGetter

getSubject	back to summary
public String getSubject()

getType	back to summary
public String getType()

hasAnyAudience	back to summary
public boolean hasAnyAudience(List<String> audiences)

hasAudience	back to summary
public boolean hasAudience(String audience)

iat	back to summary
public JsonWebToken iat(Long iat)

id	back to summary
public JsonWebToken id(String id)

isActive	back to summary
public boolean isActive() Tests that the token is not expired and is not-before. Annotations @JsonIgnore

isActive

back to summary

public boolean isActive()

Tests that the token is not expired and is not-before.

Annotations

@JsonIgnore

isActive	back to summary
public boolean isActive(int allowedTimeSkew) Annotations @JsonIgnore

isExpired	back to summary
public boolean isExpired() Annotations @JsonIgnore

isIssuedBeforeSessionStart	back to summary
public boolean isIssuedBeforeSessionStart(long sessionStarted) Parameters sessionStarted:long Time in seconds Returns:boolean true if the particular token was issued before the given session start time. Which means that token cannot be issued by the particular session Annotations @JsonIgnore

isNotBefore	back to summary
public boolean isNotBefore(int allowedTimeSkew) Annotations @JsonIgnore

issuedAt	back to summary
public JsonWebToken issuedAt(int issuedAt) Deprecated int will overflow with values after 2038. Use `iat(Long)` ()} instead. Annotations @Deprecated @JsonIgnore

issuedFor	back to summary
public JsonWebToken issuedFor(String issuedFor)

issuedNow	back to summary
public JsonWebToken issuedNow() Set issuedAt to the current time Annotations @JsonIgnore

issuedNow

back to summary

public JsonWebToken issuedNow()

Set issuedAt to the current time

Annotations

@JsonIgnore

issuer	back to summary
public JsonWebToken issuer(String issuer)

nbf	back to summary
public JsonWebToken nbf(Long nbf)

notBefore	back to summary
public JsonWebToken notBefore(int notBefore) Deprecated int will overflow with values after 2038. Use `nbf(Long)` instead. Annotations @Deprecated @JsonIgnore

setOtherClaims	back to summary
public void setOtherClaims(String name, Object value) Annotations @JsonAnySetter

setSubject	back to summary
public void setSubject(String subject)

subject	back to summary
public JsonWebToken subject(String subject)

type	back to summary
public JsonWebToken type(String type)

public Class JsonWebToken

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail