Document auth design

Description

There are two main parts to this ticket:

  1. Document how the auth service works in general and how to use it

  2. Document auth design with service-level (root access) tokens and user-level (user-based access) tokens ()

We should put something in the README in the auth service. For something more detailed, we might need to create a wiki doc.

QAlity Plus - Test Management

Checklists

Activity

Show:

Chongsun AhnJanuary 20, 2017 at 10:58 PM

Copied it over to https://github.com/OpenLMIS/openlmis-auth/blob/master/DESIGN.md, with a link from the README. Had to put in the formatting manually.

Brandon Bowersox-JohnsonJanuary 20, 2017 at 9:20 PM

Okay, I'm done with all my revisions. Please give it a quick read to make sure it is factually correct: https://openlmis.atlassian.net/wiki/display/OP/Auth+Design

I suggest we leave this in the Wiki for now. We have a lot of documentation in the Wiki that should move to ReadTheDocs eventually, but we don't yet have any structure or organization for that. I hope to work on that before our 3.0 release, but I don't think it should hold up this ticket (let me know if you disagree).

Chongsun AhnJanuary 19, 2017 at 7:13 PM

Chongsun AhnJanuary 19, 2017 at 6:33 PM

If you can determine that it can be moved to something like ReadTheDocs now, then let's move it. But if we'll need to make significant changes first, let's make the changes and then move it over.

Done
Pinned fields
Click on the next to a field label to start pinning.

Details

Assignee

Reporter

Story Points

Components

Sprint

Fix versions

Priority

Time Assistant

Created December 16, 2016 at 11:31 PM
Updated January 20, 2017 at 10:58 PM
Resolved January 20, 2017 at 10:58 PM