Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

A newer version of this documentation is available.

View Latest

setting-password-policy

    March 23, 2025
    + 12

    Manage the password policy for new users

    SYNOPSIS

    couchbase-cli setting-password-policy [--cluster <url>] [--username <user>]
    [--password <password>] [--get] [--set] [--min-length <num>]
    [--uppercase <0|1> ] [--lowercase <0|1>] [--digits <0|1>]
    [--special-chars <0|1>]

    DESCRIPTION

    Allows retrieval of the current password policy and creating a new password policy for new Couchbase users. This allows administrators to customize the complexity of user passwords.

    OPTIONS

    -c
    --cluster

    Specifies the hostname of a node in the cluster. See the HOST FORMATS section for more information on specifying a hostname.

    -u
    --username <username>

    Specifies the username of the user executing the command. If you do not have a user account with permission to execute the command then it will fail with an unauthorized error.

    -p
    --password <password>

    Specifies the password of the user executing the command. If you do not have a user account with permission to execute the command then it will fail with an unauthorized error. If this argument is specified, but no password is given then the command will prompt the user for a password through non-echoed stdin. You may also specify your password by using the environment variable CB_REST_PASSWORD.

    --get

    Retrieves the current password policy.

    --set

    Creates a new password policy. Use the flags below to specify different levels of password complexity required for new users and users who change their existing passwords.

    --min-length <num>

    Specifies the minimum password length for new passwords.

    --uppercase <0|1>

    Specifies that new passwords must contain at least one upper case letter.

    --lowercase <0|1>

    Specifies that new passwords must contain at least one lower case letter.

    --digit <0|1>

    Specifies that new passwords must contain at least one digit.

    --special-char <0|1>

    Specifies that new passwords must contain at least one special character.

    HOST FORMATS

    When specifying a host for the couchbase-cli command the following formats are expected:

    • couchbase://<addr>

    • <addr>:<port>

    • http://<addr>:<port>

    It is recommended to use the couchbase://<addr> format for standard installations. The other two formats allow an option to take a port number which is needed for non-default installations where the admin port has been set up on a port other that 8091.

    EXAMPLES

    To get the current password policy run the following command.

    $ couchbase-cli setting-password-policy -c 192.168.1.5 -u Administrator \
 -p password --get

    To set a new password policy where the minimum password length is 10 character and require that all passwords contain an upper case letter, lower case letter, and a digit run the following command.

    $ couchbase-cli setting-password-policy -c 192.168.1.5 -u Administrator \
 -p password --set --min-length 10 --uppercase 1 --lowercase 1 --digits 1

    ENVIRONMENT AND CONFIGURATION VARIABLES

    CB_REST_USERNAME

    Specifies the username to use when executing the command. This environment variable allows you to specify a default argument for the -u/--username argument on the command line.

    CB_REST_PASSWORD

    Specifies the password of the user executing the command. This environment variable allows you to specify a default argument for the -p/--password argument on the command line. It also allows the user to ensure that their password are not cached in their command line history.

    SEE ALSO

    couchbase-cli, user-manage

    COUCHBASE-CLI

    Part of the couchbase-cli suite