Document Google OAuth scopes required (#9657)

Attempts to resolve #9656
This commit is contained in:
Winston Hoy
2025-01-21 10:09:30 -05:00
committed by GitHub
parent ed7c48e12a
commit e82d4d9f8e

View File

@ -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/redirect` if you want to use Google SSO
- `https://<your-domain>/auth/google-apis/get-access-token` - `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
If your app is in test mode, you will need to add test users to your project. If your app is in test mode, you will need to add test users to your project.
@ -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/redirect` if you want to use Microsoft SSO
- `https://<your-domain>/auth/microsoft-apis/get-access-token` - `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
If your app is in test mode, you will need to add test users to your project. If your app is in test mode, you will need to add test users to your project.