Package com.okta.sdk.resource.model

Class OAuth2Claim

java.lang.Object

com.okta.sdk.resource.model.OAuth2Claim

All Implemented Interfaces:

Serializable

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-09-23T08:35:59.300824-05:00[America/Chicago]",
           comments="Generator version: 7.8.0")
public class OAuth2Claim
extends Object
implements Serializable

OAuth2Claim

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_ALWAYS_INCLUDE_IN_TOKEN
static final String	JSON_PROPERTY_CLAIM_TYPE
static final String	JSON_PROPERTY_CONDITIONS
static final String	JSON_PROPERTY_GROUP_FILTER_TYPE
static final String	JSON_PROPERTY_ID
static final String	JSON_PROPERTY_LINKS
static final String	JSON_PROPERTY_NAME
static final String	JSON_PROPERTY_STATUS
static final String	JSON_PROPERTY_SYSTEM
static final String	JSON_PROPERTY_VALUE
static final String	JSON_PROPERTY_VALUE_TYPE

Constructor Summary

Constructors

Constructor	Description
OAuth2Claim()

Method Summary

Modifier and Type	Method	Description
OAuth2Claim	alwaysIncludeInToken(Boolean alwaysIncludeInToken)
OAuth2Claim	claimType(OAuth2ClaimType claimType)
OAuth2Claim	conditions(OAuth2ClaimConditions conditions)
boolean	equals(Object o)
Boolean	getAlwaysIncludeInToken()	Specifies whether to include Claims in the token.
OAuth2ClaimType	getClaimType()	Get claimType
OAuth2ClaimConditions	getConditions()	Get conditions
OAuth2ClaimGroupFilterType	getGroupFilterType()	Get groupFilterType
String	getId()	ID of the Claim
LinksSelf	getLinks()	Get links
String	getName()	Name of the Claim
LifecycleStatus	getStatus()	Get status
Boolean	getSystem()	When `true`, indicates that Okta created the Claim
String	getValue()	Specifies the value of the Claim.
OAuth2ClaimValueType	getValueType()	Get valueType
OAuth2Claim	groupFilterType(OAuth2ClaimGroupFilterType groupFilterType)
int	hashCode()
OAuth2Claim	links(LinksSelf links)
OAuth2Claim	name(String name)
void	setAlwaysIncludeInToken(Boolean alwaysIncludeInToken)
void	setClaimType(OAuth2ClaimType claimType)
void	setConditions(OAuth2ClaimConditions conditions)
void	setGroupFilterType(OAuth2ClaimGroupFilterType groupFilterType)
void	setLinks(LinksSelf links)
void	setName(String name)
void	setStatus(LifecycleStatus status)
void	setSystem(Boolean system)
void	setValue(String value)
void	setValueType(OAuth2ClaimValueType valueType)
OAuth2Claim	status(LifecycleStatus status)
OAuth2Claim	system(Boolean system)
String	toString()
OAuth2Claim	value(String value)
OAuth2Claim	valueType(OAuth2ClaimValueType valueType)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_ALWAYS_INCLUDE_IN_TOKEN

public static final String JSON_PROPERTY_ALWAYS_INCLUDE_IN_TOKEN

See Also:

• Constant Field Values

JSON_PROPERTY_CLAIM_TYPE

public static final String JSON_PROPERTY_CLAIM_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_CONDITIONS

public static final String JSON_PROPERTY_CONDITIONS

See Also:

• Constant Field Values

JSON_PROPERTY_GROUP_FILTER_TYPE

public static final String JSON_PROPERTY_GROUP_FILTER_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_ID

public static final String JSON_PROPERTY_ID

See Also:

• Constant Field Values

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_STATUS

public static final String JSON_PROPERTY_STATUS

See Also:

• Constant Field Values

JSON_PROPERTY_SYSTEM

public static final String JSON_PROPERTY_SYSTEM

See Also:

• Constant Field Values

JSON_PROPERTY_VALUE

public static final String JSON_PROPERTY_VALUE

See Also:

• Constant Field Values

JSON_PROPERTY_VALUE_TYPE

public static final String JSON_PROPERTY_VALUE_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_LINKS

public static final String JSON_PROPERTY_LINKS

See Also:

• Constant Field Values

Constructor Details

OAuth2Claim

public OAuth2Claim()

Method Details

alwaysIncludeInToken

public OAuth2Claim alwaysIncludeInToken(Boolean alwaysIncludeInToken)

getAlwaysIncludeInToken

@Nullable
public Boolean getAlwaysIncludeInToken()

Specifies whether to include Claims in the token. The value is always `TRUE` for access token Claims. If the value is set to `FALSE` for an ID token claim, the Claim isn't included in the ID token when the token is requested with the access token or with the `authorization_code`. The client instead uses the access token to get Claims from the `/userinfo` endpoint.

Returns:

alwaysIncludeInToken

setAlwaysIncludeInToken

public void setAlwaysIncludeInToken(Boolean alwaysIncludeInToken)

claimType

public OAuth2Claim claimType(OAuth2ClaimType claimType)

getClaimType

@Nullable
public OAuth2ClaimType getClaimType()

Get claimType

Returns:

claimType

setClaimType

public void setClaimType(OAuth2ClaimType claimType)

conditions

public OAuth2Claim conditions(OAuth2ClaimConditions conditions)

getConditions

@Nullable
public OAuth2ClaimConditions getConditions()

Get conditions

Returns:

conditions

setConditions

public void setConditions(OAuth2ClaimConditions conditions)

groupFilterType

public OAuth2Claim groupFilterType(OAuth2ClaimGroupFilterType groupFilterType)

getGroupFilterType

@Nullable
public OAuth2ClaimGroupFilterType getGroupFilterType()

Get groupFilterType

Returns:

groupFilterType

setGroupFilterType

public void setGroupFilterType(OAuth2ClaimGroupFilterType groupFilterType)

getId

@Nullable
public String getId()

ID of the Claim

Returns:

id

name

public OAuth2Claim name(String name)

getName

@Nullable
public String getName()

Name of the Claim

Returns:

name

setName

public void setName(String name)

status

public OAuth2Claim status(LifecycleStatus status)

getStatus

@Nullable
public LifecycleStatus getStatus()

Get status

Returns:

status

setStatus

public void setStatus(LifecycleStatus status)

system

public OAuth2Claim system(Boolean system)

getSystem

@Nullable
public Boolean getSystem()

When `true`, indicates that Okta created the Claim

Returns:

system

setSystem

public void setSystem(Boolean system)

value

public OAuth2Claim value(String value)

getValue

@Nullable
public String getValue()

Specifies the value of the Claim. This value must be a string literal if `valueType` is `GROUPS`, and the string literal is matched with the selected `group_filter_type`. The value must be an Okta EL expression if `valueType` is `EXPRESSION`.

Returns:

value

setValue

public void setValue(String value)

valueType

public OAuth2Claim valueType(OAuth2ClaimValueType valueType)

getValueType

@Nullable
public OAuth2ClaimValueType getValueType()

Get valueType

Returns:

valueType

setValueType

public void setValueType(OAuth2ClaimValueType valueType)

links

public OAuth2Claim links(LinksSelf links)

getLinks

@Nullable
public LinksSelf getLinks()

Get links

Returns:

links

setLinks

public void setLinks(LinksSelf links)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object