Skip to content
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.

Sign up for GitHub

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

Document Google OAuth scopes required #9657

Merged
merged 4 commits into from
Jan 21, 2025
Merged

Document Google OAuth scopes required #9657

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c47c7f4
for docker installs, override SIGN_IN_PREFILLED=false
curiousercreative Jan 15, 2025
35e4f39
Merge branch 'twentyhq:main' into main
curiousercreative Jan 16, 2025
2369125
add documentation of scopes
curiousercreative Jan 16, 2025
670f357
document Microsoft scopes
curiousercreative Jan 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions packages/twenty-website/src/content/developers/self-hosting/setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,12 @@ Under [Credentials](https://console.cloud.google.com/apis/credentials), in OAuth
- `https://<your-domain>/auth/google/redirect` if you want to use Google SSO
- `https://<your-domain>/auth/google-apis/get-access-token`

### Configure scopes
[See relevant source code](https://github.com/twentyhq/twenty/blob/main/packages/twenty-server/src/engine/core-modules/auth/utils/get-google-apis-oauth-scopes.ts#L4-L10)
- 'https://www.googleapis.com/auth/calendar.events'
- 'https://www.googleapis.com/auth/gmail.readonly'
- 'https://www.googleapis.com/auth/profile.emails.read'

### If your app is in test mode

If your app is in test mode, you will need to add test users to your project.
Expand Down Expand Up @@ -96,6 +102,15 @@ You need to add the following redirect URIs to your project:
- `https://<your-domain>/auth/microsoft/redirect` if you want to use Microsoft SSO
- `https://<your-domain>/auth/microsoft-apis/get-access-token`

### Configure scopes
[See relevant source code](https://github.com/twentyhq/twenty/blob/main/packages/twenty-server/src/engine/core-modules/auth/utils/get-microsoft-apis-oauth-scopes.ts#L2-L9)
- 'openid'
- 'email'
- 'profile'
- 'offline_access'
- 'Mail.Read'
- 'Calendars.Read

### If your app is in test mode

If your app is in test mode, you will need to add test users to your project.
Expand Down
Loading