Skip to content

Instantly share code, notes, and snippets.

@grantlucas

grantlucas/Open Reader User Resources.md

Last active December 17, 2015 13:09
Show Gist options
  • Save grantlucas/5614608 to your computer and use it in GitHub Desktop.
Save grantlucas/5614608 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
Open Reader User Resources.md

Open Reader User Resources

Under Development

This document details user resources for services that support the Open Reader API. User resources cover user management and authentication.

Resource

  • User creation
    • POST user
    • Parameters
      • email
      • password
    • Ability to create users may be restricted depending on the implementation. An open reader service may or may not require added authenticaiton for user creation.
  • Retrieve user token for future authentication on requests
    • POST user/token
    • Returns an auth token to be included in headers of future requests
    • Identifies the user without exposing plain text credentials
  • User information
    • GET user
  • Edit user information
    • PUT user
    • Ability to edit users may be restricted depending on the implementation. An open reader service may or may not require added authenticaiton for user editing.
  • Delete user
    • DELETE user
    • Ability to delete users may be restricted depending on the implementation. An open reader service may or may not require added authenticaiton for user removal.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment