Get

Returns a user profile

1 variables
10 variables

Returns a user profile.

This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to access this user profile, if no profile exists with the requested ID, or for access errors

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View the email addresses of people in your classes
  • View the profile photos of people in your classes
  • Manage your Google Classroom class rosters
  • View your Google Classroom class rosters

Input

This building block consumes 1 input parameters

  = Parameter name
  = Format

userId STRING Required

Identifier of the profile to return. The 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

Output

This building block provides 10 output parameters

  = Parameter name
  = Format

emailAddress STRING

Email address of the user.

Read-only

photoUrl STRING

URL of user's profile photo.

Read-only

permissions[] OBJECT

Global user permission description

permissions[].permission ENUMERATION

Permission value

name OBJECT

Details of the user's name

name.givenName STRING

The user's first name.

Read-only

name.familyName STRING

The user's last name.

Read-only

name.fullName STRING

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

Read-only

id STRING

Identifier 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