Users

aviowiki has an internal User management system that performs the functions of Authentication and Authorisation, as well as other administrative functions.

API Tokens are issued for and assigned to a specific User, and follow the same Authorisation rules as the User who owns them.

Users are identified internally by their User AID, with namespace USR. For example USR-AA11-22BB.

When creating an account, users are required to provide a login and password .

login should be in the form of an email address.

password doesn't have any specific level of complexity required, however we strongly encourage people to be responsible with their passwords. If you need to have a memorable password (one you can remember without the help of a Password Manager, consider using a passphrase which is easy to remember, but difficult to guess. However the cases in which you really need to use a memorable password are nowadays quite limited. We always recommend to use a Password Manager where possible.

User object

When retrieving information about a user from the API, you will receive a user object which follows the structure shown below:

{
  "aid": "USR-AA11-22BB",
  "name": "Demo User",
  "login": "[e-mail]",
  "password": null,
  "roles": [
    "USER"
  ],
  "reward": 0
}

aid indicates the AID of the user.

name is a plaintext name that the user chose at the time of sign-up.

login the login credential to authenticate the user.

password is always returned null in all responses.

roles is a list of Authorisation roles assigned to the user.

reward is the total count of reward points collected by the user.

For more user actions see: