User Commands

User commands can only be run by a user who has root access except user.whoami.

user.new

user.new creates a new (non-root) server user.

Return Value:

{
    "status": "ok",
    "data": true
}

Example:

user.new "username" "password"

user.all lists all server users (usernames).

Options:

--regex: regular expression string

Return Value:

{
    "status": "ok",
    "data": [
        "user_1",
        ...,
        "user_n"
    ]
}

Example:

user.all
user.all --regex="^ad"

user.about returns information about a user (databases, status, etc...).

Return Value:

{
    "status": "ok",
    "data": {
        "active": true,
        "databases": [],
        "root": false,
        "username": "user1"
    }
}

Example:

user.about "username"

user.delete deletes a user from the server.

Return Value:

{
    "status": "ok",
    "data": true
}

Example:

user.delete "username"

user.passw changes user’s password.

Return Value:

{
    "status": "ok",
    "data": true
}

Example:

user.passw "username" "newpassword"

user.access grants/denies user access to the server.

Return Value:

{
    "status": "ok",
    "data": true
}

Example:

user.access "username" grant
user.access "username" deny

user.db grants/denies user access to a database on the server.

Return Value:

{
    "status": "ok",
    "data": true
}

Example:

user.db "username" "database" grant
user.db "username" "database" deny

user.whoami show current user’s information.

Return Value:

{
    "status": "ok",
    "data": {
        "databases": [],
        "root": false,
        "username": "user1"
    }
}

Example:

user.whoami