Modifier and Type	Class and Description
public static class	AccessToken.Access
public static class	AccessToken.Authorization
public static class	AccessToken.Confirmation

Modifier and Type	Field and Description
protected Set<String>	allowedOrigins
protected AccessToken.Authorization	authorization
protected AccessToken.Confirmation	confirmation
protected AccessToken.Access	realmAccess
protected Map<String, AccessToken.Access>	resourceAccess
protected String	scope
protected Set<String>	trustedCertificates

Access	Constructor and Description
public	AccessToken()

Modifier and Type	Method and Description
public AccessToken.Access	addAccess(String service)
public AccessToken	expiration(int expiration) Overrides org.keycloak.representations.JsonWebToken.expiration.
public Set<String>	getAllowedOrigins()
public AccessToken.Authorization	getAuthorization()
public TokenCategory	getCategory() Overrides org.keycloak.representations.IDToken.getCategory. Implements org.keycloak.Token.getCategory.
public AccessToken.Confirmation	getConfirmation()
public AccessToken.Access	getRealmAccess()
public Map<String, AccessToken.Access>	getResourceAccess()
public AccessToken.Access	getResourceAccess(String resource)
public String	getScope()
public Set<String>	getTrustedCertificates()
public AccessToken	id(String id) Overrides org.keycloak.representations.JsonWebToken.id.
public AccessToken	issuedAt(int issuedAt) Overrides org.keycloak.representations.JsonWebToken.issuedAt.
public AccessToken	issuedFor(String issuedFor) Overrides org.keycloak.representations.JsonWebToken.issuedFor.
public AccessToken	issuer(String issuer) Overrides org.keycloak.representations.JsonWebToken.issuer.
public boolean	isVerifyCaller() Does the realm require verifying the caller?
public boolean	isVerifyCaller(String resource) Does the resource override the requirement of verifying the caller?
public AccessToken	notBefore(int notBefore) Overrides org.keycloak.representations.JsonWebToken.notBefore.
public void	setAllowedOrigins(Set<String> allowedOrigins)
public void	setAuthorization(AccessToken.Authorization authorization)
public void	setConfirmation(AccessToken.Confirmation confirmation)
public void	setRealmAccess(AccessToken.Access realmAccess)
public void	setResourceAccess(Map<String, AccessToken.Access> resourceAccess)
public void	setScope(String scope)
public void	setTrustedCertificates(Set<String> trustedCertificates)
public AccessToken	subject(String subject) Overrides org.keycloak.representations.JsonWebToken.subject.
public AccessToken	type(String type) Overrides org.keycloak.representations.JsonWebToken.type.

allowedOrigins	back to summary
protected Set<String> allowedOrigins Annotations @JsonProperty:allowed-origins

authorization	back to summary
protected AccessToken.Authorization authorization Annotations @JsonProperty:authorization

confirmation	back to summary
protected AccessToken.Confirmation confirmation Annotations @JsonProperty:cnf

realmAccess	back to summary
protected AccessToken.Access realmAccess Annotations @JsonProperty:realm_access

resourceAccess	back to summary
protected Map<String, AccessToken.Access> resourceAccess Annotations @JsonProperty:resource_access

scope	back to summary
protected String scope Annotations @JsonProperty:scope

trustedCertificates	back to summary
protected Set<String> trustedCertificates Annotations @JsonProperty:trusted-certs

AccessToken	back to summary
public AccessToken()

Method Detail

addAccess	back to summary
public AccessToken.Access addAccess(String service)

expiration	back to summary
public AccessToken expiration(int expiration) Overrides org.keycloak.representations.JsonWebToken.expiration. Annotations @Override

expiration

back to summary

public AccessToken expiration(int expiration)

Overrides org.keycloak.representations.JsonWebToken.expiration.

Annotations

@Override

getAllowedOrigins	back to summary
public Set<String> getAllowedOrigins()

getAuthorization	back to summary
public AccessToken.Authorization getAuthorization()

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

getCategory

back to summary

