Every request your application sends to the Classroom API must include an authorization token. The token also identifies your application to Google.
About authorization protocols
Authorizing requests with OAuth 2.0
All requests to the Classroom API must be authorized by an authenticated user.
This process is facilitated with an OAuth client ID.Get an OAuth client ID
Or create one in the Credentials page.
The details of the authorization process, or "flow," for OAuth 2.0 vary somewhat depending on what kind of application you're writing. The following general process applies to all application types:
- When your application needs access to user data, it asks Google for a particular scope of access.
- Google displays a consent screen to the user, asking them to authorize your application to request some of their data.
- If the user approves, then Google gives your application a short-lived access token.
- Your application requests user data, attaching the access token to the request.
- If Google determines that your request and the token are valid, it returns the requested data.
Some flows include additional steps, such as using refresh tokens to acquire new access tokens. For detailed information about flows for various types of applications, see Google's OAuth 2.0 documentation.
Here's the OAuth 2.0 scope information for the Classroom API:
||View, create, and delete Classroom courses||Sensitive|
||View Classroom courses||Recommended|
||View class rosters, add and invite people to classes, remove people from classes||Sensitive|
||View class rosters||Recommended|
||View and modify assignments and questions and the work and grades for the current user.||Recommended|
||View assignments and questions and the work and grades for the current user.||Recommended|
||View and modify assignments and questions and the work and grades for the courses that the current user teaches and view the same for the courses the current user administers.||Recommended|
||View assignments and questions and the work and grades for the courses that the current user teaches or administers.||Recommended|
||View and modify announcements for the current user.||Recommended|
||View announcements for the current user.||Recommended|
||View and manage guardians for students in your Google Classroom classes||Sensitive|
||View guardians for students in your Google Classroom classes||Recommended|
||View your Google Classroom guardians||Recommended|
||Register for push notifications of Classroom activity.||Recommended|
|Additional Scopes - If needed, request these in addition to one or more of the scopes above|
||View user profile photos visible to the authenticated user||Sensitive|
||View user email addresses visible to the authenticated user||Sensitive|
The Usage column in the table above indicates the sensitivity of each scope, according to the following definitions:
Recommended—These scopes provide the smallest scope of authorization access and don't require any app verification or security assessment.
Sensitive—These scopes allow access to Google User Data and require a sensitive scope verification process. For information on this requirement, see Google API Services: User Data Policy. These scopes don't require a security assessment.
Restricted—These scopes provide wide access to Google User Data and require you to go through a restricted scope verification process. For information on this requirement, see Google API Services: User Data Policy and Additional Requirements for Specific API Scopes. If you store restricted scope data on servers (or transmit), then you must go through a security assessment.
Using certain sensitive OAuth scopes may require that your app go through Google's OAuth verification process. Read the OAuth verification FAQ to determine when your app should go through verification and what type of verification is required. See also the Google API Services: User Data Policy.
To request access using OAuth 2.0, your application needs the scope information, as well as information that Google supplies when you register your application (such as the client ID and the client secret).
Tip: The Google APIs client libraries can handle some of the authorization process for you. They are available for a variety of programming languages; check the page with libraries and samples for more details.