Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Users are scoped by application. This means that the user can use multiple applications that use the MILK Books API and not be confused about why they already have an account. Users are identified by email address, and a users email address must be unique per application.

Actions

URLVerbInformation
/userPOSTCreate a new user.

Attributes

The user object is intentionally very light. The MILK Books API does not store user profiles, only the minimum amount of data required to identify and authenticate unique users. More complex profile data storage is the responsibility of the application.

FieldData TypeRequiredAdditional Information
EmailAddressStringYUnique per Application
PasswordStringY(Doesn't have to come from the user - could be randomly generated and stored in the client application for example)
ExternalUserIdString For identifying users in another system - i.e. for customer support

Actions

Create a new user.
URLVerbInformation
/userPOST