Package com.okta.sdk.client

Enum AuthenticationScheme

java.lang.Object

java.lang.Enum<AuthenticationScheme>

com.okta.sdk.client.AuthenticationScheme

All Implemented Interfaces:

Serializable, Comparable<AuthenticationScheme>, java.lang.constant.Constable

public enum AuthenticationScheme
extends Enum<AuthenticationScheme>

Enumeration that defines the available HTTP authentication schemes to be used when communicating with the Okta API server.

The Authentication Scheme setting is helpful in cases where the code is run in a platform where the header information for outgoing HTTP requests is modified and thus causing communication issues.

One of SSWS (Okta session bearer token) (or) OAUTH2 authentication schemes should be used for the management SDK, NONE should be used for unauthenticated requests.

Since:

0.5.0

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
NONE
OAUTH2_PRIVATE_KEY
SSWS

Method Summary

Modifier and Type	Method	Description
String	getRequestAuthenticatorClassName()
static AuthenticationScheme	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AuthenticationScheme[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SSWS

public static final AuthenticationScheme SSWS

OAUTH2_PRIVATE_KEY

public static final AuthenticationScheme OAUTH2_PRIVATE_KEY

NONE

public static final AuthenticationScheme NONE

Method Details

values

public static AuthenticationScheme[] values()

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

Returns:

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

valueOf

public static AuthenticationScheme valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getRequestAuthenticatorClassName

public String getRequestAuthenticatorClassName()