Top Description Inners Fields Constructors Methods

org.keycloak.representations

public Class ClaimsRepresentation

Class Inheritance

extends Object

java.lang.Object
org.keycloak.representations.ClaimsRepresentation

Imports

java.util.List, .Map, com.fasterxml.jackson.annotation.JsonIgnore, .JsonProperty

Claims parameter as described in the OIDC specification https://openid.net/specs/openid-connect-core-1_0.html#ClaimsParameter

Author: Marek Posolda

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	ClaimsRepresentation.ClaimContext
public static class	ClaimsRepresentation.ClaimValue< Specifies the type of the claim CLAIM_TYPE>

Field Summary

Modifier and Type	Field and Description
private Map<String, ClaimsRepresentation.ClaimValue<CLAIM_TYPE>>	idTokenClaims
private Map<String, ClaimsRepresentation.ClaimValue<CLAIM_TYPE>>	userinfoClaims

Constructor Summary

Access	Constructor and Description
public	ClaimsRepresentation()

Method Summary

Modifier and Type	Method and Description
public <CLAIM_TYPE> ClaimsRepresentation.ClaimValue<CLAIM_TYPE>	Returns: Claim value getClaimValue(String claimName, ClaimsRepresentation.ClaimContext Whether we ask for claim to be presented in idToken or userInfo ctx, Class<CLAIM_TYPE> claimType class claimType)
public Map<String, ClaimsRepresentation.ClaimValue<CLAIM_TYPE>>	getIdTokenClaims()
public Map<String, ClaimsRepresentation.ClaimValue<CLAIM_TYPE>>	getUserinfoClaims()
public boolean	Returns: true if claim is presented in the claims parameter either as "null" claim (See OIDC specification for definition of null claim) or claim with some value isPresent(String claimName, ClaimsRepresentation.ClaimContext Whether we ask for claim to be presented in idToken or userInfo ctx)
public boolean	Returns: true if claim is presented in the claims parameter as "null" claim (See OIDC specification for definition of null claim) isPresentAsNullClaim(String claimName, ClaimsRepresentation.ClaimContext Whether we ask for claim to be presented in idToken or userInfo ctx)
public void	setIdTokenClaims(Map<String, ClaimsRepresentation.ClaimValue<CLAIM_TYPE>> idTokenClaims)
public void	setUserinfoClaims(Map<String, ClaimsRepresentation.ClaimValue<CLAIM_TYPE>> userinfoClaims)

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

Field Detail

idTokenClaims	back to summary
private Map<String, ClaimsRepresentation.ClaimValue<CLAIM_TYPE>> idTokenClaims Annotations @JsonProperty:id_token

userinfoClaims	back to summary
private Map<String, ClaimsRepresentation.ClaimValue<CLAIM_TYPE>> userinfoClaims Annotations @JsonProperty:userinfo

Constructor Detail

ClaimsRepresentation	back to summary
public ClaimsRepresentation()

Method Detail

getClaimValue	back to summary
public <CLAIM_TYPE> ClaimsRepresentation.ClaimValue<CLAIM_TYPE> getClaimValue(String claimName, ClaimsRepresentation.ClaimContext ctx, Class<CLAIM_TYPE> claimType) Parameters ctx:ClaimsRepresentation.ClaimContext Whether we ask for claim to be presented in idToken or userInfo claimType:Class<CLAIM_TYPE> claimType class Returns:ClaimsRepresentation.ClaimValue<CLAIM_TYPE> Claim value

getIdTokenClaims	back to summary
public Map<String, ClaimsRepresentation.ClaimValue<CLAIM_TYPE>> getIdTokenClaims()

getUserinfoClaims	back to summary
public Map<String, ClaimsRepresentation.ClaimValue<CLAIM_TYPE>> getUserinfoClaims()

isPresent	back to summary
public boolean isPresent(String claimName, ClaimsRepresentation.ClaimContext ctx) Parameters ctx:ClaimsRepresentation.ClaimContext Whether we ask for claim to be presented in idToken or userInfo Returns:boolean true if claim is presented in the claims parameter either as "null" claim (See OIDC specification for definition of null claim) or claim with some value

isPresentAsNullClaim	back to summary
public boolean isPresentAsNullClaim(String claimName, ClaimsRepresentation.ClaimContext ctx) Parameters ctx:ClaimsRepresentation.ClaimContext Whether we ask for claim to be presented in idToken or userInfo Returns:boolean true if claim is presented in the claims parameter as "null" claim (See OIDC specification for definition of null claim)

setIdTokenClaims	back to summary
public void setIdTokenClaims(Map<String, ClaimsRepresentation.ClaimValue<CLAIM_TYPE>> idTokenClaims)

setUserinfoClaims	back to summary
public void setUserinfoClaims(Map<String, ClaimsRepresentation.ClaimValue<CLAIM_TYPE>> userinfoClaims)

org.keycloak.representations back to summary

public final Enum ClaimsRepresentation.ClaimContext

Class Inheritance

extends Enum<ClaimsRepresentation.ClaimContext>

java.lang.Object
java.lang.Enum
org.keycloak.representations.ClaimsRepresentation.ClaimContext

Field Summary

Modifier and Type	Field and Description
public static final ClaimsRepresentation.ClaimContext	ID_TOKEN
public static final ClaimsRepresentation.ClaimContext	USERINFO

Constructor Summary

Access	Constructor and Description
private	ClaimContext()

Method Summary

Modifier and Type	Method and Description
public static ClaimsRepresentation.ClaimContext	valueOf(String name)
public static ClaimsRepresentation.ClaimContext[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ID_TOKEN	back to summary
public static final ClaimsRepresentation.ClaimContext ID_TOKEN

USERINFO	back to summary
public static final ClaimsRepresentation.ClaimContext USERINFO

Constructor Detail

ClaimContext	back to summary
private ClaimContext()

Method Detail

valueOf	back to summary
public static ClaimsRepresentation.ClaimContext valueOf(String name)

values	back to summary
public static ClaimsRepresentation.ClaimContext[] values()

org.keycloak.representations back to summary

public Class ClaimsRepresentation.ClaimValue<CLAIM_TYPE>

Class Inheritance

extends Object

java.lang.Object
org.keycloak.representations.ClaimsRepresentation.ClaimValue

Type Parameters

<CLAIM_TYPE>: Specifies the type of the claim

Field Summary

Modifier and Type	Field and Description
private Boolean	essential
private CLAIM_TYPE	value
private List<CLAIM_TYPE>	values

Constructor Summary

Access	Constructor and Description
public	ClaimValue()

Method Summary

Modifier and Type	Method and Description
public Boolean	getEssential()
public CLAIM_TYPE	getValue()
public List<CLAIM_TYPE>	getValues()
public boolean	isEssential()
public void	setEssential(Boolean essential)
public void	setValue(CLAIM_TYPE value)
public void	setValues(List<CLAIM_TYPE> values)

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

Field Detail

essential	back to summary
private Boolean essential

value	back to summary
private CLAIM_TYPE value

values	back to summary
private List<CLAIM_TYPE> values

Constructor Detail

ClaimValue	back to summary
public ClaimValue()

Method Detail

getEssential	back to summary
public Boolean getEssential()

getValue	back to summary
public CLAIM_TYPE getValue()

getValues	back to summary
public List<CLAIM_TYPE> getValues()

isEssential	back to summary
public boolean isEssential()

setEssential	back to summary
public void setEssential(Boolean essential)

setValue	back to summary
public void setValue(CLAIM_TYPE value)

setValues	back to summary
public void setValues(List<CLAIM_TYPE> values)