generated from CDCgov/template
-
Notifications
You must be signed in to change notification settings - Fork 40
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Develop documentation for Okta (#15995)
* Develop documentation for Okta Fixes #13868
- Loading branch information
1 parent
84a5114
commit 0ef03ff
Showing
4 changed files
with
56 additions
and
4 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Okta-side configuration | ||
|
||
Our frontend is configured to identify as the "Web" application. | ||
|
||
## Dev-side configuration | ||
|
||
Our use of okta in frontend is configured by the following environment variables whose values can be found in the application listing within Okta: | ||
-VITE_OKTA_CLIENTID | ||
-VITE_OKTA_URL | ||
|
||
These variables can be assigned locally for local development (.env.*.local) or by github actions (using values in secrets storage either in github itself or azure). | ||
|
||
We use Okta's [Embedded Sign-In Widget for React](https://developer.okta.com/docs/guides/sign-in-to-spa-embedded-widget/react/main/), which includes other Okta-related libraries for react, to handle okta workflows. |
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,39 @@ | ||
# Admin Management | ||
|
||
More details about the organization within okta can be found in [this doc](https://cdc.sharepoint.com/:p:/r/teams/ReportStream/_layouts/15/Doc.aspx?sourcedoc=%7B313111b2-502c-4f60-ac8c-bbcf3c9b1dab%7D&action=edit&wdPreviousSession=a28aeb1e-02b3-b6be-49ab-cafb30120e6f) | ||
|
||
Okta admin potential responsibility areas are: | ||
- App registry management | ||
- User/group management | ||
- Security configuration management | ||
- Log checking | ||
|
||
ReportStream's Okta has the following specialized admin roles for team members: | ||
- Owners | ||
- Support Team | ||
- Onboarding Engineers | ||
- Front-end Engineers | ||
- Tech Leads | ||
|
||
|
||
## App registry management | ||
|
||
The app registry page can be found by the following side-navigation: Applications > Applications. | ||
|
||
All reportstream-developed programs with authentication elements should be configured towards an application listed on this page. | ||
|
||
|
||
## User/Group management | ||
|
||
Accessible via the side-navigation: Directory > People or Directory > Groups | ||
|
||
## Security configuration management | ||
|
||
The policies are enforced in the following order (accessed through "Security" in side-navigation): | ||
- Global Session Policy | ||
- Authentication Policy | ||
- Password Policy (from side-navigation: Security > Authenticators > Click Actions for the "Password" table line > Edit) | ||
|
||
## Log checking | ||
|
||
The global log can be accessed from side-navigation: Reports > System Log. They can also be filtered by user by going to the user's management page (side-navigation: Directory > People) and clicking "View Logs". |
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