Skip to content
This repository has been archived by the owner on Jul 12, 2023. It is now read-only.

Document users and admin configuration #480

Merged
merged 1 commit into from
Sep 7, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions docs/production.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,35 @@ configurations are available:
| Stackdriver\* | `STACKDRIVER` | Use Stackdriver.


## User administration

There are three types of "users" for the system:

- **System administrator** - global system administrators are the IT
administrators of the system. They can create new realms and edit global
system configuration. System admins, however, do not have permissions to
administer codes or perform realm-specific tasks beyond their creation.
Typically a system administrator creates a realm, adds the initial realm
admin, then removes themselves from the realm. To create a system
administrator, use the `cmd/add-users` tool. There is presently no UI for
adding a system administrator.

- **Realm administrator** - realm administrators control the configuration of
one or more realms. A user may be an administrator of 0 or more realms. If a
user is an administrator of a realm, they have permissions to change
realm-specific settings including the realm name, signing keys, SMS
configuration, etc. To create a realm administrator, check the "Admin" box
in the UI for a new or existing user to promote them to a realm
administrator. Note that realm administration is per-realm; making a user an
admin of "Realm 1" does not make them an admin of "Realm 2".

- **User** - users have the ability to generate and lookup the status of
codes. A user can be a member of multiple realms. To create a user, visit
the realm and click "Add User". If a user is a member of multiple realms (by
email address), they will be prompted to choose a realm after authenticating
to the system.


## Rotating secrets

This section describes how to rotate secrets in the system.
Expand Down