{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-agen-for-work/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["Notification","LightboxImage"]},"type":"markdown"},"seo":{"title":"Gmail integration","siteUrl":"https://developers.frontegg.com/","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"gmail-integration","__idx":0},"children":["Gmail integration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Integrating Gmail with Frontegg allows your application to read, send, and manage email messages, threads, labels, and drafts in users' Gmail mailboxes — all through Frontegg's integration layer using Google OAuth 2.0."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Notification","attributes":{"title":"Prerequisites","type":"attention"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A Google account with access to ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://console.cloud.google.com/"},"children":["Google Cloud Console"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A Google Cloud project (you can create one during setup)"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"enable-the-gmail-api","__idx":1},"children":["Enable the Gmail API"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"step-1-open-the-gmail-api-in-the-api-library","__idx":2},"children":["Step 1: Open the Gmail API in the API library"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Go to the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://console.cloud.google.com/apis/library/gmail.googleapis.com"},"children":["Gmail API"]}," page in the Google Cloud Console. Select your project from the top navigation, then click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Enable"]}," if the API is not yet enabled. If you see ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Manage"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Enabled"]},", the API is already active."]},{"$$mdtype":"Tag","name":"LightboxImage","attributes":{"isLightbox":true},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/gmail-1.0c233b105ca4ae251b7eaf5f02080ca62cd4f9fc530c248436a2e676f8451cb6.1ce25488.png","alt":"Gmail API page in Google Cloud Console"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-an-oauth-client","__idx":3},"children":["Create an OAuth client"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"step-2-go-to-the-credentials-page","__idx":4},"children":["Step 2: Go to the Credentials page"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the left sidebar, navigate to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["APIs & Services"]}," → ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Credentials"]},". Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create credentials"]},"."]},{"$$mdtype":"Tag","name":"LightboxImage","attributes":{"isLightbox":true},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/gmail-2.494add4d3662f0393fba52c305cc8aefc0a6566b9b716f8ffbf0ba38ded38ef6.1ce25488.png","alt":"Credentials page with Create credentials button highlighted"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"step-3-select-oauth-client-id","__idx":5},"children":["Step 3: Select OAuth client ID"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["From the dropdown, select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["OAuth client ID"]},"."]},{"$$mdtype":"Tag","name":"LightboxImage","attributes":{"isLightbox":true},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/gmail-3.e7731f75c94ed10ca67d3187983fbb9ae61ffbad1bbb57c21165c682a29e4924.1ce25488.png","alt":"Create credentials dropdown with OAuth client ID highlighted"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"step-4-configure-the-oauth-client","__idx":6},"children":["Step 4: Configure the OAuth client"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["On the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create OAuth client ID"]}," page:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Set ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Application type"]}," to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Web application"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Enter a name for the client (for example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Frontegg Gmail Integration"]},")."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Under ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Authorized redirect URIs"]},", click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Add URI"]}," and add both of the following:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://YOUR_MCP_GATEWAY_URL/integration-callback"]}]}]}]}]},{"$$mdtype":"Tag","name":"LightboxImage","attributes":{"isLightbox":true},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/gmail-4.a079ea4a556bbfb40c74e2bb46856e40026d746fd555d1a971ce5ded0d3ab440.1ce25488.png","alt":"OAuth client form with name and redirect URIs filled in"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"step-5-create-the-client","__idx":7},"children":["Step 5: Create the client"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create"]}," to save the OAuth client. A dialog will display your ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Client ID"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Client Secret"]}," — copy both values and store them securely."]},{"$$mdtype":"Tag","name":"Notification","attributes":{"title":"Save your Client Secret now","type":"attention"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Client Secret is only shown once in this dialog. After you close it, you cannot retrieve it again — you can only create a new secret."]}]},{"$$mdtype":"Tag","name":"LightboxImage","attributes":{"isLightbox":true},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/gmail-5.527c2f734260c842d4385cd27afec6969629e174a82d9a14e1005596e1a07401.1ce25488.png","alt":"OAuth client created dialog showing Client ID and blurred Client Secret"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"copy-your-credentials","__idx":8},"children":["Copy your credentials"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"step-6-copy-the-client-id-from-the-credentials-list","__idx":9},"children":["Step 6: Copy the Client ID from the credentials list"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After closing the dialog, your new client appears in the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["OAuth 2.0 Client IDs"]}," list on the Credentials page."]},{"$$mdtype":"Tag","name":"LightboxImage","attributes":{"isLightbox":true},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/gmail-6.3a77ea92174df6e043358d6cacc59fd2850b603d3a823fb333dadaad29048c15.1ce25488.png","alt":"Credentials page showing the new Frontegg Gmail Integration client"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"step-7-view-client-id-in-the-client-detail-page","__idx":10},"children":["Step 7: View Client ID in the client detail page"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Click the client name to open its detail page. You can view and copy the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Client ID"]}," at any time from the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Additional information"]}," section."]},{"$$mdtype":"Tag","name":"LightboxImage","attributes":{"isLightbox":true},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/gmail-7.23a2d40fb5854e855e9aed7d592177837d3aec5f93c77f3e3217e8248091c59a.1ce25488.png","alt":"OAuth client detail page showing Client ID"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"configure-the-frontegg-portal","__idx":11},"children":["Configure the Frontegg portal"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once you have your ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Client ID"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Client Secret"]},", enter them in the Frontegg portal:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Open the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Frontegg portal"]}," and navigate to [ENVIRONMENT] → Integrations → Gmail."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Enter the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Client ID"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Client Secret"]}," in the corresponding fields."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select the required ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["scopes"]},":"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Scope"},"children":["Scope"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://www.googleapis.com/auth/gmail.modify"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read, compose, send, and permanently delete threads and messages"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://www.googleapis.com/auth/gmail.readonly"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read all resources and their metadata"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://www.googleapis.com/auth/gmail.compose"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create, read, update, and delete drafts; send messages"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://www.googleapis.com/auth/gmail.send"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Send messages only"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://www.googleapis.com/auth/gmail.insert"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Insert and import messages"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://www.googleapis.com/auth/gmail.labels"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create, read, update, and delete labels"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://mail.google.com/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Full access to the account's mailboxes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://www.googleapis.com/auth/gmail.settings.basic"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Manage basic mail settings"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://www.googleapis.com/auth/gmail.settings.sharing"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Manage sensitive mail settings including forwarding rules and aliases"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://www.googleapis.com/auth/gmail.metadata"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["View email metadata such as labels and headers, but not the email body"]}]}]}]}]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":4},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Save"]},"."]}]},{"$$mdtype":"Tag","name":"Notification","attributes":{"title":"Keep your credentials secure","type":"attention"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Never share or commit your Client Secret to version control."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"additional-resources","__idx":12},"children":["Additional resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://developers.google.com/gmail/api/reference/rest"},"children":["Gmail API documentation"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://console.cloud.google.com/"},"children":["Google Cloud Console"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://developers.google.com/identity/protocols/oauth2/"},"children":["Setting up OAuth 2.0"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/agen-for-work/connectors/redirect-url"},"children":["How to get your Redirect URL"]}]}]}]}]},"headings":[{"value":"Gmail integration","id":"gmail-integration","depth":2},{"value":"Enable the Gmail API","id":"enable-the-gmail-api","depth":3},{"value":"Step 1: Open the Gmail API in the API library","id":"step-1-open-the-gmail-api-in-the-api-library","depth":4},{"value":"Create an OAuth client","id":"create-an-oauth-client","depth":3},{"value":"Step 2: Go to the Credentials page","id":"step-2-go-to-the-credentials-page","depth":4},{"value":"Step 3: Select OAuth client ID","id":"step-3-select-oauth-client-id","depth":4},{"value":"Step 4: Configure the OAuth client","id":"step-4-configure-the-oauth-client","depth":4},{"value":"Step 5: Create the client","id":"step-5-create-the-client","depth":4},{"value":"Copy your credentials","id":"copy-your-credentials","depth":3},{"value":"Step 6: Copy the Client ID from the credentials list","id":"step-6-copy-the-client-id-from-the-credentials-list","depth":4},{"value":"Step 7: View Client ID in the client detail page","id":"step-7-view-client-id-in-the-client-detail-page","depth":4},{"value":"Configure the Frontegg portal","id":"configure-the-frontegg-portal","depth":3},{"value":"Additional resources","id":"additional-resources","depth":3}],"frontmatter":{"seo":{"title":"Gmail integration"}},"lastModified":"2026-05-01T18:45:25.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/agen-for-work/connectors/marketplace/gmail","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}