Skip to content

Commit

Permalink
Add note about valid users
Browse files Browse the repository at this point in the history
  • Loading branch information
campb303 committed Mar 22, 2021
1 parent b566910 commit 896e360
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion docs/api/Authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,14 @@

The webqueue2 API uses a two stage authentication system combining Active Directory and [HTTP Token](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) (or "bearer") authentication.

All API calls require an access token. You can get an access token by making a POST request to the `/api/login` endpoint containing the JSON encoded username and password.
All API calls require an access token. You can get an access token by making a POST request to the `/api/login` endpoint containing the JSON encoded username and password of a valid user.

??? info "Who is a valid user?"
A valid user is a non-admin BoilerAD user who is in the `00000227-ECN-webqueue` group. Users cannot be added directly to this group. To be included in this group, a user must exist in one of the following groups:

- `00000227-ECNStaff`
- `00000227-ECNStuds`
- `00000227-ECN-webqueue-misc`

=== "fetch"
```javascript
Expand Down

0 comments on commit 896e360

Please sign in to comment.