People API Documentation - Version 1

Resources - User (Users)

A user represents a person or entity for the purposes of authentication and authorisation.

Resource model

Name Property Name Data Type Optional Description
ID id Integer No Unique identifier
Username username String No User identifier (must be unique)
E-mail email String Yes -
Password password String No Hashed using Bcrypt
Created At created_at Datetime No -
Updated At created_at Datetime No -

Example (JSON)

{
    "id": 1,
    "username": "conwat",
    "email": "conwat@bas.ac.uk",
    "password": "$2y$10$7eydFcncF6cZ6fSXci1fsOHyDokWPaqkN2kGJkfHbfa/QzWvRoW02",
    "created_at": "2015-01-11 18:35:43.000000",
    "updated_at": "2015-01-11 18:35:43.000000"
}

Resource methods

None.

This information may be out of date whilst this website is being redeveloped. Until then, if you have any problems using an API documented here, please contact the relevant project maintainer.