com.aserto.directory.schema.v3

Enum UserStatus

java.lang.Object

java.lang.Enum<UserStatus>

com.aserto.directory.schema.v3.UserStatus

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<UserStatus>

public enum UserStatus
extends Enum<UserStatus>
implements com.google.protobuf.ProtocolMessageEnum

Protobuf enum aserto.directory.schema.v3.UserStatus

Enum Constant Summary

Enum Constants

Enum Constant and Description
UNRECOGNIZED
USER_STATUS_ACTIVE Active status, is when: * An admin adds a user and sets the user password without requiring email verification.
USER_STATUS_DEPROVISIONED Deprovisioned status, is when an administrator explicitly deactivates or deprovisions/deletes the account.
USER_STATUS_LOCKED_OUT Locked out status, is when the user exceeds the number of login attempts defined in the login policy.
USER_STATUS_PASSWORD_EXPIRED Password expired, status when the users' password has expired and the account requires an update to the password before a user is granted access.
USER_STATUS_PROVISIONED Provisioned status, is when the user object is provisioned, but the user has not provided verification by clicking through the activation email or provided a password.
USER_STATUS_RECOVERY Recovery status, when the user requests a password reset or an admin initiates one on their behalf.
USER_STATUS_STAGED Staged status, is when the user object is first created, before the activation flow is initiated, or if there is a pending admin action.
USER_STATUS_SUSPENDED Suspended status, when an admin explicitly suspends the user account.
USER_STATUS_UNKNOWN User status undefined

Field Summary

Fields

Modifier and Type	Field and Description
static int	USER_STATUS_ACTIVE_VALUE Active status, is when: * An admin adds a user and sets the user password without requiring email verification.
static int	USER_STATUS_DEPROVISIONED_VALUE Deprovisioned status, is when an administrator explicitly deactivates or deprovisions/deletes the account.
static int	USER_STATUS_LOCKED_OUT_VALUE Locked out status, is when the user exceeds the number of login attempts defined in the login policy.
static int	USER_STATUS_PASSWORD_EXPIRED_VALUE Password expired, status when the users' password has expired and the account requires an update to the password before a user is granted access.
static int	USER_STATUS_PROVISIONED_VALUE Provisioned status, is when the user object is provisioned, but the user has not provided verification by clicking through the activation email or provided a password.
static int	USER_STATUS_RECOVERY_VALUE Recovery status, when the user requests a password reset or an admin initiates one on their behalf.
static int	USER_STATUS_STAGED_VALUE Staged status, is when the user object is first created, before the activation flow is initiated, or if there is a pending admin action.
static int	USER_STATUS_SUSPENDED_VALUE Suspended status, when an admin explicitly suspends the user account.
static int	USER_STATUS_UNKNOWN_VALUE User status undefined

Method Summary

Modifier and Type	Method and Description
static UserStatus	forNumber(int value)
static com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<UserStatus>	internalGetValueMap()
static UserStatus	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
static UserStatus	valueOf(int value) Deprecated. Use forNumber(int) instead.
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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

USER_STATUS_UNKNOWN

public static final UserStatus USER_STATUS_UNKNOWN

 User status undefined
 

USER_STATUS_UNKNOWN = 0;

USER_STATUS_STAGED

public static final UserStatus USER_STATUS_STAGED

 Staged status, is when the user object is first created, before the activation flow is initiated, or if there is a pending admin action.
 

USER_STATUS_STAGED = 1;

USER_STATUS_PROVISIONED

public static final UserStatus USER_STATUS_PROVISIONED

 Provisioned status, is when the user object is provisioned, but the user has not provided verification by clicking through the activation email or provided a password.
 

USER_STATUS_PROVISIONED = 2;

USER_STATUS_ACTIVE

public static final UserStatus USER_STATUS_ACTIVE

 Active status, is when:
  * An admin adds a user and sets the user password without requiring email verification.
  * An admin adds a user, sets the user password, and requires the user to set their password when they first sign-in.
  * A user self-registers into a custom app or IDP and email verification is not required.
  * An admin explicitly activates the user.
 

USER_STATUS_ACTIVE = 3;

USER_STATUS_RECOVERY

public static final UserStatus USER_STATUS_RECOVERY

 Recovery status, when the user requests a password reset or an admin initiates one on their behalf.
 

USER_STATUS_RECOVERY = 4;

USER_STATUS_PASSWORD_EXPIRED

