Generate and deliver a single-use token to a user through some out-of-band mechanism. The user can provide that token to the password modify extended request in lieu of the user's current password in order to select a new password.
deliver-password-reset-token --hostname server.example.com --port 389 \ --bindDN uid=password.admin,ou=People,dc=example,dc=com \ --bindPassword password --userDN uid=test.user,ou=People,dc=example,dc=com \ --deliveryMechanism SMS --deliveryMechanism E-Mail \ --messageSubject "Your password reset token" \ --fullTextBeforeToken "Your single-use password reset token is '" \ --fullTextAfterToken "'." \ --compactTextBeforeToken "Your single-use password reset token is '" \ --compactTextAfterToken "'."
-V
--version
Description | Display Directory Server version information |
-H
--help
Description | Display general usage information |
--help-ldap
Description | Display help for using LDAP options |
--help-sasl
Description | Display help for using SASL options |
--help-debug
Description | Display help for using debug options |
Advanced | Yes |
-h {host}
--hostname {host}
Description | The IP address or resolvable name to use to connect to the directory server. If this is not provided, then a default value of 'localhost' will be used. |
Default Value | localhost |
Required | Yes |
Multi-Valued | No |
-p {port}
--port {port}
Description | The port to use to connect to the directory server. If this is not provided, then a default value of 389 will be used. |
Default Value | 389 |
Required | Yes |
Multi-Valued | No |
-D {dn}
--bindDN {dn}
Description | The DN to use to bind to the directory server when performing simple authentication. |
Required | No |
Multi-Valued | No |
-w {password}
--bindPassword {password}
Description | The password to use to bind to the directory server when performing simple authentication or a password-based SASL mechanism. |
Required | No |
Multi-Valued | No |
-j {path}
--bindPasswordFile {path}
Description | The path to the file containing the password to use to bind to the directory server when performing simple authentication or a password-based SASL mechanism. |
Required | No |
Multi-Valued | No |
--promptForBindPassword
Description | Indicates that the tool should interactively prompt the user for the bind password. |
-Z
--useSSL
Description | Use SSL when communicating with the directory server. |
-q
--useStartTLS
Description | Use StartTLS when communicating with the directory server. |
-X
--trustAll
Description | Trust any certificate presented by the directory server. |
-K {path}
--keyStorePath {path}
Description | The path to the file to use as the key store for obtaining client certificates when communicating securely with the directory server. |
Required | No |
Multi-Valued | No |
-W {password}
--keyStorePassword {password}
Description | The password to use to access the key store contents. |
Required | No |
Multi-Valued | No |
-u {path}
--keyStorePasswordFile {path}
Description | The path to the file containing the password to use to access the key store contents. |
Required | No |
Multi-Valued | No |
--promptForKeyStorePassword
Description | Indicates that the tool should interactively prompt the user for the password to use to access the key store contents. |
--keyStoreFormat {format}
Description | The format (e.g., jks, jceks, pkcs12, etc.) for the key store file. |
Required | No |
Multi-Valued | No |
-P {path}
--trustStorePath {path}
Description | The path to the file to use as trust store when determining whether to trust a certificate presented by the directory server. |
Required | No |
Multi-Valued | No |
-T {password}
--trustStorePassword {password}
Description | The password to use to access the trust store contents. |
Required | No |
Multi-Valued | No |
-U {path}
--trustStorePasswordFile {path}
Description | The path to the file containing the password to use to access the trust store contents. |
Required | No |
Multi-Valued | No |
--promptForTrustStorePassword
Description | Indicates that the tool should interactively prompt the user for the password to use to access the trust store contents. |
--trustStoreFormat {format}
Description | The format (e.g., jks, jceks, pkcs12, etc.) for the trust store file. |
Required | No |
Multi-Valued | No |
-N {nickname}
--certNickname {nickname}
Description | The nickname (alias) of the client certificate in the key store to present to the directory server for SSL client authentication. |
Required | No |
Multi-Valued | No |
--enableSSLDebugging
Description | Enable Java's low-level support for debugging SSL/TLS communication. This is equivalent to setting the "javax.net.debug" property to "all". |
-o {name=value}
--saslOption {name=value}
Description | A name-value pair providing information to use when performing SASL authentication. |
Required | No |
Multi-Valued | Yes |
--useSASLExternal
Description | Use the SASL EXTERNAL mechanism to authenticate. |
--helpSASL
Description | Provide information about the supported SASL mechanisms, including the properties available for use with each. |
-b {dn}
--userDN {dn}
Description | The DN of the user to whom the generated password reset token should be delivered. |
Required | Yes |
Multi-Valued | No |
-m {name}
--deliveryMechanism {name}
Description | The name of the mechanism that should be used to deliver the password reset token to the user. If multiple values are specified (using multiple instances of this argument) then they will bbe tried in the order in which they are given until one of them is able to deliver the token. If this is not specified, then the server configuration will dictate which delivery mechanisms should be attempted. |
Required | No |
Multi-Valued | Yes |
-s {subject}
--messageSubject {subject}
Description | The subject to use for the message containing the password reset token. This will be ignored for delivery mechanisms that do not require a subject. |
Required | No |
Multi-Valued | No |
-f {text}
--fullTextBeforeToken {text}
Description | The text to include immediately before the password reset token in the message delivered to the end user via a mechanism that does not impose a significant constraint on message size. |
Required | No |
Multi-Valued | No |
-F {text}
--fullTextAfterToken {text}
Description | The text to include immediately after the password reset token in the message delivered to the end user via a mechanism that does not impose a significant constraint on message size. |
Required | No |
Multi-Valued | No |
-c {text}
--compactTextBeforeToken {text}
Description | The text to include immediately before the password reset token in the message delivered to the end user via a mechanism that imposes a significant constraint on message size. |
Required | No |
Multi-Valued | No |
-C {text}
--compactTextAfterToken {text}
Description | The text to include immediately after the password reset token in the message delivered to the end user via a mechanism that imposes a significant constraint on message size. |
Required | No |
Multi-Valued | No |
--interactive
Description | Launch the tool in interactive mode. |
--outputFile {path}
Description | Write all standard output and standard error messages to the specified file instead of to the console. |
Required | No |
Multi-Valued | No |
--appendToOutputFile
Description | Indicates that the tool should append to the file specified by the --outputFile argument if it already exists. If this argument is not provided and the output file already exists, it will be overwritten. |
--teeOutput
Description | Write all standard output and standard error messages to the console as well as to the specified output file. The --outputFile argument must also be provided. |
--propertiesFilePath {path}
Description | The path to a properties file used to specify default values for arguments not supplied on the command line. |
Required | No |
Multi-Valued | No |
--generatePropertiesFile {path}
Description | Write an empty properties file that may be used to specify default values for arguments. |
Required | No |
Multi-Valued | No |
--noPropertiesFile
Description | Do not obtain any argument values from a properties file. |
--suppressPropertiesFileComment
Description | Suppress output listing the arguments obtained from a properties file. |