Accounts

Accounts (user-accounts) represents a person. Accounts grants access to management-level applications in Tirix.

Security

As a security measure access to this node is restricted.

WARNING

You can only view and modify your account, or if your account has privileges, accounts linked to your tenant.

TIP

You can directly access your account using the edge /accounts/me.

Schema

Schema: Account

Property	Type	Description
id	ObjectId	Unique identifier
name	String	Name of account holder
email	String	Email of account holder
password	String	Password, stored encrypted on the server and is not included in requests
tenant	ObjectId	Linked tenant
roles	Array	Array of roles the account has

Get a list of accounts

If you want to retrieve a list of accounts, use this GET request:

GET https://api.tirix.io/accounts

Get an account

If you want to fetch an individual account, use this GET request:

GET https://api.tirix.io/accounts/{account_id}

Create a new account

If you want to create a new account, use this POST request:

POST https://api.tirix.io/accounts

Modify an account

If you want to modify a specific warehouse site, use this PUT request:

PUT https://api.tirix.io/accounts/{account_id}

Delete an account

If you want to remove a specific account, use this DELETE request:

DELETE https://api.tirix.io/accounts/{account_id}

WARNING

Due to data-constraints, accounts can not be physically removed. This command will irreversibly anonymize any account information and flag the account as removed.

Methods

Password reset

If you want to initiate a password reset for an individual account, use this POST request:

GET https://api.tirix.io/accounts/reset

This will send an email to the account email with password reset instructions.

Parameters

Key	Mandatory	Type	Description
email	Optional	String	Account email
id	Optional	ObjectId	Account id

WARNING

Either email or id must be present.

Commit a password reset

If you want to commit a password reset for an individual account, use this POST request:

GET https://api.tirix.io/accounts/reset/commit

You will need a valid password reset token aquired through the Password reset email and provide a new password.

Parameters

Key	Mandatory	Type	Description
token	Mandatory	String	Password reset token
password	Mandatory	String	The new password