REST Resource: userProfiles
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Ressource: UserProfile
Informations globales sur un utilisateur.
Représentation JSON |
{
"id": string,
"name": {
object (Name )
},
"emailAddress": string,
"photoUrl": string,
"permissions": [
{
object (GlobalPermission )
}
],
"verifiedTeacher": boolean
} |
Champs |
id |
string
Identifiant de l'utilisateur. Lecture seule.
|
name |
object (Name )
Nom de l'utilisateur. Lecture seule.
|
emailAddress |
string
Adresse e-mail de l'utilisateur. Vous devez demander la portée https://www.googleapis.com/auth/classroom.profile.emails pour que ce champ soit renseigné dans un corps de réponse. Lecture seule.
|
photoUrl |
string
URL de la photo de profil de l'utilisateur. Vous devez demander la portée https://www.googleapis.com/auth/classroom.profile.photos pour que ce champ soit renseigné dans un corps de réponse. Lecture seule.
|
permissions[] |
object (GlobalPermission )
Autorisations globales de l'utilisateur. Lecture seule.
|
verifiedTeacher |
boolean
Indique si l'administrateur du domaine d'un utilisateur Google Workspace for Education l'a explicitement validé en tant qu'enseignant. Ce champ est toujours défini sur "false" si l'utilisateur n'est pas membre d'un domaine Google Workspace for Education. Lecture seule
|
Nom
Informations sur le nom de l'utilisateur.
Représentation JSON |
{
"givenName": string,
"familyName": string,
"fullName": string
} |
Champs |
givenName |
string
Prénom de l'utilisateur. Lecture seule.
|
familyName |
string
Nom de famille de l'utilisateur. Lecture seule.
|
fullName |
string
Nom complet de l'utilisateur formé en concatenant les valeurs du prénom et du nom. Lecture seule.
|
GlobalPermission
Description de l'autorisation utilisateur globale.
Représentation JSON |
{
"permission": enum (Permission )
} |
Champs |
permission |
enum (Permission )
Valeur d'autorisation.
|
Autorisation
Autorisations possibles d'un utilisateur.
Enums |
PERMISSION_UNSPECIFIED |
Aucune autorisation n'est spécifiée. Cette valeur n'est pas renvoyée et n'est pas valide. |
CREATE_COURSE |
L'utilisateur est autorisé à créer un cours. |
Méthodes |
|
Indique si un utilisateur peut utiliser la fonctionnalité Classroom spécifiée. |
|
Renvoie un profil utilisateur. |
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 2025/07/25 (UTC)."],[],[],null,["# REST Resource: userProfiles\n\n- [Resource: UserProfile](#UserProfile)\n - [JSON representation](#UserProfile.SCHEMA_REPRESENTATION)\n - [Name](#UserProfile.Name)\n - [JSON representation](#UserProfile.Name.SCHEMA_REPRESENTATION)\n - [GlobalPermission](#UserProfile.GlobalPermission)\n - [JSON representation](#UserProfile.GlobalPermission.SCHEMA_REPRESENTATION)\n - [Permission](#UserProfile.Permission)\n- [Methods](#METHODS_SUMMARY)\n\nResource: UserProfile\n---------------------\n\nGlobal information for a user.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"name\": { object (/workspace/classroom/reference/rest/v1/userProfiles#UserProfile.Name) }, \"emailAddress\": string, \"photoUrl\": string, \"permissions\": [ { object (/workspace/classroom/reference/rest/v1/userProfiles#UserProfile.GlobalPermission) } ], \"verifiedTeacher\": boolean } ``` |\n\n| Fields ||\n|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` Identifier of the user. Read-only. |\n| `name` | `object (`[Name](/workspace/classroom/reference/rest/v1/userProfiles#UserProfile.Name)`)` Name of the user. Read-only. |\n| `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. |\n| `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. |\n| `permissions[]` | `object (`[GlobalPermission](/workspace/classroom/reference/rest/v1/userProfiles#UserProfile.GlobalPermission)`)` Global permissions of the user. Read-only. |\n| `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 |\n\n### Name\n\nDetails of the user's name.\n\n| JSON representation |\n|---------------------------------------------------------------------------|\n| ``` { \"givenName\": string, \"familyName\": string, \"fullName\": string } ``` |\n\n| Fields ||\n|--------------|--------------------------------------------------------------------------------------------------|\n| `givenName` | `string` The user's first name. Read-only. |\n| `familyName` | `string` The user's last name. Read-only. |\n| `fullName` | `string` The user's full name formed by concatenating the first and last name values. Read-only. |\n\n### GlobalPermission\n\nGlobal user permission description.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------|\n| ``` { \"permission\": enum (/workspace/classroom/reference/rest/v1/userProfiles#UserProfile.Permission) } ``` |\n\n| Fields ||\n|--------------|-----------------------------------------------------------------------------------------------------------------------|\n| `permission` | `enum (`[Permission](/workspace/classroom/reference/rest/v1/userProfiles#UserProfile.Permission)`)` Permission value. |\n\n### Permission\n\nPossible permissions that a user may have.\n\n| Enums ||\n|--------------------------|----------------------------------------------------------------------------|\n| `PERMISSION_UNSPECIFIED` | No permission is specified. This is not returned and is not a valid value. |\n| `CREATE_COURSE` | User is permitted to create a course. |\n\n| Methods ------- ||\n|----------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### [checkUserCapability](/workspace/classroom/reference/rest/v1/userProfiles/checkUserCapability) | | **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features. This feature is available in [V1_20240930_PREVIEW](https://developers.google.com/workspace/classroom/reference/rest/v1/PreviewVersion) and later. See [Access Preview APIs](https://developers.google.com/workspace/classroom/reference/preview) to learn more. Returns whether a user may use the specified Classroom capability. |\n| ### [get](/workspace/classroom/reference/rest/v1/userProfiles/get) | Returns a user profile. |"]]