DEFINE USER statement

Use the DEFINE USER statement to create system users on SurrealDB.

While existing logins still function, the DEFINE LOGIN statement has been replaced with DEFINE USER.

Requirements

• You must be authenticated with a user that has enough permissions. Only the OWNER built-in role grants permissions to create users.
• You must be authenticated with a user that has permissions on the level where you are creating the user:
  • Root users can create Root, Namespace and Database users.
  • Namespace users can create Namespace and Database users
  • Database user can create Database users.
• To select the level where you want to create the user, you may need to select a namespace and/or database before you can use the DEFINE USER statement.

Note: You cannot use the DEFINE USER statement to create a SCOPE user.

Statement syntax

DEFINE USER @name ON [ ROOT | NAMESPACE | DATABASE ] [ PASSWORD @pass | PASSHASH @hash ] ROLES @roles

Example usage

The following example shows how you can create a ROOT user using the DEFINE USER statement.

-- Create the user
DEFINE USER username ON ROOT PASSWORD '123456' ROLES OWNER;

The following example shows how you can create a NAMESPACE user using the DEFINE USER statement.

-- Specify the namespace
USE NS abcum;
-- Create the user
DEFINE USER username ON NAMESPACE PASSWORD '123456' ROLES OWNER;

The following example shows how you can create a DATABASE user using the DEFINE USER statement.

-- Specify the namespace and database for the user
USE NS abcum DB app_vitalsense;
-- Create the user
DEFINE USER username ON DATABASE PASSWORD '123456' ROLES OWNER;

Roles

Currently, only the built-in roles OWNER, EDITOR and VIEWER are available.