> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Google Classroom plugin

> Manage Google Classroom courses, rosters, classwork, submissions, add-ons, guardian links, and notification registrations.

Use **Google Classroom** through Corsair: one client, typed API calls.

This plugin uses Google OAuth 2.0 access tokens. The default consent request uses the narrowest 10-scope set that covers all stable operations; set the plugin's oauthScopes option to an even smaller supported set when a deployment enables only selected operations. Enable the Google Classroom API in the Google Cloud project and complete Google's OAuth app verification where required.

The plugin includes Google Pub/Sub notification registration create/delete operations, but does not receive Pub/Sub messages. Configure the topic and message consumer separately. No database migration or inbound webhook handler is needed.

**What you get:**

* 104 typed API operations

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/googleclassroom better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/googleclassroom better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/googleclassroom better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/googleclassroom better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

```ts corsair.ts theme={null}
import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { googleclassroom } from '@corsair-dev/googleclassroom';

export const corsair = createCorsair({
	plugins: [
		googleclassroom(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});
```

With `multiTenancy: true`, scope calls with `corsair.withTenant(id)`. See [Quick start](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) for account isolation.

**3. Choose authentication**

> [tab] OAuth 2.0 (Recommended)
>
> Open [hub.corsair.dev](https://hub.corsair.dev/dashboard), navigate to your project, and enter the **client ID** and **client secret** from your Google Classroom OAuth app.
>
> ```ts theme={null}
> googleclassroom()
> ```
>
> More: [OAuth 2.0](https://docs.corsair.dev/concepts/oauth)

**4. Connect a tenant**

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see [Connect / OAuth](https://docs.corsair.dev/management/connect).

```ts theme={null}
const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'googleclassroom',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**`courses.aliases.list`**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.googleclassroom.api.courses.aliases.list({});
```

**`courses.aliases.create`**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.googleclassroom.api.courses.aliases.create({});
```

See the full list on the [API](https://docs.corsair.dev/plugins/googleclassroom/api.md) page.

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/googleclassroom/api.md)
>
> Every `googleclassroom.api.*` operation with input and output types.

> [card] [Connect / OAuth](https://docs.corsair.dev/management/connect)
>
> createLink, Hub delivery, and tenant connect flows.

> [card] [Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)
>
> Expose this plugin's operations as MCP tools.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.