public static final UserStatus USER_STATUS_PASSWORD_EXPIRED

 Password expired, status when the users' password has expired and the account requires an update to the password before a user is granted access.
 

USER_STATUS_PASSWORD_EXPIRED = 5;

USER_STATUS_LOCKED_OUT

public static final UserStatus USER_STATUS_LOCKED_OUT

 Locked out status, is when the user exceeds the number of login attempts defined in the login policy.
 

USER_STATUS_LOCKED_OUT = 6;

USER_STATUS_SUSPENDED

public static final UserStatus USER_STATUS_SUSPENDED

 Suspended status, when an admin explicitly suspends the user account.
 

USER_STATUS_SUSPENDED = 7;

USER_STATUS_DEPROVISIONED

public static final UserStatus USER_STATUS_DEPROVISIONED

 Deprovisioned status, is when an administrator explicitly deactivates or deprovisions/deletes the account.
 

USER_STATUS_DEPROVISIONED = 8;

UNRECOGNIZED

public static final UserStatus UNRECOGNIZED

Field Detail

USER_STATUS_UNKNOWN_VALUE

public static final int USER_STATUS_UNKNOWN_VALUE

 User status undefined
 

USER_STATUS_UNKNOWN = 0;

See Also:

Constant Field Values

USER_STATUS_STAGED_VALUE

public static final int USER_STATUS_STAGED_VALUE

 Staged status, is when the user object is first created, before the activation flow is initiated, or if there is a pending admin action.
 

USER_STATUS_STAGED = 1;

See Also:

Constant Field Values

USER_STATUS_PROVISIONED_VALUE

public static final int USER_STATUS_PROVISIONED_VALUE

 Provisioned status, is when the user object is provisioned, but the user has not provided verification by clicking through the activation email or provided a password.
 

USER_STATUS_PROVISIONED = 2;

See Also:

Constant Field Values

USER_STATUS_ACTIVE_VALUE

public static final int USER_STATUS_ACTIVE_VALUE

 Active status, is when:
  * An admin adds a user and sets the user password without requiring email verification.
  * An admin adds a user, sets the user password, and requires the user to set their password when they first sign-in.
  * A user self-registers into a custom app or IDP and email verification is not required.
  * An admin explicitly activates the user.
 

USER_STATUS_ACTIVE = 3;

See Also:

Constant Field Values

USER_STATUS_RECOVERY_VALUE

public static final int USER_STATUS_RECOVERY_VALUE

 Recovery status, when the user requests a password reset or an admin initiates one on their behalf.
 

USER_STATUS_RECOVERY = 4;

See Also:

Constant Field Values

USER_STATUS_PASSWORD_EXPIRED_VALUE

public static final int USER_STATUS_PASSWORD_EXPIRED_VALUE

 Password expired, status when the users' password has expired and the account requires an update to the password before a user is granted access.
 

USER_STATUS_PASSWORD_EXPIRED = 5;

See Also:

Constant Field Values

USER_STATUS_LOCKED_OUT_VALUE

public static final int USER_STATUS_LOCKED_OUT_VALUE

 Locked out status, is when the user exceeds the number of login attempts defined in the login policy.
 

USER_STATUS_LOCKED_OUT = 6;

See Also:

Constant Field Values

USER_STATUS_SUSPENDED_VALUE

public static final int USER_STATUS_SUSPENDED_VALUE

 Suspended status, when an admin explicitly suspends the user account.
 

USER_STATUS_SUSPENDED = 7;

See Also:

Constant Field Values

USER_STATUS_DEPROVISIONED_VALUE

public static final int USER_STATUS_DEPROVISIONED_VALUE

 Deprovisioned status, is when an administrator explicitly deactivates or deprovisions/deletes the account.
 

USER_STATUS_DEPROVISIONED = 8;

See Also:

Constant Field Values

Method Detail

values

public static UserStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (UserStatus c : UserStatus.values())
    System.out.println(c);

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

getNumber

public final int getNumber()

Specified by:

getNumber in interface com.google.protobuf.Internal.EnumLite

Specified by:

getNumber in interface com.google.protobuf.ProtocolMessageEnum

valueOf

@Deprecated
public static UserStatus valueOf(int value)

Deprecated. Use forNumber(int) instead.

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

forNumber

public static UserStatus forNumber(int value)

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

internalGetValueMap

public static com.google.protobuf.Internal.EnumLiteMap<UserStatus> internalGetValueMap()

getValueDescriptor

public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

getDescriptorForType

public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

getDescriptor

public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

valueOf

public static UserStatus valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)