Skip to content

Commit

Permalink
docs(username): add bg note on auth mapping
Browse files Browse the repository at this point in the history
  • Loading branch information
vpsx committed Nov 13, 2019
1 parent 4a7130c commit 1d57461
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/username.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

This document describes how Arborist should behave when the user is or is not known to Arborist.

(Note: As of 2019-Nov-13 this is not yet how Arborist _actually_ behaves.)

## Context

Arborist always has 2 default groups:
Expand Down Expand Up @@ -29,6 +31,8 @@ These endpoints return everything the user has access to, including anonymous an
- Username is specified but it is not in Arborist's database: return anonymous and logged-in policies.
- No username can be found: return the anonymous policies.

>Background: Originally `auth/mapping` only took the username from a query parameter. Then the revproxy needed to expose the endpoint so that Windmill could hit it. But we couldn't allow users to hit `auth/mapping` with arbitrary usernames. So the revproxy does not forward any query parameters, and we added the JWT fallback in Arborist.
## GET user/{username} and GET user/{username}/... endpoints

These endpoints have the username as a mandatory query parameter.
Expand Down

0 comments on commit 1d57461

Please sign in to comment.