Thanks to visit codestin.com
Credit goes to github.com

Skip to content

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

Merged
merged 9 commits into from
Oct 2, 2023
Merged

OAuth 2.0 [DOC-735] #5422

merged 9 commits into from
Oct 2, 2023

Conversation

stayseesong
Copy link
Contributor

Proposed changes

Merge timing

Related issues (optional)

@stayseesong stayseesong requested a review from a team as a code owner September 26, 2023 18:29
@stayseesong stayseesong requested review from rchinn1 and removed request for a team September 26, 2023 18:29
@stayseesong stayseesong marked this pull request as draft September 26, 2023 18:29
@netlify
Copy link

netlify bot commented Sep 26, 2023

Deploy Preview for segment-docs ready!

Name Link
🔨 Latest commit 4185c9a
🔍 Latest deploy log https://app.netlify.com/sites/segment-docs/deploys/651b058b977fb30008890a3c
😎 Deploy Preview https://deploy-preview-5422--segment-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@stayseesong stayseesong changed the title OAuth 2.0 [DOC-737] OAuth 2.0 [DOC-735] Sep 26, 2023
@stayseesong stayseesong requested a review from vy-ton September 27, 2023 00:09
@vy-ton
Copy link

vy-ton commented Sep 27, 2023

@stayseesong I plan to review by Wednesday EOD.

@stangeorge @anandtwilio Might be good to have a few Eng reviewers for these docs as well?

Copy link

@vy-ton vy-ton left a 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
Copy link

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
Copy link

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'
Copy link

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

@vy-ton
Copy link

vy-ton commented Oct 2, 2023

@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

@stayseesong stayseesong marked this pull request as ready for review October 2, 2023 20:19
Copy link
Contributor

@rchinn1 rchinn1 left a 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

@stayseesong stayseesong changed the base branch from develop to master October 2, 2023 21:07
@stayseesong stayseesong merged commit af326db into master Oct 2, 2023
@stayseesong stayseesong deleted the DOC-735 branch October 2, 2023 21:09
@forstisabella forstisabella mentioned this pull request Jun 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants