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

REST Resource: userProfiles

Resource: UserProfile

Global information for a user.

JSON representation 
{
 "id": string,
 "name": {
 object (Name )
 },
 "emailAddress": string,
 "photoUrl": string,
 "permissions": [
 {
 object (GlobalPermission )
 }
 ],
 "verifiedTeacher": boolean
}
Fields
id

string

Identifier of the user.

Read-only.
name

object (Name )

Name of the user.

Read-only.
emailAddress

string

Email address of the user.

Must request https://www.googleapis.com/auth/classroom.profile.emails scope for this field to be populated in a response body.

Read-only.
photoUrl

string

URL of user's profile photo.

Must request https://www.googleapis.com/auth/classroom.profile.photos scope for this field to be populated in a response body.

Read-only.
permissions[]

object (GlobalPermission )

Global permissions of the user.

Read-only.
verifiedTeacher

boolean

Represents whether a Google Workspace for Education user's domain administrator has explicitly verified them as being a teacher. This field is always false if the user is not a member of a Google Workspace for Education domain.

Read-only

Name

Details of the user's name.

JSON representation 
{
 "givenName": string,
 "familyName": string,
 "fullName": string
}
Fields
givenName

string

The user's first name.

Read-only.
familyName

string

The user's last name.

Read-only.
fullName

string

The user's full name formed by concatenating the first and last name values.

Read-only.

GlobalPermission

Global user permission description.

JSON representation 
{
 "permission": enum (Permission )
}
Fields
permission

enum (Permission )

Permission value.

Permission

Possible permissions that a user may have.

Enums
PERMISSION_UNSPECIFIED No permission is specified. This is not returned and is not a valid value.
CREATE_COURSE User is permitted to create a course.

Methods

checkUserCapability

Returns whether a user may use the specified Classroom capability.

get

Returns a user profile.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年04月17日 UTC.