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.

CREATE USER

  • reference
  • Couchbase Server 8.0
    +
    The CREATE USER statement enables you to create a user.

    Purpose

    Creating a user is an essential step in managing access to your Couchbase environment. You can use the CREATE USER statement to define a new local user in the Couchbase Server Role-Based Access Control (RBAC) system. By default, Couchbase Server assigns the user to the local authentication domain.

    When you create a user, you can specify their basic attributes such as username, password, full name, and assign them to one or more groups. If you do not specify a group, the user is not assigned to any group by default.

    RBAC Privileges

    To execute the CREATE USER statement, you must have either the Full Admin or the Security Admin role. For more information about user roles, see Authorization.

    Syntax

    create-user ::= 'CREATE' 'USER' ( 'IF' 'NOT' 'EXISTS' )? username 'PASSWORD' password 
                ( 'WITH' name )? 
                ( 'GROUP' group | 'GROUPS' group ( ',' group )* | 'NO' 'GROUPS' )?
    Syntax diagram: refer to source code listing
    username

    (Required) The unique identifier for the new local user.
    password

    (Required) A quoted string containing the user’s password. It must be at least 6 characters long.
    name

    (Optional) A quoted string containing the user’s full name.
    group

    (Optional) The group you want to assign the user to.

    When creating a user, you can assign them to groups using one of the following options: GROUP, GROUPS, or NO GROUPS. You can specify only one of these options per statement.

    • GROUP assigns the user to a single group.

    • GROUPS assigns the user to multiple groups (the names must be separated by commas).

    • NO GROUPS creates a user without assigning any groups. This option has no effect during user creation.

    IF NOT EXISTS Clause

    The optional IF NOT EXISTS clause enables the statement to complete successfully when the specified user already exists. If a user with the same username already exists, then:

    • If this clause is not present, an error is generated.

    • If this clause is present, the statement does nothing and completes without error.

    Examples

    Example 1. Create a user and specify their full name and password
    CREATE USER Hilary PASSWORD "password123" WITH "Hilary Smith";
    Example 2. Create a user and assign them to a single group
    CREATE USER Alice PASSWORD "password123" GROUP agents;
    Example 3. Create a user and assign them to multiple groups
    CREATE USER Bob PASSWORD "P@ssw0rd" GROUPS agents, tourguides, support;
    Example 4. Create a user with no group assignments
    CREATE USER Charlie PASSWORD "securePass" NO GROUPS;
    Example 5. Create a user if they do not already exist
    CREATE USER IF NOT EXISTS David PASSWORD "davidPass" WITH "David Trantow";