-
Notifications
You must be signed in to change notification settings - Fork 363
OAuth 2.0 [DOC-735] #5422
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
OAuth 2.0 [DOC-735] #5422
Conversation
✅ Deploy Preview for segment-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
@stayseesong I plan to review by Wednesday EOD. @stangeorge @anandtwilio Might be good to have a few Eng reviewers for these docs as well? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Initial review
@@ -0,0 +1,132 @@ | |||
--- | |||
title: OAuth 2.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should add a Migration guide
section.
@stangeorge @aklish Is there a list of steps for the migration happy path?
> info "" | ||
> This feature is currently in pilot. For pilot, Segment doesn’t support OAuth for Web and Mobile sources where an end-user is involved. OAuth 2.0 only supports server to Segment communication, a machine-to-machine workflow. | ||
|
||
## Permissions |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion: add a Glossary section to define OAuth app, scope
To request the access token, run: | ||
|
||
``` | ||
./gentoken.sh -k <private-key.pem> -i <key_id> -a <oauth_app_id> | jq '.access_token' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@stangeorge @srikanth-mohan This is where we should link to the publicly accessible API docs for the token endpoint. I believe we agreed that we didnt want to expose gentoken.sh
since its an internal manual script
@stangeorge @anandtwilio Stacy is going to merge the first draft as is. But let's prioritize some iterations to keep adding details like token endpoint API docs and a migration guide to help users onboard |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few suggestions to address, but overall looks good to me
Co-authored-by: rchinn-segment <[email protected]>
Proposed changes
Merge timing
Related issues (optional)