Package com.mypurecloud.sdk.v2.model

Enum Class OAuthClient.AuthorizedGrantTypeEnum

java.lang.Object

java.lang.Enum<OAuthClient.AuthorizedGrantTypeEnum>

com.mypurecloud.sdk.v2.model.OAuthClient.AuthorizedGrantTypeEnum

All Implemented Interfaces:

Serializable, Comparable<OAuthClient.AuthorizedGrantTypeEnum>, java.lang.constant.Constable

Enclosing class:

OAuthClient

public static enum OAuthClient.AuthorizedGrantTypeEnum
extends Enum<OAuthClient.AuthorizedGrantTypeEnum>

The OAuth Grant/Client type supported by this client. Code Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured. PKCE-Enabled Code Authorization grant type - Code grant type which requires PKCE challenge and verifier to create tokens. Used in public clients for increased security. Implicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured. SAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint. Client Credential grant type - Used to created access tokens that are tied only to the client.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLIENT_CREDENTIALS
CODE
OUTDATEDSDKVERSION
PASSWORD
SAML2_BEARER
TOKEN

Method Summary

Modifier and Type	Method	Description
static OAuthClient.AuthorizedGrantTypeEnum	fromString(String key)
String	toString()
static OAuthClient.AuthorizedGrantTypeEnum	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OAuthClient.AuthorizedGrantTypeEnum[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OUTDATEDSDKVERSION

public static final OAuthClient.AuthorizedGrantTypeEnum OUTDATEDSDKVERSION

CODE

public static final OAuthClient.AuthorizedGrantTypeEnum CODE

TOKEN

public static final OAuthClient.AuthorizedGrantTypeEnum TOKEN

SAML2_BEARER

public static final OAuthClient.AuthorizedGrantTypeEnum SAML2_BEARER

PASSWORD

public static final OAuthClient.AuthorizedGrantTypeEnum PASSWORD

CLIENT_CREDENTIALS

public static final OAuthClient.AuthorizedGrantTypeEnum CLIENT_CREDENTIALS

Method Details

values

public static OAuthClient.AuthorizedGrantTypeEnum[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static OAuthClient.AuthorizedGrantTypeEnum valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

fromString

public static OAuthClient.AuthorizedGrantTypeEnum fromString(String key)

toString

public String toString()

Overrides:

toString in class Enum<OAuthClient.AuthorizedGrantTypeEnum>