Authorizing Requests

If your public application uses scopes that permit access to certain user data, it must complete a verification process. If you see unverified app on the screen when testing your application, you must submit a verification request to remove it. Find out more about unverified apps and get answers to frequently asked questions about app verification in the Help Center.

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

Your application must use OAuth 2.0 to authorize requests. No other authorization protocols are supported. If your application uses Google Sign-In, some aspects of authorization are handled for you.

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:

1. When your application needs access to user data, it asks Google for a particular scope of access.
2. Google displays a consent screen to the user, asking them to authorize your application to request some of their data.
3. If the user approves, then Google gives your application a short-lived access token.
4. Your application requests user data, attaching the access token to the request.
5. 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:

Scope	Meaning	Usage
https://www.googleapis.com/auth/classroom.courses	View, create, and delete Classroom courses	Sensitive
https://www.googleapis.com/auth/classroom.courses.readonly	View Classroom courses	Recommended
https://www.googleapis.com/auth/classroom.rosters	View class rosters, add and invite people to classes, remove people from classes	Sensitive
https://www.googleapis.com/auth/classroom.rosters.readonly	View class rosters	Recommended
https://www.googleapis.com/auth/classroom.coursework.me	View and modify assignments and questions and the work and grades for the current user.	Recommended
https://www.googleapis.com/auth/classroom.coursework.me.readonly	View assignments and questions and the work and grades for the current user.	Recommended
https://www.googleapis.com/auth/classroom.coursework.students	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
https://www.googleapis.com/auth/classroom.coursework.students.readonly	View assignments and questions and the work and grades for the courses that the current user teaches or administers.	Recommended
https://www.googleapis.com/auth/classroom.announcements	View and modify announcements for the current user.	Recommended
https://www.googleapis.com/auth/classroom.announcements.readonly	View announcements for the current user.	Recommended
https://www.googleapis.com/auth/classroom.guardianlinks.students	View and manage guardians for students in your Google Classroom classes	Sensitive
https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly	View guardians for students in your Google Classroom classes	Recommended
https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly	View your Google Classroom guardians	Recommended
https://www.googleapis.com/auth/classroom.push-notifications	Register for push notifications of Classroom activity.	Recommended
Additional Scopes - If needed, request these in addition to one or more of the scopes above
https://www.googleapis.com/auth/classroom.profile.photos	View user profile photos visible to the authenticated user	Sensitive
https://www.googleapis.com/auth/classroom.profile.emails	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.

OAuth verification

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.