public TokenCategory getCategory()

Overrides org.keycloak.representations.IDToken.getCategory.

Implements org.keycloak.Token.getCategory.

Annotations

@Override

getConfirmation	back to summary
public AccessToken.Confirmation getConfirmation()

getRealmAccess	back to summary
public AccessToken.Access getRealmAccess()

getResourceAccess	back to summary
public Map<String, AccessToken.Access> getResourceAccess() Annotations @JsonIgnore

getResourceAccess	back to summary
public AccessToken.Access getResourceAccess(String resource) Annotations @JsonIgnore

getScope	back to summary
public String getScope()

getTrustedCertificates	back to summary
public Set<String> getTrustedCertificates()

id	back to summary
public AccessToken id(String id) Overrides org.keycloak.representations.JsonWebToken.id. Annotations @Override

back to summary

public AccessToken id(String id)

Overrides org.keycloak.representations.JsonWebToken.id.

Annotations

@Override

issuedAt	back to summary
public AccessToken issuedAt(int issuedAt) Overrides org.keycloak.representations.JsonWebToken.issuedAt. Annotations @Override

issuedAt

back to summary

public AccessToken issuedAt(int issuedAt)

Overrides org.keycloak.representations.JsonWebToken.issuedAt.

Annotations

@Override

issuedFor	back to summary
public AccessToken issuedFor(String issuedFor) Overrides org.keycloak.representations.JsonWebToken.issuedFor. Annotations @Override

issuedFor

back to summary

public AccessToken issuedFor(String issuedFor)

Overrides org.keycloak.representations.JsonWebToken.issuedFor.

Annotations

@Override

issuer	back to summary
public AccessToken issuer(String issuer) Overrides org.keycloak.representations.JsonWebToken.issuer. Annotations @Override

issuer

back to summary

public AccessToken issuer(String issuer)

Overrides org.keycloak.representations.JsonWebToken.issuer.

Annotations

@Override

isVerifyCaller	back to summary
public boolean isVerifyCaller() Does the realm require verifying the caller? Annotations @JsonIgnore

isVerifyCaller

back to summary

public boolean isVerifyCaller()

Does the realm require verifying the caller?

Annotations

@JsonIgnore

isVerifyCaller	back to summary
public boolean isVerifyCaller(String resource) Does the resource override the requirement of verifying the caller? Annotations @JsonIgnore

isVerifyCaller

back to summary

public boolean isVerifyCaller(String resource)

Does the resource override the requirement of verifying the caller?

Annotations

@JsonIgnore

notBefore	back to summary
public AccessToken notBefore(int notBefore) Overrides org.keycloak.representations.JsonWebToken.notBefore. Annotations @Override

notBefore

back to summary

public AccessToken notBefore(int notBefore)

Overrides org.keycloak.representations.JsonWebToken.notBefore.

Annotations

@Override

setAllowedOrigins	back to summary
public void setAllowedOrigins(Set<String> allowedOrigins)

setAuthorization	back to summary
public void setAuthorization(AccessToken.Authorization authorization)

setConfirmation	back to summary
public void setConfirmation(AccessToken.Confirmation confirmation)

setRealmAccess	back to summary
public void setRealmAccess(AccessToken.Access realmAccess)

setResourceAccess	back to summary
public void setResourceAccess(Map<String, AccessToken.Access> resourceAccess)

setScope	back to summary
public void setScope(String scope)

setTrustedCertificates	back to summary
public void setTrustedCertificates(Set<String> trustedCertificates)

subject	back to summary
public AccessToken subject(String subject) Overrides org.keycloak.representations.JsonWebToken.subject. Annotations @Override

subject

back to summary

public AccessToken subject(String subject)

Overrides org.keycloak.representations.JsonWebToken.subject.

Annotations

@Override

type	back to summary
public AccessToken type(String type) Overrides org.keycloak.representations.JsonWebToken.type. Annotations @Override

type

back to summary

public AccessToken type(String type)

