Authentication User Account
Description
Instructions
To make this work you will have to create a Google Cloud project. This project forms the basis for creating, enabling, and using all Google Cloud services, including managing APIs, enabling billing, adding and removing collaborators, and managing permissions.
- Go to the Google Cloud Console
- In the Google Cloud console, go to menu IAM & Admin, and then Create a Project.
- Enter the name of the new project into the Project Name field and select the appropriate organization, then click Create.
- The console navigates to the Dashboard page and your project is created within a few minutes.
- In the Google Cloud console, go to menu More products, Google Workspace, and then Product Library.
- Now we need to enable the Gmail API.
- Search for Gmail API. Select it and then click ENABLE.
- Select the Credentials tab on the left side of the screen.
- Select the + CREATE CREDENTIALS link to reveal a drop down menu.
- In the dropdown menu, select OAuth client ID.
- If presented, click the CONFIGURE CONSENT SCREEN button and then elect the appropriate User Type based on your business needs. Otherwise, continue to step 16.
- In the OAuth consent screen tab fill in your app's website and domain information, and then click SAVE AND CONTINUE.
- In the Scopes section of the app registration, click ADD OR REMOVE SCOPES and add the following scopes:
- openid
- https://mail.google.com/
- https://www.googleapis.com/auth/userinfo.email
- https://www.googleapis.com/auth/userinfo.profile
- https://www.googleapis.com/auth/gmail.labels
- https://www.googleapis.com/auth/gmail.send
- https://www.googleapis.com/auth/gmail.modify
- https://www.googleapis.com/auth/gmail.compose
- https://www.googleapis.com/auth/gmail.readonly
- After the scopes have been added, click SAVE AND CONTINUE.
- Complete the wizard setting up scopes.
- Select the Credentials tab on the left side of the screen.
- Select the + CREATE CREDENTIALS link to reveal a drop down menu.
- In the dropdown menu, select OAuth client ID.
- In the Application type drop down, select Desktop application and then give your app client a name.
- Select the CREATE button.
- A popup window will appear that provides important information you should record for your records:
- Client ID
- Client secret
- Go to OAuth Consent Screen tab. Under Publishing Status click PUBLISH APP to ensure your refresh token doesnt expire often. If you planning to use App for Private use then do not have to worry about Verification Status after Publish.
- Back to Connection UI, Enter the client ID and client secret into the required parameters.
Parameters
| Parameter | Required | Default value | Options | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
Name:
Label: UseCustomApp Use your own app credentials or inbuilt app provided by ZappySys for ease of use. If you choose UseCustomApp=true then make sure to obtain your own ClientId and Secret using steps provided (Click [Steps to Configure] link found next to Authentication Type dropdown) |
YES |
True
|
|||||||||
|
Name:
Label: Authorization URL |
YES |
https://accounts.google.com/o/oauth2/auth
|
|||||||||
|
Name:
Label: Token URL |
YES |
https://oauth2.googleapis.com/token
|
|||||||||
|
Name:
Label: Default API Version Enter default API version which should be used by this connector. |
YES |
v1
|
|||||||||
|
Name:
Label: Default User Id Enter default User Id which should be used by this connector. |
YES |
me
|
|
||||||||
|
Name:
Label: Scope |
YES |
https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/userinfo.profile openid https://www.googleapis.com/auth/gmail.labels https://www.googleapis.com/auth/gmail.send https://mail.google.com/ https://www.googleapis.com/auth/gmail.modify https://www.googleapis.com/auth/gmail.compose https://www.googleapis.com/auth/gmail.readonly
|
|||||||||
|
Name:
Label: Client Id |
YES, if UseCustomApp, otherwise NO
|
||||||||||
|
Name:
Label: Client Secret |
YES, if UseCustomApp, otherwise NO
|
||||||||||
|
Name:
Label: RetryMode |
RetryWhenStatusCodeMatch
|
|
|||||||||
|
Name:
Label: RetryStatusCodeList |
429
|
||||||||||
|
Name:
Label: RetryCountMax |
5
|
||||||||||
|
Name:
Label: RetryMultiplyWaitTime |
True
|
||||||||||
|
Name:
Label: Redirect URL (Only for Web App) Only specifiy this if you have created Credential as Web Application rather than Desktop. In Desktop App you dont have to supply Return URL (its always localhost). When you keep this blank it uses default value http://localhost:[some_random_port_each_time] for redirect_url) |
|