Skip to content

Commit

Permalink
[api] add information on how to assign admin users
Browse files Browse the repository at this point in the history
  • Loading branch information
jbygdell committed Aug 13, 2024
1 parent 80e5277 commit 352b542
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions sda/cmd/api/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,3 +118,17 @@ Admin endpoints are only available to a set of whitelisted users specified in th
- `200` Query execute ok.
- `401` Token user is not in the list of admins.
- `500` Internal error due to DB failure.

#### Configure Admin users

The users that should have administrative access can be set in two ways:

- As a comma separated list of user identifiers asigned to: `admin.users`.
- As a JSON file containg a list of the user identities, the path to the file is assigned to: `admin.configFile`. This is the recommended way.

```json
[
"[email protected]"
"[email protected]"
]
```

0 comments on commit 352b542

Please sign in to comment.