Method: userProfiles.checkUserCapability

Indique si un utilisateur peut utiliser la fonctionnalité Classroom spécifiée. Par exemple, ce point de terminaison permet de vérifier si un utilisateur peut créer des pièces jointes de modules complémentaires.

Un utilisateur à l'origine de la demande ne peut vérifier les fonctionnalités que pour lui-même.

Cette méthode renvoie les codes d'erreur suivants :

  • PERMISSION_DENIED si l'utilisateur à l'origine de la demande n'est pas autorisé à vérifier l'éligibilité de l'utilisateur spécifié.
  • INVALID_ARGUMENT si la requête est incorrecte.

Requête HTTP

GET https://classroom.googleapis.com/v1/userProfiles/{userId}:checkUserCapability

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
userId

string

Obligatoire. Identifiant de l'utilisateur.

Lorsqu'il est spécifié en tant que paramètre d'une requête, cet identifiant peut être l'un des suivants:

  • l'identifiant numérique de l'utilisateur
  • l'adresse e-mail de l'utilisateur ;
  • le littéral de chaîne "me", qui indique l'utilisateur à l'origine de la requête

Paramètres de requête

Paramètres
capability

enum (Capability)

Obligatoire. Capacité à vérifier pour cet utilisateur. Par exemple, pour vérifier si un utilisateur peut créer une pièce jointe de module complémentaire, définissez cette valeur sur CREATE_ADD_ON_ATTACHMENT.
previewVersion

enum (PreviewVersion)

Facultatif. Version preview de l'API.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Réponse de la vérification des fonctionnalités de l'utilisateur.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "capability": enum (Capability),
  "allowed": boolean
}
Champs
capability

enum (Capability)

Fonctionnalités Classroom
allowed

boolean

Indique si la fonctionnalité spécifiée est autorisée pour l'utilisateur.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/classroom.courses
  • https://www.googleapis.com/auth/classroom.courses.readonly

Pour en savoir plus, consultez le guide d'autorisation.

Capacité

Énumération représentant la capacité.

Enums
CAPABILITY_UNSPECIFIED Non compatible.
CREATE_ADD_ON_ATTACHMENT Possibilité de créer et de modifier des AddOnAttachments associés au projet de la Developer Console de l'ID client OAuth utilisé pour effectuer la requête.
UPDATE_GRADING_PERIOD_SETTINGS Possibilité de modifier les paramètres de la période de notation.