@devries-cameron20 / composio Mirror · read-only
Fork 0

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

Mirrored from https://github.com/Camo67/composio.git

Synced Nov 21, 06:00 UTC

next
md 75 lines 6.27 KB
Rendered Raw
1 ## How do I set up custom Google OAuth credentials for Google Search Console?
2
3 Use your own Google OAuth app when you want your app name on the consent screen, your own API quota, or full control over the requested scopes.
4
5 The Google account you connect needs access to the Search Console property. OAuth consent doesn't grant ownership of a site.
6
7 ### Create the Google OAuth app
8
9 1. In [Google Cloud Console](https://console.cloud.google.com/), select the project that will own the OAuth client, or create one.
10
11 ![Google Cloud console project picker](/images/toolkits/shared/hjaj4jg5CtBRolXXYddY8NDXCes.webp)
12
13 2. Open **APIs & Services** → **Library**, search for **Google Search Console API**, and select **Enable**. If the page shows **Manage**, the API is already enabled. See Google's [API prerequisites](https://developers.google.com/webmaster-tools/v1/prereqs).
14
15 ![Google Search Console API page in the API Library](/images/toolkits/google_search_console/enable-search-console-api.webp)
16
17 3. Open **Google Auth Platform** → **Branding**. If Google shows **Get started**, enter the app name, user support email, and developer contact email, then save.
18
19 ![Google Auth Platform Branding page with app name and user support email](/images/toolkits/shared/x4VkWS3iceKKFGyjlFN1THrtTRQ.webp)
20
21 4. Open **Audience**. Choose **Internal** to limit the app to users in your Google Workspace organization, or **External** for consumer accounts and users outside it. While an external app's publishing status is **Testing**, only accounts listed under **Test users** can connect, so add every account you'll test with.
22
23 ![Google Auth Platform Audience page with Testing status, External user type, and Test users](/images/toolkits/shared/Jttbz3Cm6xJFWNlukXLGTxWjf6c.webp)
24
25 5. Open **Data Access** → **Add or remove scopes** and add the scopes listed under **Scopes** below. If a scope isn't in the list, paste its full URL under **Manually add scopes** and select **Add to table**. Select **Update**, then **Save**.
26
27 ![Data Access scope picker with the webmasters.readonly scope selected](/images/toolkits/google_search_console/data-access-webmasters-scope.webp)
28
29 6. Open **Clients** → **Create client**, choose **Web application**, and give it a name.
30
31 ![Create OAuth client ID form with Web application selected and a client name](/images/toolkits/shared/sA0bvCBPtMCWw8lqecCrx76Dyc.webp)
32
33 7. Under **Authorized redirect URIs**, add `https://backend.composio.dev/api/v1/auth-apps/add`. It must exactly match the `oauth_redirect_uri` field on your Composio auth config.
34
35 ![OAuth client form with the Composio redirect URI under Authorized redirect URIs](/images/toolkits/shared/jDTS80dlfwHF6u1WAQhBdnjTrI.webp)
36
37 8. Select **Create**. Copy the **Client ID** and **Client secret**. Google shows the full secret only once, so save it before you close the dialog.
38
39 ![OAuth client created dialog with the Client ID and Client secret](/images/toolkits/shared/YdKWAswsL2nVXnSbA4zgBUDmwA.webp)
40
41 ### Create the auth config in Composio
42
43 1. In the [Composio dashboard](https://dashboard.composio.dev/~/project/auth-configs?utm_source=docs&utm_medium=content&utm_campaign=toolkits-google_search_console), open **Auth Configs** → **Create** and select **Google Search Console**.
44
45 ![Composio Auth Configs page with the Create button](/images/toolkits/shared/DUtMN0UWIU2kEqnvS5DvD7qhWU.webp)
46
47 ![Create Auth Config dialog with Google Search Console in the search results](/images/toolkits/google_search_console/select-google-search-console-toolkit.webp)
48
49 2. Choose **OAuth 2.0** and **Your Own Credentials**, then paste your **Client ID** and **Client secret**. Leave **Redirect URI** unchanged, keep the scopes in line with what you added in Google, and select **Create Auth Config**.
50
51 ![Google Search Console auth config form with Client ID, Client secret, Redirect URI, and the webmasters.readonly scope](/images/toolkits/google_search_console/auth-config-credentials.webp)
52
53 3. Open the auth config, select **Connect Account**, and sign in with the Google account you want to connect. Review the requested permissions before you continue.
54
55 ![Google consent screen asking to view Search Console data for your verified sites](/images/toolkits/google_search_console/google-consent-screen.webp)
56
57 4. Open **Accounts** on the auth config and confirm the connected account shows **Active**. The auth config's own **Enabled** label doesn't confirm a connection.
58
59 ![Composio auth config panel with the Google Search Console connected account shown as Active](/images/toolkits/google_search_console/connected-account-active.webp)
60
61 For the general flow, see [Custom auth configs](/docs/auth-configuration/custom-auth-configs).
62
63 ### Scopes
64
65 The default auth config requests `https://www.googleapis.com/auth/webmasters`, `https://www.googleapis.com/auth/webmasters.readonly`, `https://www.googleapis.com/auth/userinfo.profile`, `https://www.googleapis.com/auth/userinfo.email`. `webmasters.readonly` is enough to read search performance data. Site-management operations need `webmasters` and the matching property access. See Google's [authorization guide](https://developers.google.com/webmaster-tools/v1/how-tos/authorizing).
66
67 Short scope names on this page leave out the `https://www.googleapis.com/auth/` prefix. When you paste a scope under **Manually add scopes**, use the full URL, for example `https://www.googleapis.com/auth/userinfo.email`. Scopes already written as a full URL, such as `https://mail.google.com/`, go in as shown.
68
69 ### Publish and verify the app
70
71 While an external app is in **Testing**, Google shows an unverified-app notice and refresh tokens expire after seven days, so users have to reconnect. Before you invite production users, select **Publish app** on the **Audience** page. A public app that requests sensitive or restricted scopes also needs Google's OAuth verification, which you start from **Verification Center**. Publishing doesn't complete verification on its own. Internal apps and apps in Testing can be exempt. See Google's [verification requirements](https://developers.google.com/identity/protocols/oauth2/production-readiness/overview).
72
73 ![Google hasn't verified this app notice for an app in Testing](/images/toolkits/shared/M0mS4XrLbK5mU52ry578MBa7M.webp)
74
75 If you change the requested scopes later, reconnect the account so the user grants the new access.