As an onboarding engineer on ReportStream,
I want documentation on the new machine-machine Auth and how to onboard a new Sender,
So that I can manage Sender connections properly.
Description/Use Case
With the implementation of the new Auth Service API, the following documentation will need to be created/updated:
prime-router/docs/design/features/0002-authentication.md (rename to something like legacy-custom-rs-auth. Since this auth will be supported alongside the new auth, until migration is complete, we should keep the documentation in the repo around). We don't need one of these docs for the new auth since we have the SRD.
prime-router/examples/generate-jwt-python - update README to indicate this is used for the legacy custom RS auth and the feature is considered deprecated. This will be deleted once all senders are migrated to new auth.
Create a new folder inprime-router/examples that contains a sample python script showing how to connect to Okta token api to get bearer token. Include instructions and details in a README alongside the script.
Create a SOP in ReportStream sharepoint that details:
How to onboard a sender to RS using new auth service API
How to manage senders and their machines in Okta
How to manage the Authorization server in Okta
Double check if any other docs should be updated
Contact Audrey Ross to indicate changes are needed to the onboarding instructions on the website and offer meeting to discuss and demo the internal documentation above
User Story
As an onboarding engineer on ReportStream, I want documentation on the new machine-machine Auth and how to onboard a new Sender, So that I can manage Sender connections properly.
Description/Use Case
With the implementation of the new Auth Service API, the following documentation will need to be created/updated:
prime-router/docs/design/features/0002-authentication.md
(rename to something likelegacy-custom-rs-auth
. Since this auth will be supported alongside the new auth, until migration is complete, we should keep the documentation in the repo around). We don't need one of these docs for the new auth since we have the SRD.prime-router/examples/generate-jwt-python
- update README to indicate this is used for the legacy custom RS auth and the feature is considered deprecated. This will be deleted once all senders are migrated to new auth.prime-router/examples
that contains a sample python script showing how to connect to Okta token api to get bearer token. Include instructions and details in a README alongside the script.sharepoint
that details:Risks/Impacts/Considerations
Dev Notes
Acceptance Criteria