User REST API

This API is used to manage the user lifecycle. It allows us to:

• Retrieve both a list of registered users, or a single user
• Register a user
• Update user information
• Delete a user

URL

/users

Methods

GET | POST | DELETE | PUT

URL Parameters

URL	Method	Description
/users/	GET	Retrieves ALL users from the database
/users/	POST	Adds a user to the database
/users/[id]	GET	Retrieves a single user from the database
/users/[id]	PUT	Updates an existing users details
/users/[id]	DELETE	Deletes an existing user from the database

Required

id=[integer]

Data Parameters

Key	Data Type	Description
username	String	The users username
email	String	Email address of the user

More to come!

Success Response

<What should the status code be on success and is there any returned data? This is useful when people need to know what their callbacks should expect!>

• Code: 200 OK

  Content:

{
  "url": "http://127.0.0.1:8000/users/1/",
  "username": "foo",
  "email": "foo@bar.com",
  "groups": []`
}

More to come

Error Response

• Code: 403 FORBIDDEN

  Content: { detail: "Authentication credentials were not provided." }

OR

• Code: 400 BAD REQUEST

  Content: { "username": ["A user with that username already exists."] }

OR

• Code: 400 BAD REQUEST

  Content: { "username": ["This field may not be blank."] }

Sample Call

Still to do

Notes

• Still to do:
  • Need to work out how to make sure it checks that no duplicate emails are added
  • Need to make email required field
  • Need to update fields when I know what all of them are
  • Update markdown to include any user creation into a default group, so they only have certain privileges