Overrides org.keycloak.representations.JsonWebToken.type.

Annotations

@Override

org.keycloak.representations back to summary

public Class AccessToken.Access

Class Inheritance

extends Object
implements Serializable

java.lang.Object
org.keycloak.representations.AccessToken.Access

All Implemented Interfaces

java.io.Serializable

Field Summary

Modifier and Type	Field and Description
protected Set<String>	roles
protected Boolean	verifyCaller

Constructor Summary

Access	Constructor and Description
public	Access()

Method Summary

Modifier and Type	Method and Description
public AccessToken.Access	addRole(String role)
public AccessToken.Access	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
public Set<String>	getRoles()
public Boolean	getVerifyCaller()
public boolean	isUserInRole(String role)
public AccessToken.Access	roles(Set<String> roles)
public AccessToken.Access	verifyCaller(Boolean required)

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

Field Detail

roles	back to summary
protected Set<String> roles Annotations @JsonProperty:roles

verifyCaller	back to summary
protected Boolean verifyCaller Annotations @JsonProperty:verify_caller

Constructor Detail

Access	back to summary
public Access()

Method Detail

addRole	back to summary
public AccessToken.Access addRole(String role)

clone back to summary

clone	back to summary
public AccessToken.Access clone() Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:AccessToken.Access a clone of this instance.

public AccessToken.Access clone()

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:AccessToken.Access: a clone of this instance.

getRoles	back to summary
public Set<String> getRoles()

getVerifyCaller	back to summary
public Boolean getVerifyCaller()

isUserInRole	back to summary
public boolean isUserInRole(String role) Annotations @JsonIgnore

roles	back to summary
public AccessToken.Access roles(Set<String> roles)

verifyCaller	back to summary
public AccessToken.Access verifyCaller(Boolean required)

org.keycloak.representations back to summary

public Class AccessToken.Authorization

Class Inheritance

extends Object
implements Serializable

java.lang.Object
org.keycloak.representations.AccessToken.Authorization

All Implemented Interfaces

java.io.Serializable

Field Summary

Modifier and Type	Field and Description
private Collection<Permission>	permissions

Constructor Summary

Access	Constructor and Description
public	Authorization()

Method Summary

Modifier and Type	Method and Description
public Collection<Permission>	getPermissions()
public void	setPermissions(Collection<Permission> permissions)

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

Field Detail

permissions	back to summary
private Collection<Permission> permissions Annotations @JsonProperty:permissions

Constructor Detail

Authorization	back to summary
public Authorization()

Method Detail

getPermissions	back to summary
public Collection<Permission> getPermissions()

setPermissions	back to summary
public void setPermissions(Collection<Permission> permissions)

org.keycloak.representations back to summary

public Class AccessToken.Confirmation

Class Inheritance

extends Object

java.lang.Object
org.keycloak.representations.AccessToken.Confirmation

Field Summary

Modifier and Type	Field and Description
protected String	certThumbprint
protected String	keyThumbprint

Constructor Summary

Access	Constructor and Description
public	Confirmation()

Method Summary

Modifier and Type	Method and Description
public String	getCertThumbprint()
public String	getKeyThumbprint()
public void	setCertThumbprint(String certThumbprint)
public void	setKeyThumbprint(String keyThumbprint)

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

Field Detail

certThumbprint	back to summary
protected String certThumbprint Annotations @JsonProperty:x5t#S256

keyThumbprint	back to summary
protected String keyThumbprint Annotations @JsonProperty:jkt

Constructor Detail

Confirmation	back to summary
public Confirmation()

Method Detail

getCertThumbprint	back to summary
public String getCertThumbprint()

getKeyThumbprint	back to summary
public String getKeyThumbprint()

setCertThumbprint	back to summary
public void setCertThumbprint(String certThumbprint)

setKeyThumbprint	back to summary
public void setKeyThumbprint(String keyThumbprint)

public Class AccessToken

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class AccessToken.Access

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class AccessToken.Authorization

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class AccessToken.Confirmation

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail