Skip to main content
Database users are the credentials your application uses to connect to a FalkorDB deployment instance. They are separate from the Omnistrate account users who manage subscriptions and instances. To manage the same users from the FalkorDB Cloud console instead, see User Management.
This API is served from a different host than the rest of this reference and uses bearer token authentication instead of a session cookie.

​
Base URL

​
Authentication

Send the JWT issued by Sign in in an Authorization header:
The omnistrate_token cookie is HttpOnly, so browser JavaScript cannot read it. Browser clients should proxy these calls through their own backend, which reads the cookie server-side and forwards it as a bearer token.
Every request also takes a subscriptionId query parameter identifying the subscription that owns the instance.

​
ACL format

Each user has an acl string using the Redis ACL syntax: a set of key patterns followed by the commands the user may run.
  • Key patterns start with ~ (keys) or & (pub/sub channels). ~* grants access to all graphs.
  • Commands are prefixed with +. Subcommands use a pipe, for example +CLIENT|LIST.

​
Presets

The FalkorDB console offers three presets, all scoped to ~*:
No preset grants +ACL, so a database user cannot manage other database users regardless of preset. User management happens through this API or the FalkorDB console.
The API has no preset field — Create database user takes a raw acl string. To reproduce a preset, send its exact string:

​
Allowed commands

Only these commands (and their subcommands) may appear in an ACL:

​
Default user

Every instance is created with a default database user. Its username is available as falkordbUser in the instance result_params. See Describe instance. The default user is managed by the instance, not by this API:
  • It cannot be deleted. Delete database user rejects the request.
  • Its username cannot be changed. falkordbUser is set when the instance is created and is not modifiable afterwards. To use a different username, create an additional database user with Create database user.
  • Its password and ACL can be changed with Update database user. Changing the password through Update instance instead restarts the instance.