Google Classroom add-ons are now generally available to developers! Please see the
add-ons documentation for more information.
Method: userProfiles.get
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.
HTTP request
GET https://classroom.googleapis.com/v1/userProfiles/{userId}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
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
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of UserProfile.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/classroom.rosters
https://www.googleapis.com/auth/classroom.rosters.readonly
https://www.googleapis.com/auth/classroom.profile.emails
https://www.googleapis.com/auth/classroom.profile.photos
For more information, see the Authorization guide.
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 2024-12-05 UTC.
[null,null,["Last updated 2024-12-05 UTC."],[[["This endpoint retrieves a user profile based on the provided user ID."],["The user ID can be a numeric identifier, email address, or \"me\" to indicate the requesting user."],["An empty request body is required, and a successful response returns a UserProfile object."],["Authorization is necessary and requires specific OAuth scopes related to rosters, emails, or photos."],["Potential errors include \"PERMISSION_DENIED\" if access is not granted or the profile doesn't exist."]]],[]]
