Google Classroom API . userProfiles

Instance Methods

guardianInvitations()

Returns the guardianInvitations Resource.

guardians()

Returns the guardians Resource.

close()

Close httplib2 connections.

get(userId, x__xgafv=None)

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.

Method Details

close()
Close httplib2 connections.
get(userId, x__xgafv=None)
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.

Args:
  userId: string, 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 (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Global information for a user.
  "emailAddress": "A 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.
  "id": "A String", # Identifier of the user. Read-only.
  "name": { # Details of the user's name. # Name of the user. Read-only.
    "familyName": "A String", # The user's last name. Read-only.
    "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
    "givenName": "A String", # The user's first name. Read-only.
  },
  "permissions": [ # Global permissions of the user. Read-only.
    { # Global user permission description.
      "permission": "A String", # Permission value.
    },
  ],
  "photoUrl": "A 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.
  "verifiedTeacher": True or False, # 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
}