Package com.okta.sdk.resource.model

Class ProtocolOAuth

java.lang.Object

com.okta.sdk.resource.model.ProtocolOAuth

All Implemented Interfaces:

Serializable

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-01-23T09:59:24.143627-06:00[America/Chicago]",
           comments="Generator version: 7.8.0")
public class ProtocolOAuth
extends Object
implements Serializable

Protocol settings for authentication using the [OAuth 2.0 Authorization Code flow](https://tools.ietf.org/html/rfc6749#section-4.1)

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ProtocolOAuth.TypeEnum	OAuth 2.0 Authorization Code flow

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_CREDENTIALS
static final String	JSON_PROPERTY_ENDPOINTS
static final String	JSON_PROPERTY_SCOPES
static final String	JSON_PROPERTY_TYPE

Constructor Summary

Constructors

Constructor	Description
ProtocolOAuth()

Method Summary

Modifier and Type	Method	Description
ProtocolOAuth	addscopesItem(String scopesItem)
ProtocolOAuth	credentials(OAuthCredentials credentials)
ProtocolOAuth	endpoints(OAuthEndpoints endpoints)
boolean	equals(Object o)
OAuthCredentials	getCredentials()	Get credentials
OAuthEndpoints	getEndpoints()	Get endpoints
List<String>	getScopes()	IdP-defined permission bundles to request delegated access from the User > **Note:** The [Identity Provider type](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProvider/#tag/IdentityProvider/operation/createIdentityProvider!
ProtocolOAuth.TypeEnum	getType()	OAuth 2.0 Authorization Code flow
int	hashCode()
ProtocolOAuth	scopes(List<String> scopes)
void	setCredentials(OAuthCredentials credentials)
void	setEndpoints(OAuthEndpoints endpoints)
void	setScopes(List<String> scopes)
void	setType(ProtocolOAuth.TypeEnum type)
String	toString()
ProtocolOAuth	type(ProtocolOAuth.TypeEnum type)

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_CREDENTIALS

public static final String JSON_PROPERTY_CREDENTIALS

See Also:

• Constant Field Values

JSON_PROPERTY_ENDPOINTS

public static final String JSON_PROPERTY_ENDPOINTS

See Also:

• Constant Field Values

JSON_PROPERTY_SCOPES

public static final String JSON_PROPERTY_SCOPES

See Also:

• Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

• Constant Field Values

Constructor Details

ProtocolOAuth

public ProtocolOAuth()

Method Details

credentials

public ProtocolOAuth credentials(OAuthCredentials credentials)

getCredentials

@Nullable
public OAuthCredentials getCredentials()

Get credentials

Returns:

credentials

setCredentials

public void setCredentials(OAuthCredentials credentials)

endpoints

public ProtocolOAuth endpoints(OAuthEndpoints endpoints)

getEndpoints

@Nullable
public OAuthEndpoints getEndpoints()

Get endpoints

Returns:

endpoints

setEndpoints

public void setEndpoints(OAuthEndpoints endpoints)

scopes

public ProtocolOAuth scopes(List<String> scopes)

addscopesItem

public ProtocolOAuth addscopesItem(String scopesItem)

getScopes

@Nullable
public List<String> getScopes()

IdP-defined permission bundles to request delegated access from the User > **Note:** The [Identity Provider type](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProvider/#tag/IdentityProvider/operation/createIdentityProvider!path=type&t=request) table lists the scopes that are supported for each Identity Provider.

Returns:

scopes

setScopes

public void setScopes(List<String> scopes)

type

public ProtocolOAuth type(ProtocolOAuth.TypeEnum type)

getType

@Nullable
public ProtocolOAuth.TypeEnum getType()

OAuth 2.0 Authorization Code flow

Returns:

type

setType

public void setType(ProtocolOAuth.TypeEnum type)

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