UNCLASSIFIED - NO CUI

Update Administrator Guide authored by abhayashrestha's avatar abhayashrestha
...@@ -45,8 +45,8 @@ The API needs the following environmental variables for the setup: ...@@ -45,8 +45,8 @@ The API needs the following environmental variables for the setup:
- `SSO_ENABLED`: determines whether the SSO is enabled or not (can only be one of "true" or "false" as value). - `SSO_ENABLED`: determines whether the SSO is enabled or not (can only be one of "true" or "false" as value).
- `SSO_ADMIN_GROUP`: the SSO group name for admin access. - `SSO_ADMIN_GROUP`: the SSO group name for admin access.
- `SSO_LEADERSHIP_GROUP`: the SSO group name for leadership access. - `SSO_LEADERSHIP_GROUP`: the SSO group name for leadership access.
- `SSO_GROUPS_KEY`: the key found in user token indicating the list of groups a user is part of (this can include `SSO_ADMIN_GROUP`, `SSO_LEADERSHIP_GROUP` values in the list). This list will determine what SSO permissions a user has. - `SSO_GROUPS_KEY`: the key found in user token indicating the list of groups a user is part of (this can include `SSO_ADMIN_GROUP`, `SSO_LEADERSHIP_GROUP` values in the list). This list will determine what SSO permissions a user has. For example, if `SSO_GROUPS_KEY="foo"` and `SSO_ADMIN_GROUP="bar"` is set, then the API will try and check the user token (as a sample token json `{"foo": ["bar"]}`) to determine if user is admin which in this case the user is admin.
- `SSO_USERNAME_KEY`: the key found in user token indicating the user's username. - `SSO_USERNAME_KEY`: the key found in user token indicating the user's username. For example, if the `SSO_USERNAME_KEY="foo"` is set, then the API would get the username by checking the token (as a sample token json `{"foo": "bar"}` for `foo` as key.
- `OPENAPI_VERSION`: the open api version for the app to use. - `OPENAPI_VERSION`: the open api version for the app to use.
- `MODE`: the mode of operation for the app (can be "production" or "development") - `MODE`: the mode of operation for the app (can be "production" or "development")
... ...
......