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.

Read-only.

photoUrl

string

URL of user's profile photo.

Read-only.

permissions[]

object(GlobalPermission)

Global permissions of the user.

Read-only.

verifiedTeacher

boolean

Represents whether a G Suite for Education user's domain administrator has explicitly verified them as being a teacher. If the user is not a member of a G Suite for Education domain, than this field will always be false.

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

get

Returns a user profile.

Send feedback about...

Classroom API
Classroom API
Need help? Visit our support page.