Skip to main content
Version: 0.7.4

AUTH

Change global authn/authz settings

LOGIN​

About

Time complexity: O(1)
Accept type:

Return type:

Syntax:

  • AUTH LOGIN <username> <token>

Attempts to log in using the provided credentials

CLAIM​

About

Time complexity: O(1)
Accept type:

Return type:

Syntax:

  • AUTH CLAIM <origin key>

Attempts to claim the root account using the origin key

LOGOUT​

About

Time complexity: O(1)
Accept type:

Return type:

Syntax:

  • AUTH LOGOUT

Attempts to log out the currently logged in user

ADDUSER​

About

Time complexity: O(1)
Accept type:

Return type:

Syntax:

  • AUTH ADDUSER <username>

Attempts to create a new user with the provided username, returning the token

DELUSER​

About

Time complexity: O(1)
Accept type:

Return type:

Syntax:

  • AUTH DELUSER <username>

Attempts to delete the user with the provided username

RESTORE​

About

Time complexity: O(1)
Accept type:

Return type:

Syntax:

  • AUTH RESTORE <username>
  • AUTH RESTORE <origin-key> <username>

Attempts to restore the password for the provided user. This will regenerate the token and return the newly issued token. However, if you aren't a root account, that is, you lost your root password, then you'll need to run AUTH RESTORE <origin-key> root.

LISTUSER​

About

Time complexity: O(1)
Accept type:

Return type:

Syntax:

  • AUTH LISTUSER

Attempts to return a list of users for the current database instance