Google Classroom add-ons are now generally available to developers! Please see the add-ons documentation for more information.

Method: userProfiles.checkUserCapability

HTTP request
Path parameters
Query parameters
Request body
Response body
- JSON representation
Authorization scopes
Capability

Developer Preview:Available as part of the Google Workspace Developer Preview Program , which grants early access to certain features. This feature is available in

 V1_20240930_PREVIEW

and later. See Access Preview APIs to learn more.

Returns whether a user may use the specified Classroom capability. For example, this endpoint can be used to check whether a user may create add- on attachments.

A requesting user can only check capabilities for themselves.

This method returns the following error codes:

PERMISSION_DENIED if the requesting user is not permitted to check eligibility for the specified user.
INVALID_ARGUMENT if the request is malformed.

HTTP request

GET https://classroom.googleapis.com/v1/userProfiles/{userId}:checkUserCapability

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

userId

string

Required. Identifier of the user.

When specified as a parameter of a request, this identifier can be one of the following:

the numeric identifier for the user
the email address of the user
the string literal "me" , indicating the requesting user

Query parameters

Parameters

Parameters
`capability`	`enum ( Capability )` Required. The Capability that should be checked for this user. For example, to check whether a user can create an add-on attachment , set this to `CREATE_ADD_ON_ATTACHMENT` .
`previewVersion`	`enum ( PreviewVersion )` Optional. The preview version of the API.

capability

enum ( Capability )

Required. The Capability that should be checked for this user. For example, to check whether a user can create an add-on attachment , set this to CREATE_ADD_ON_ATTACHMENT .

previewVersion

enum ( PreviewVersion )

Optional. The preview version of the API.

Request body

The request body must be empty.

Response body

Response from checking user capabilities.

If successful, the response body contains data with the following structure:

JSON representation
{ "capability" : enum ( `Capability` ) , "allowed" : boolean }

Fields

Fields
`capability`	`enum ( Capability )` The Classroom capability.
`allowed`	`boolean` Whether the specified capability is allowed for the user.

capability

enum ( Capability )

The Classroom capability.

allowed

boolean

Whether the specified capability is allowed for the user.

Authorization scopes

Requires one of the following OAuth scopes:

https://www.googleapis.com/auth/classroom.courses
https://www.googleapis.com/auth/classroom.courses.readonly

For more information, see the Authorization guide .

Capability

Enum to represent the capability.

Enums
`CAPABILITY_UNSPECIFIED`	Not supported.
`CREATE_ADD_ON_ATTACHMENT`	The capability to create and modify AddOnAttachments associated with the Developer Console project of the OAuth client ID used to make the request.
`CREATE_RUBRIC`	The capability to create and modify Rubrics.
`UPDATE_GRADING_PERIOD_SETTINGS`	The capability to modify grading period settings.
`CREATE_STUDENT_GROUP`	The capability to create and modify student groups and their members.