Package com.okta.sdk.resource.model

Class OAuth2Scope

java.lang.Object

com.okta.sdk.resource.model.OAuth2Scope

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 OAuth2Scope
extends Object
implements Serializable

OAuth2Scope

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_CONSENT
static final String	JSON_PROPERTY_DEFAULT
static final String	JSON_PROPERTY_DESCRIPTION
static final String	JSON_PROPERTY_DISPLAY_NAME
static final String	JSON_PROPERTY_ID
static final String	JSON_PROPERTY_LINKS
static final String	JSON_PROPERTY_METADATA_PUBLISH
static final String	JSON_PROPERTY_NAME
static final String	JSON_PROPERTY_OPTIONAL
static final String	JSON_PROPERTY_SYSTEM

Constructor Summary

Constructors

Constructor	Description
OAuth2Scope()

Method Summary

Modifier and Type	Method	Description
OAuth2Scope	_default(Boolean _default)
OAuth2Scope	consent(OAuth2ScopeConsentType consent)
OAuth2Scope	description(String description)
OAuth2Scope	displayName(String displayName)
boolean	equals(Object o)
OAuth2ScopeConsentType	getConsent()	Get consent
Boolean	getDefault()	Indicates if this Scope is a default scope
String	getDescription()	Description of the Scope
String	getDisplayName()	Name of the end user displayed in a consent dialog
String	getId()	Scope object ID
LinksSelf	getLinks()	Get links
OAuth2ScopeMetadataPublish	getMetadataPublish()	Get metadataPublish
String	getName()	Scope name
Boolean	getOptional()	Indicates whether the Scope is optional.
Boolean	getSystem()	Indicates if Okta created the Scope
int	hashCode()
OAuth2Scope	links(LinksSelf links)
OAuth2Scope	metadataPublish(OAuth2ScopeMetadataPublish metadataPublish)
OAuth2Scope	name(String name)
OAuth2Scope	optional(Boolean optional)
void	setConsent(OAuth2ScopeConsentType consent)
void	setDefault(Boolean _default)
void	setDescription(String description)
void	setDisplayName(String displayName)
void	setLinks(LinksSelf links)
void	setMetadataPublish(OAuth2ScopeMetadataPublish metadataPublish)
void	setName(String name)
void	setOptional(Boolean optional)
void	setSystem(Boolean system)
OAuth2Scope	system(Boolean system)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_CONSENT

public static final String JSON_PROPERTY_CONSENT

See Also:

• Constant Field Values

JSON_PROPERTY_DEFAULT

public static final String JSON_PROPERTY_DEFAULT

See Also:

• Constant Field Values

JSON_PROPERTY_DESCRIPTION

public static final String JSON_PROPERTY_DESCRIPTION

See Also:

• Constant Field Values

JSON_PROPERTY_DISPLAY_NAME

public static final String JSON_PROPERTY_DISPLAY_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_ID

public static final String JSON_PROPERTY_ID

See Also:

• Constant Field Values

JSON_PROPERTY_METADATA_PUBLISH

public static final String JSON_PROPERTY_METADATA_PUBLISH

See Also:

• Constant Field Values

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_OPTIONAL

public static final String JSON_PROPERTY_OPTIONAL

See Also:

• Constant Field Values

JSON_PROPERTY_SYSTEM

public static final String JSON_PROPERTY_SYSTEM

See Also:

• Constant Field Values

JSON_PROPERTY_LINKS

public static final String JSON_PROPERTY_LINKS

See Also:

• Constant Field Values

Constructor Details

OAuth2Scope

public OAuth2Scope()

Method Details

consent

public OAuth2Scope consent(OAuth2ScopeConsentType consent)

getConsent

@Nullable
public OAuth2ScopeConsentType getConsent()

Get consent

Returns:

consent

setConsent

public void setConsent(OAuth2ScopeConsentType consent)

_default

public OAuth2Scope _default(Boolean _default)

getDefault

@Nullable
public Boolean getDefault()

Indicates if this Scope is a default scope

Returns:

_default

setDefault

public void setDefault(Boolean _default)

description

public OAuth2Scope description(String description)

getDescription

@Nullable
public String getDescription()

Description of the Scope

Returns:

description

setDescription

public void setDescription(String description)

displayName

public OAuth2Scope displayName(String displayName)

getDisplayName

@Nullable
public String getDisplayName()

Name of the end user displayed in a consent dialog

Returns:

displayName

setDisplayName

public void setDisplayName(String displayName)

getId

@Nullable
public String getId()

Scope object ID

Returns:

id

metadataPublish

public OAuth2Scope metadataPublish(OAuth2ScopeMetadataPublish metadataPublish)

getMetadataPublish

@Nullable
public OAuth2ScopeMetadataPublish getMetadataPublish()

Get metadataPublish

Returns:

metadataPublish

setMetadataPublish

public void setMetadataPublish(OAuth2ScopeMetadataPublish metadataPublish)

name

public OAuth2Scope name(String name)

getName

@Nonnull
public String getName()

Scope name

Returns:

name

setName

public void setName(String name)

optional

public OAuth2Scope optional(Boolean optional)

getOptional

@Nullable
public Boolean getOptional()

Indicates whether the Scope is optional. When set to `true`, the user can skip consent for the scope.

Returns:

optional

setOptional

public void setOptional(Boolean optional)

system

public OAuth2Scope system(Boolean system)

getSystem

@Nullable
public Boolean getSystem()

Indicates if Okta created the Scope

Returns:

system

setSystem

public void setSystem(Boolean system)

links

public OAuth2Scope 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