User

API


    POST /api/user
    GET /api/user
    PUT /api/user/<key>
    DELETE /api/user/<key>
    GET /api/user/<key>

CLI


    configure user <key>
    show user <key>

Data

User

uuid

Type
string
Category
required
Description

username

Type
string
Category
optional
Description

password

Type
string
Category
optional
Description

name

Type
string
Category
required
Description

email

Type
string
Category
optional
Description

access

Type
UserRole
Category
repeated
Description

is_superuser

Type
bool
Category
optional
Description
Default
False

last_login_ip

Type
string
Category
optional
Description

last_login_timestamp

Type
string
Category
optional
Description

logged_in

Type
bool
Category
optional
Description

local

Type
bool
Category
optional
Description

full_name

Type
string
Category
optional
Description

default_tenant_uuid

Type
Reference to Tenant
Category
optional
Description

UserRole

role_uuid

Type
Reference to Role
Category
required
Description

tenant_uuid

Type
Reference to Tenant
Category
optional
Description

all_tenants

Type
bool
Category
optional
Description
Default
False

References

UserRole Tenant Role

Password Management

View/Change Current Account

Description

All users have limited access to their own account information. Any user can change their own full_name, email, and password.

API


    GET /api/useraccount
    PUT /api/useraccount

CLI


    passwd

Examples


PUT /api/useraccount
{
    "old_password": "oldpassword",
    "password": "newpassword",
    "full_name": "fullname",
    "email": "example@email.com"
}

Forgot Password?

Description

If a user forgets the password to their account, the password can be reset. An email will be sent to the user, and the password can be reset by following the instructions in the email.

Examples


POST /api/passwordchangerequest
{
    "email": "example@email.com"
}


Sample Email:
Hi user,

You recently requested a password reset.

Please set a new password by following the link below:

<link>

This link will be valid for the next 24 hours.

Please disregard this e-mail if you did not request a password reset.

Thanks,

- Administrator