-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(authentication): document user administration
- Loading branch information
1 parent
ec8b835
commit fe14f64
Showing
2 changed files
with
25 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
title: User administration | ||
description: How to manage (technical and non-technical) users | ||
--- | ||
|
||
User accounts are managed by [Keycloak](https://www.keycloak.org/) which offers a web interface for managing users. It can be used to manage both technical and non-technical users. | ||
|
||
## Accessing the Keycloak admin console | ||
|
||
TODO: Describe how to find the admin console. | ||
|
||
TODO: How to get the initial admin credentials. | ||
|
||
The Loculus-specific users are stored in the `loculus` realm which can be selected in the selection box in the left navigation bar. | ||
|
||
## Superusers/curators | ||
|
||
Superusers have the privilege to submit, revise, revoke and approve sequences on behalf of other groups. This role is envisioned to be assigned to curators. | ||
|
||
To grant superuser privileges to a user, click on "Users" in the left navigation bar, select the user, click on "Role Mappings" and assign the `super_user` role. | ||
|
||
## Processing pipeline | ||
|
||
The processing pipeline requires a technical user to authenticate with the Loculus API. To create a new technical user, you can use the usual user registration form on the website. Afterwards, go to the Keycloak admin console, click on "Users" in the left navigation bar, select the user, click on "Role Mappings" and assign the `preprocessing_pipeline` role. |