Enum ModifiablePasswordPolicyStateJSONField
- java.lang.Object
-
- java.lang.Enum<ModifiablePasswordPolicyStateJSONField>
-
- com.unboundid.ldap.sdk.unboundidds.ModifiablePasswordPolicyStateJSONField
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<ModifiablePasswordPolicyStateJSONField>
public enum ModifiablePasswordPolicyStateJSONField extends java.lang.Enum<ModifiablePasswordPolicyStateJSONField>
This enum defines the set of fields that are supported for use with theModifiablePasswordPolicyStateJSON
object.
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ACCOUNT_ACTIVATION_TIME
The field (account-activation-time) used to hold the user's account activation time.ACCOUNT_EXPIRATION_TIME
The field (account-expiration-time) used to hold the user's account expiration time.ACCOUNT_IS_DISABLED
The field (account-is-disabled) used to indicate whether the user's account has been administratively disabled.ACCOUNT_IS_FAILURE_LOCKED
The field (account-is-failure-locked) used to indicate whether the user's account is locked as a result of too many failed authentication attempts.MUST_CHANGE_PASSWORD
The field (must-change-password) used to indicate whether the user must change their password before they will be permitted to request any other operations in the server.PASSWORD_CHANGED_TIME
The field (password-changed-time) used to hold the time the user's password was last changed.PASSWORD_EXPIRATION_WARNED_TIME
The field (password-expiration-warned-time) used to hold the time that the user was first warned about an upcoming password expiration.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ModifiablePasswordPolicyStateJSONField
forName(java.lang.String name)
Retrieves the modifiable password policy state JSON field value with the specified name.java.lang.String
getFieldName()
Retrieves the name for the JSON field.java.lang.String
toString()
Retrieves a string representation of this modifiable password policy state JSON field.static ModifiablePasswordPolicyStateJSONField
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static ModifiablePasswordPolicyStateJSONField[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
PASSWORD_CHANGED_TIME
public static final ModifiablePasswordPolicyStateJSONField PASSWORD_CHANGED_TIME
The field (password-changed-time) used to hold the time the user's password was last changed. If present, the value of this field may be a string containing a timestamp in the ISO 8601 format described in RFC 3339, or it may be the JSON null value to indicate that the user does not have a password changed time. Note that setting this field tonull
will cause the server to fall back to using the entry's createTimestamp value (if available) as the last changed time.
-
ACCOUNT_IS_DISABLED
public static final ModifiablePasswordPolicyStateJSONField ACCOUNT_IS_DISABLED
The field (account-is-disabled) used to indicate whether the user's account has been administratively disabled.
-
ACCOUNT_ACTIVATION_TIME
public static final ModifiablePasswordPolicyStateJSONField ACCOUNT_ACTIVATION_TIME
The field (account-activation-time) used to hold the user's account activation time. If present, the value of this field may be a string containing a timestamp in the ISO 8601 format described in RFC 3339, or it may be the JSON null value to indicate that the user does not have an account activation time.
-
ACCOUNT_EXPIRATION_TIME
public static final ModifiablePasswordPolicyStateJSONField ACCOUNT_EXPIRATION_TIME
The field (account-expiration-time) used to hold the user's account expiration time. If present, the value of this field may be a string containing a timestamp in the ISO 8601 format described in RFC 3339, or it may be the JSON null value to indicate that the user does not have an account expiration time.
-
ACCOUNT_IS_FAILURE_LOCKED
public static final ModifiablePasswordPolicyStateJSONField ACCOUNT_IS_FAILURE_LOCKED
The field (account-is-failure-locked) used to indicate whether the user's account is locked as a result of too many failed authentication attempts.
-
PASSWORD_EXPIRATION_WARNED_TIME
public static final ModifiablePasswordPolicyStateJSONField PASSWORD_EXPIRATION_WARNED_TIME
The field (password-expiration-warned-time) used to hold the time that the user was first warned about an upcoming password expiration. If present, the value of this field may be a string containing a timestamp in the ISO 8601 format described in RFC 3339, or it may be the JSON null value to indicate that the user does not have a password expiration warned time.
-
MUST_CHANGE_PASSWORD
public static final ModifiablePasswordPolicyStateJSONField MUST_CHANGE_PASSWORD
The field (must-change-password) used to indicate whether the user must change their password before they will be permitted to request any other operations in the server.
-
-
Method Detail
-
values
public static ModifiablePasswordPolicyStateJSONField[] 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 (ModifiablePasswordPolicyStateJSONField c : ModifiablePasswordPolicyStateJSONField.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ModifiablePasswordPolicyStateJSONField valueOf(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
getFieldName
@NotNull public java.lang.String getFieldName()
Retrieves the name for the JSON field.- Returns:
- The name for the JSON field.
-
forName
@Nullable public static ModifiablePasswordPolicyStateJSONField forName(@NotNull java.lang.String name)
Retrieves the modifiable password policy state JSON field value with the specified name.- Parameters:
name
- The name of the password policy state JSON field value to retrieve. It must not benull
.- Returns:
- The modifiable password policy state JSON field value with the
specified name, or
null
if there is no value with the specified name.
-
toString
@NotNull public java.lang.String toString()
Retrieves a string representation of this modifiable password policy state JSON field.- Overrides:
toString
in classjava.lang.Enum<ModifiablePasswordPolicyStateJSONField>
- Returns:
- A string representation of this password policy state JSON field.
-
-