Package com.okta.sdk.resource.model

Enum UserStatus

java.lang.Object

java.lang.Enum<UserStatus>

com.okta.sdk.resource.model.UserStatus

All Implemented Interfaces:

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

public enum UserStatus
extends Enum<UserStatus>

The current status of the user. The status of a User changes in response to explicit events, such as admin-driven lifecycle changes, user login, or self-service password recovery. Okta doesn't asynchronously sweep through users and update their password expiry state, for example. Instead, Okta evaluates password policy at login time, notices the password has expired, and moves the User to the expired state. When running reports, remember that the data is valid as of the last login or lifecycle event for that user.

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
ACTIVE
DEPROVISIONED
LOCKED_OUT
PASSWORD_EXPIRED
PROVISIONED
RECOVERY
STAGED
SUSPENDED
UNKNOWN_DEFAULT_OPEN_API

Method Summary

Modifier and Type	Method	Description
static UserStatus	fromValue(String value)
String	getValue()
String	toString()
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.
static UserStatus	valueOf(String name)	Returns the enum constant of this type with the specified name.
static UserStatus[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ACTIVE

public static final UserStatus ACTIVE

DEPROVISIONED

public static final UserStatus DEPROVISIONED

LOCKED_OUT

public static final UserStatus LOCKED_OUT

PASSWORD_EXPIRED

public static final UserStatus PASSWORD_EXPIRED

PROVISIONED

public static final UserStatus PROVISIONED

RECOVERY

public static final UserStatus RECOVERY

STAGED

public static final UserStatus STAGED

SUSPENDED

public static final UserStatus SUSPENDED

UNKNOWN_DEFAULT_OPEN_API

public static final UserStatus UNKNOWN_DEFAULT_OPEN_API

Method Details

values

public static UserStatus[] 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 UserStatus 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

getValue

public String getValue()

toString

public String toString()

Overrides:

toString in class Enum<UserStatus>

fromValue

public static UserStatus fromValue(String value)

toUrlQueryString

public String toUrlQueryString(String prefix)

Convert the instance into URL query string.

Parameters:

prefix - prefix of the query string

Returns:

URL query string