Enum ManageAccountSubCommandType
java.lang.Object
java.lang.Enum<ManageAccountSubCommandType>
com.unboundid.ldap.sdk.unboundidds.tools.ManageAccountSubCommandType
- All Implemented Interfaces:
Serializable,Comparable<ManageAccountSubCommandType>,java.lang.constant.Constable
This enum provides information about all of the subcommands available for
use with the manage-account tool.
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.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe subcommand used to add one or more values to the set of authentication failure times for a user.The subcommand used to add one or more values to the set of grace login use times for a user.The subcommand used to add one or more registered YubiKey OTP device public IDs for a user.The subcommand used to add one or more TOTP shared secrets for a user.The subcommand used to clear the account activation time for a user.The subcommand used to clear the account expiration time for a user.The subcommand used to clear the account disabled state for a user.The subcommand used to clear the set of authentication failure times for a user.The subcommand used to clear the grace login use times for a user.The subcommand used to clear the time that the server last invoked password validators for a bind operation.The subcommand used to clear the last login IP address for a user.The subcommand used to clear the last login time for a user.The subcommand used to clear whether a user's password has been administratively reset.The subcommand used to clear the most recent required password change time with which a user has complied.The subcommand used to clear the password changed time for a user.The subcommand used to clear the password expiration warned time for a user.The subcommand used to clear a user's password history.The subcommand used to clear the recent login history for a user.The subcommand used to clear the set of registered YubiKey OTP device public IDs for a user.The subcommand used to purge a user's retired password.The subcommand used to clear the TOTP shared secrets for a user.The subcommand used to get the account activation time for a user.The subcommand used to get the account expiration time for a user.The subcommand used to determine whether a user account is administratively disabled.The subcommand used to determine whether a user's account is expired.The subcommand used to determine whether a user account is failure locked.The subcommand used to determine whether a user account is idle locked.The subcommand used to determine whether a user's account is not yet active.The subcommand used to determine whether a user's account is reset locked.The subcommand used to determine whether an account is usable.The subcommand used to determine whether a user account is validation locked.The subcommand used to retrieve the set of password policy state account usability error messages for a user.The subcommand used to retrieve the set of password policy state account usability notice messages for a user.The subcommand used to retrieve the set of password policy state account usability warning messages for a user.The subcommand used to get all state information for a user.The subcommand used to retrieve the times of the failed authentication attempts for a user.The subcommand used to obtain a list of the OTP delivery mechanisms that are available for a user.The subcommand used to obtain a list of the SASL mechanisms that are available for a user.The subcommand used to retrieve the failure lockout time for a user.The subcommand used to retrieve the grace login use times for a user.The subcommand used to determine whether a user account has at least one registered YubiKey OTP device public ID.The subcommand used to determine whether a user has a retired password.The subcommand used to determine whether a user account has at least one static password.The subcommand used to determine whether a user account has at least one TOTP shared secret.The subcommand used to determine the time that a user's account was/will be idle locked.The subcommand used to retrieve the time that the server last invoked password validators for a bind operation.The subcommand used to retrieve the last login IP address for a user.The subcommand used to retrieve the last login time for a user.The subcommand used to determine whether a user's password has been administratively reset.The subcommand used to retrieve the most recent required password change time with which a user has complied.The subcommand used to get the password changed time for a user.The subcommand used to retrieve the password expiration time for a user.The subcommand used to retrieve the time a user received the first warning about an upcoming password expiration.The subcommand used to retrieve the number of passwords in a user's password history.The subcommand used to determine whether a user's password is expired.The subcommand used to get the DN of a user's password policy.The subcommand used to determine the time a user's account was/will be reset locked.The subcommand used to retrieve the time that a user's former password was retired.The subcommand used to retrieve the recent login history for a user.The subcommand used to retrieve the set of registered YubiKey OTP device public IDs for a user.The subcommand used to determine the number of remaining failed authentication attempts for a user before the account is locked.The subcommand used to retrieve the number of remaining grace logins for a user.The subcommand used to determine the time that a user's retired password will expire.The subcommand used to retrieve the length of time in seconds since the server last invoked password validators for a bind operation.The subcommand used to retrieve the length of time until a user's account becomes active.The subcommand used to retrieve the length of time until a user's account expires.The subcommand used to determine the length of time in seconds until a user's temporary failure lockout will expire.The subcommand used to determine the length of time in seconds until a user's account will be idle locked.The subcommand used to get the length of time in seconds until a user's password will expire.The subcommand used to get the length of time in seconds until a user may start to receive warnings about an upcoming expiration.The subcommand used to determine the length of time in seconds until a user's account is reset locked.The subcommand used to determine the length of seconds until the required password changed time for a user.The subcommand used to remove one or more registered YubiKey OTP device public IDs for a user.The subcommand used to remove one or more TOTP shared secrets for a user.The subcommand used to set the account activation time for a user.The subcommand used to set the account expiration time for a user.The subcommand used to specify whether a user account is administratively disabled.The subcommand used to specify whether a user account is failure locked.The subcommand used to specify whether a user account is validation locked.The subcommand used to replace the set of authentication failure times for a user.The subcommand used to specify the grace login use times for a user.The subcommand used to specify the time that the server last invoked password validators for a bind operation.The subcommand used to specify the last login IP address for a user.The subcommand used to specify the last login time for a user.The subcommand used to specify whether a user's password has been administratively reset.The subcommand used to specify the most recent required password change time with which a user has complied.The subcommand used to set the password changed time for a user.The subcommand used to specify the time a user received the first warning about an upcoming password expiration.The subcommand used to replace the set of registered YubiKey OTP device public IDs for a user.The subcommand used to replace the TOTP shared secrets for a user. -
Method Summary
Modifier and TypeMethodDescriptionstatic ManageAccountSubCommandTypeRetrieves the subcommand type with the specified name.static ManageAccountSubCommandTypeforOperationType(int opType) Retrieves the subcommand type with the specified password policy state operation type.Retrieves a list containing all names (primary and alternate) for this subcommand.Retrieves the alternate names for this subcommand, if any.Retrieves the description for the subcommand.intRetrieves the password policy state operation type value that corresponds to this subcommand type.Retrieves the primary name for the subcommand.static ManageAccountSubCommandTypeReturns the enum constant of this type with the specified name.static ManageAccountSubCommandType[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
GET_ALL
The subcommand used to get all state information for a user. -
GET_PASSWORD_POLICY_DN
The subcommand used to get the DN of a user's password policy. -
GET_ACCOUNT_IS_USABLE
The subcommand used to determine whether an account is usable. -
GET_ACCOUNT_USABILITY_NOTICES
The subcommand used to retrieve the set of password policy state account usability notice messages for a user. -
GET_ACCOUNT_USABILITY_WARNINGS
The subcommand used to retrieve the set of password policy state account usability warning messages for a user. -
GET_ACCOUNT_USABILITY_ERRORS
The subcommand used to retrieve the set of password policy state account usability error messages for a user. -
GET_PASSWORD_CHANGED_TIME
The subcommand used to get the password changed time for a user. -
SET_PASSWORD_CHANGED_TIME
The subcommand used to set the password changed time for a user. -
CLEAR_PASSWORD_CHANGED_TIME
The subcommand used to clear the password changed time for a user. -
GET_ACCOUNT_IS_DISABLED
The subcommand used to determine whether a user account is administratively disabled. -
SET_ACCOUNT_IS_DISABLED
The subcommand used to specify whether a user account is administratively disabled. -
CLEAR_ACCOUNT_IS_DISABLED
The subcommand used to clear the account disabled state for a user. -
GET_ACCOUNT_ACTIVATION_TIME
The subcommand used to get the account activation time for a user. -
SET_ACCOUNT_ACTIVATION_TIME
The subcommand used to set the account activation time for a user. -
CLEAR_ACCOUNT_ACTIVATION_TIME
The subcommand used to clear the account activation time for a user. -
GET_SECONDS_UNTIL_ACCOUNT_ACTIVATION
The subcommand used to retrieve the length of time until a user's account becomes active. -
GET_ACCOUNT_IS_NOT_YET_ACTIVE
The subcommand used to determine whether a user's account is not yet active. -
GET_ACCOUNT_EXPIRATION_TIME
The subcommand used to get the account expiration time for a user. -
SET_ACCOUNT_EXPIRATION_TIME
The subcommand used to set the account expiration time for a user. -
CLEAR_ACCOUNT_EXPIRATION_TIME
The subcommand used to clear the account expiration time for a user. -
GET_SECONDS_UNTIL_ACCOUNT_EXPIRATION
The subcommand used to retrieve the length of time until a user's account expires. -
GET_ACCOUNT_IS_EXPIRED
The subcommand used to determine whether a user's account is expired. -
GET_PASSWORD_EXPIRATION_WARNED_TIME
The subcommand used to retrieve the time a user received the first warning about an upcoming password expiration. -
SET_PASSWORD_EXPIRATION_WARNED_TIME
The subcommand used to specify the time a user received the first warning about an upcoming password expiration. -
CLEAR_PASSWORD_EXPIRATION_WARNED_TIME
The subcommand used to clear the password expiration warned time for a user. -
GET_SECONDS_UNTIL_PASSWORD_EXPIRATION_WARNING
The subcommand used to get the length of time in seconds until a user may start to receive warnings about an upcoming expiration. -
GET_PASSWORD_EXPIRATION_TIME
The subcommand used to retrieve the password expiration time for a user. -
GET_SECONDS_UNTIL_PASSWORD_EXPIRATION
The subcommand used to get the length of time in seconds until a user's password will expire. -
GET_PASSWORD_IS_EXPIRED
The subcommand used to determine whether a user's password is expired. -
GET_ACCOUNT_IS_FAILURE_LOCKED
The subcommand used to determine whether a user account is failure locked. -
SET_ACCOUNT_IS_FAILURE_LOCKED
The subcommand used to specify whether a user account is failure locked. -
GET_FAILURE_LOCKOUT_TIME
The subcommand used to retrieve the failure lockout time for a user. -
GET_SECONDS_UNTIL_AUTHENTICATION_FAILURE_UNLOCK
The subcommand used to determine the length of time in seconds until a user's temporary failure lockout will expire. -
GET_AUTHENTICATION_FAILURE_TIMES
The subcommand used to retrieve the times of the failed authentication attempts for a user. -
ADD_AUTHENTICATION_FAILURE_TIME
The subcommand used to add one or more values to the set of authentication failure times for a user. -
SET_AUTHENTICATION_FAILURE_TIMES
The subcommand used to replace the set of authentication failure times for a user. -
CLEAR_AUTHENTICATION_FAILURE_TIMES
The subcommand used to clear the set of authentication failure times for a user. -
GET_REMAINING_AUTHENTICATION_FAILURE_COUNT
The subcommand used to determine the number of remaining failed authentication attempts for a user before the account is locked. -
GET_ACCOUNT_IS_IDLE_LOCKED
The subcommand used to determine whether a user account is idle locked. -
GET_SECONDS_UNTIL_IDLE_LOCKOUT
The subcommand used to determine the length of time in seconds until a user's account will be idle locked. -
GET_IDLE_LOCKOUT_TIME
The subcommand used to determine the time that a user's account was/will be idle locked. -
GET_MUST_CHANGE_PASSWORD
The subcommand used to determine whether a user's password has been administratively reset. -
SET_MUST_CHANGE_PASSWORD
The subcommand used to specify whether a user's password has been administratively reset. -
CLEAR_MUST_CHANGE_PASSWORD
The subcommand used to clear whether a user's password has been administratively reset. -
GET_ACCOUNT_IS_PASSWORD_RESET_LOCKED
The subcommand used to determine whether a user's account is reset locked. -
GET_SECONDS_UNTIL_PASSWORD_RESET_LOCKOUT
The subcommand used to determine the length of time in seconds until a user's account is reset locked. -
GET_PASSWORD_RESET_LOCKOUT_TIME
The subcommand used to determine the time a user's account was/will be reset locked. -
GET_LAST_LOGIN_TIME
The subcommand used to retrieve the last login time for a user. -
SET_LAST_LOGIN_TIME
The subcommand used to specify the last login time for a user. -
CLEAR_LAST_LOGIN_TIME
The subcommand used to clear the last login time for a user. -
GET_LAST_LOGIN_IP_ADDRESS
The subcommand used to retrieve the last login IP address for a user. -
SET_LAST_LOGIN_IP_ADDRESS
The subcommand used to specify the last login IP address for a user. -
CLEAR_LAST_LOGIN_IP_ADDRESS
The subcommand used to clear the last login IP address for a user. -
GET_GRACE_LOGIN_USE_TIMES
The subcommand used to retrieve the grace login use times for a user. -
ADD_GRACE_LOGIN_USE_TIME
The subcommand used to add one or more values to the set of grace login use times for a user. -
SET_GRACE_LOGIN_USE_TIMES
The subcommand used to specify the grace login use times for a user. -
CLEAR_GRACE_LOGIN_USE_TIMES
The subcommand used to clear the grace login use times for a user. -
GET_REMAINING_GRACE_LOGIN_COUNT
The subcommand used to retrieve the number of remaining grace logins for a user. -
GET_PASSWORD_CHANGED_BY_REQUIRED_TIME
The subcommand used to retrieve the most recent required password change time with which a user has complied. -
SET_PASSWORD_CHANGED_BY_REQUIRED_TIME
The subcommand used to specify the most recent required password change time with which a user has complied. -
CLEAR_PASSWORD_CHANGED_BY_REQUIRED_TIME
The subcommand used to clear the most recent required password change time with which a user has complied. -
GET_SECONDS_UNTIL_REQUIRED_PASSWORD_CHANGE_TIME
The subcommand used to determine the length of seconds until the required password changed time for a user. -
GET_PASSWORD_HISTORY_COUNT
The subcommand used to retrieve the number of passwords in a user's password history. -
CLEAR_PASSWORD_HISTORY
The subcommand used to clear a user's password history. -
GET_HAS_RETIRED_PASSWORD
The subcommand used to determine whether a user has a retired password. -
GET_PASSWORD_RETIRED_TIME
The subcommand used to retrieve the time that a user's former password was retired. -
GET_RETIRED_PASSWORD_EXPIRATION_TIME
The subcommand used to determine the time that a user's retired password will expire. -
CLEAR_RETIRED_PASSWORD
The subcommand used to purge a user's retired password. -
GET_AVAILABLE_SASL_MECHANISMS
The subcommand used to obtain a list of the SASL mechanisms that are available for a user. This will take into account the server configuration, the user credentials, and the user authentication constraints. -
GET_AVAILABLE_OTP_DELIVERY_MECHANISMS
The subcommand used to obtain a list of the OTP delivery mechanisms that are available for a user. If there is a set of preferred delivery mechanisms for the user, they will be listed first. -
GET_HAS_TOTP_SHARED_SECRET
The subcommand used to determine whether a user account has at least one TOTP shared secret. -
ADD_TOTP_SHARED_SECRET
The subcommand used to add one or more TOTP shared secrets for a user. -
REMOVE_TOTP_SHARED_SECRET
The subcommand used to remove one or more TOTP shared secrets for a user. -
SET_TOTP_SHARED_SECRETS
The subcommand used to replace the TOTP shared secrets for a user. -
CLEAR_TOTP_SHARED_SECRETS
The subcommand used to clear the TOTP shared secrets for a user. -
GET_HAS_REGISTERED_YUBIKEY_PUBLIC_ID
The subcommand used to determine whether a user account has at least one registered YubiKey OTP device public ID. -
GET_REGISTERED_YUBIKEY_PUBLIC_IDS
The subcommand used to retrieve the set of registered YubiKey OTP device public IDs for a user. -
ADD_REGISTERED_YUBIKEY_PUBLIC_ID
The subcommand used to add one or more registered YubiKey OTP device public IDs for a user. -
REMOVE_REGISTERED_YUBIKEY_PUBLIC_ID
The subcommand used to remove one or more registered YubiKey OTP device public IDs for a user. -
SET_REGISTERED_YUBIKEY_PUBLIC_IDS
The subcommand used to replace the set of registered YubiKey OTP device public IDs for a user. -
CLEAR_REGISTERED_YUBIKEY_PUBLIC_IDS
The subcommand used to clear the set of registered YubiKey OTP device public IDs for a user. -
GET_HAS_STATIC_PASSWORD
The subcommand used to determine whether a user account has at least one static password. -
GET_LAST_BIND_PASSWORD_VALIDATION_TIME
The subcommand used to retrieve the time that the server last invoked password validators for a bind operation. -
GET_SECONDS_SINCE_LAST_BIND_PASSWORD_VALIDATION
The subcommand used to retrieve the length of time in seconds since the server last invoked password validators for a bind operation. -
SET_LAST_BIND_PASSWORD_VALIDATION_TIME
The subcommand used to specify the time that the server last invoked password validators for a bind operation. -
CLEAR_LAST_BIND_PASSWORD_VALIDATION_TIME
The subcommand used to clear the time that the server last invoked password validators for a bind operation. -
GET_ACCOUNT_IS_VALIDATION_LOCKED
The subcommand used to determine whether a user account is validation locked. -
SET_ACCOUNT_IS_VALIDATION_LOCKED
The subcommand used to specify whether a user account is validation locked. -
GET_RECENT_LOGIN_HISTORY
The subcommand used to retrieve the recent login history for a user. -
CLEAR_RECENT_LOGIN_HISTORY
The subcommand used to clear the recent login history for a user.
-
-
Method Details
-
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
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 nameNullPointerException- if the argument is null
-
getPrimaryName
Retrieves the primary name for the subcommand.- Returns:
- The primary name for the subcommand.
-
getAlternateNames
Retrieves the alternate names for this subcommand, if any.- Returns:
- The alternate names for this subcommand, or an empty list if there are no alternate names.
-
getAllNames
Retrieves a list containing all names (primary and alternate) for this subcommand.- Returns:
- A list containing all names for ths subcommand.
-
getDescription
Retrieves the description for the subcommand.- Returns:
- The description for the subcommand.
-
getPasswordPolicyStateOperationType
Retrieves the password policy state operation type value that corresponds to this subcommand type.- Returns:
- The password policy state operation type value that corresponds to this subcommand type.
-
forName
Retrieves the subcommand type with the specified name.- Parameters:
name- The name of the subcommand type to retrieve. It must not benull.- Returns:
- The subcommand type with the specified name, or
nullif there is no subcommand type for the given name.
-
forOperationType
Retrieves the subcommand type with the specified password policy state operation type.- Parameters:
opType- The password policy state operation type for the subcommand type to retrieve.- Returns:
- The subcommand type with the specified password policy state
operation type, or
nullif there is no subcommand type for the given operation type.
-