User eligibility

While any developer can make requests to the Google Classroom API, some Google Classroom features are only available to certain users. Each feature can have different requirements, such as having a certain Google Workspace for Education license type. For a detailed breakdown of features at each Google Workspace for Education license level, see the editions comparison page.

Key Term: An eligible user has the capability to use a certain Classroom feature if they meet the feature requirements.

Key Point: Capability is determined separately for each user and can change over time.

Features with eligibility requirements

The following Classroom API features are only available to eligible users:

• Creating Classroom add-on attachments
• Modifying grading period settings

Determine user capabilities

Requests to Classroom API are made on behalf of individual users. Therefore, you should check whether a user has the appropriate capabilities before issuing API requests with eligibility requirements.

Key Point: Consider checking user capabilities proactively so you can tailor your product's appearance or behavior to match the Classroom features that they can access.

To determine whether a user has a particular capability, make an API request to the checkUserCapability method. Include the appropriate Capability type for the Classroom feature you intend to use. Specify the appropriate Capability for each feature:

• To see if the user has access to a Classroom add-on owned by the requesting Google Cloud project, pass the CREATE_ADD_ON_ATTACHMENT value.
• To see if the user can modify grading period settings, pass the UPDATE_GRADING_PERIOD_SETTINGS.

Next, check the allowed field in the response. If allowed is true, then the user has access to the chosen Capability. You can then make API requests related the Capability on behalf of the user.

Important: Even when a user is eligible, it's still possible for API requests that depend on the eligibility to fail. Eligibility implies that a user can make use of a Classroom feature, not that a specific request will succeed.