@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, 04:45 UTC

next
md 57 lines 5.36 KB
Rendered Raw
1 ## How do I set up custom Google OAuth credentials for Google Admin?
2
3 Composio doesn't provide a managed OAuth app for Google Admin, so you need your own Google OAuth app to connect it.
4
5 Connect with a Google Workspace administrator account that has the Directory privileges your workflow needs. Your organization may also need to allow the OAuth app under its app-access policy.
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/9j8wjr2HocIhIsgedntpgb4m8Y.webp)
12
13 2. Open **APIs & Services** → **Library**, search for **Admin SDK API** (`admin.googleapis.com`), and select **Enable**. If the page shows **Manage**, the API is already enabled. The toolkit uses its Directory API.
14 3. Open **Google Auth Platform** → **Branding**. If Google shows **Get started**, enter the app name, user support email, and developer contact email, then save.
15
16 ![Google Auth Platform Branding page with app name and user support email](/images/toolkits/shared/Q8INvnJoiCMyajqrrAtq6ovCE5U.webp)
17
18 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.
19
20 ![Google Auth Platform Audience page with Testing status, External user type, and Test users](/images/toolkits/shared/BetTxXqa2c1dgg4QeV4g9RV008.webp)
21
22 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**.
23 6. Open **Clients** → **Create client**, choose **Web application**, and give it a name.
24
25 ![Create OAuth client ID form with Web application selected](/images/toolkits/shared/S7mFFv6C5mCP4y0ScTzRzQd8Nc.webp)
26
27 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.
28
29 ![OAuth client form with the Composio redirect URI under Authorized redirect URIs](/images/toolkits/shared/1qh7A0aEGRUU1K19aU37FrcxTY.webp)
30
31 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.
32
33 ![Google OAuth web client details with Client ID and Client secret](/images/toolkits/shared/TmVTLOgVKQDqamjQVxKDBXJtPQ.webp)
34
35 ### Create the auth config in Composio
36
37 1. In the [Composio dashboard](https://dashboard.composio.dev/~/project/auth-configs?utm_source=docs&utm_medium=content&utm_campaign=toolkits-google_admin), open **Auth Configs** → **Create** and select **Google Admin**.
38 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**.
39 3. Open the auth config, select **Connect Account**, and sign in with the Workspace administrator account. If Google returns an access error, check the account's Directory privileges and your organization's app-access policy. A valid OAuth grant doesn't add admin privileges.
40
41 ![Google consent screen asking to see info about users on your domain](/images/toolkits/google_admin/google-consent-screen.webp)
42
43 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.
44
45 For the general flow, see [Custom auth configs](/docs/auth-configuration/custom-auth-configs).
46
47 ### Scopes
48
49 The default auth config requests read and write Directory API scopes for users, user aliases, groups, group members, org units, and domains, such as `https://www.googleapis.com/auth/admin.directory.user` and `https://www.googleapis.com/auth/admin.directory.user.readonly`. To only list users, `https://www.googleapis.com/auth/admin.directory.user.readonly` is enough. Remove group, member, or write scopes your workflow doesn't use. See the [users.list reference](https://developers.google.com/workspace/admin/directory/reference/rest/v1/users/list).
50
51 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.
52
53 ### Publish and verify the app
54
55 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).
56
57 If you change the requested scopes later, reconnect the account so the user grants the new access.