@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 87 lines 7.63 KB
Rendered Raw
1 ## How do I set up custom Google OAuth credentials for Google Classroom?
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 Connect with a Google account that has Classroom access. Course access follows the user's Classroom role, and some advanced features need specific Education licenses.
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 **Google Classroom API** (`classroom.googleapis.com`), and select **Enable**. If the page shows **Manage**, the API is already enabled. See Google's [Classroom API setup](https://developers.google.com/workspace/classroom/guides/get-started).
14
15 ![Google Classroom API product page with the Enable button](/images/toolkits/google_classroom/enable-classroom-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/Q8INvnJoiCMyajqrrAtq6ovCE5U.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/BetTxXqa2c1dgg4QeV4g9RV008.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 Classroom courses and rosters read-only scopes selected](/images/toolkits/google_classroom/data-access-classroom-scopes.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](/images/toolkits/shared/S7mFFv6C5mCP4y0ScTzRzQd8Nc.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/1qh7A0aEGRUU1K19aU37FrcxTY.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 ![Google OAuth web client details with Client ID and Client secret](/images/toolkits/shared/TmVTLOgVKQDqamjQVxKDBXJtPQ.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_classroom), open **Auth Configs** → **Create** and select **Google Classroom**.
44 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**.
45 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.
46
47 ![Google consent screen asking to view your Google Classroom classes and class rosters](/images/toolkits/google_classroom/google-consent-screen.webp)
48
49 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.
50
51 For the general flow, see [Custom auth configs](/docs/auth-configuration/custom-auth-configs).
52
53 ### Scopes
54
55 The default auth config requests these scopes under `https://www.googleapis.com/auth/`: `classroom.courses.readonly`, `classroom.coursework.students`, `classroom.courseworkmaterials`, `classroom.topics`, `classroom.rosters.readonly`, `classroom.announcements`, and `classroom.course-work`. Keep `classroom.rosters.readonly`: Composio uses it to check the signed-in Classroom profile. It lets the app view rosters but not change them. For read-only use, `classroom.courses.readonly` plus `classroom.rosters.readonly` is enough. See Google's [Classroom scope reference](https://developers.google.com/workspace/classroom/guides/auth).
56
57 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.
58
59 ### Publish and verify the app
60
61 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).
62
63 ![Google hasn't verified this app notice for an app in Testing](/images/toolkits/shared/Mavl5IyzWvxI5tP64ScXgpeyI94.webp)
64
65 If you change the requested scopes later, reconnect the account so the user grants the new access.
66
67 ## Why am I seeing "App is blocked" when connecting Google Classroom?
68
69 The OAuth client is requesting scopes that Google hasn't verified for that client. This usually happens when you add extra scopes beyond the defaults.
70
71 Remove the additional scopes from your auth config, or use your own OAuth app and submit those scopes for Google verification. The setup and verification steps are under **How do I set up custom Google OAuth credentials for Google Classroom?** above.
72
73 ## Why am I getting "Google Classroom API has not been used in project" error?
74
75 When using custom OAuth credentials, the Google Classroom API must be enabled in the Google Cloud project that owns those credentials. Enable it in Google Cloud Console under APIs & Services, wait a few minutes, and retry.
76
77 ## Why am I getting "Error 400: invalid_scope"?
78
79 The requested scopes are invalid or incorrectly formatted in the authorization URL. Verify your scope values against the [Google OAuth scopes docs](https://developers.google.com/identity/protocols/oauth2). If you're creating auth configs programmatically, see the [programmatic auth config guide](/docs/authentication/programmatic-auth-configs).
80
81 ## Why does the OAuth consent screen show "Composio" instead of my app?
82
83 By default, the consent screen uses Composio's OAuth app. To show your own app name and logo, create your own OAuth app and set a custom redirect URL. See [White-labeling authentication](/docs/authentication/white-labeling-authentication#using-your-own-oauth-apps).
84
85 ## Why am I getting 401 errors on tool calls?
86
87 The user's access token is no longer valid. Common causes: the user revoked access, changed their password or 2FA, a Workspace admin policy changed, or Google's refresh token limit (~50 per account) was exceeded. Re-authenticating the user typically resolves this.