Method: userProfiles.guardians.get

Renvoie un représentant légal spécifique.

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

  • PERMISSION_DENIED si aucun utilisateur correspondant au studentId fourni n'est visible pour l'utilisateur à l'origine de la demande, si celui-ci n'est pas autorisé à consulter les informations du représentant légal de l'élève identifié par le studentId, si les représentants légaux ne sont pas activés pour le domaine en question, ou en cas d'erreur d'accès.
  • INVALID_ARGUMENT si une studentId est spécifiée, mais que son format n'est pas reconnu (il ne s'agit pas d'une adresse e-mail, d'un élément studentId de l'API ni de la chaîne littérale me).
  • NOT_FOUND si l'utilisateur à l'origine de la demande est autorisé à afficher les représentants légaux du studentId demandé, mais qu'il n'existe aucun enregistrement Guardian correspondant au guardianId fourni pour cet élève.

Requête HTTP

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians/{guardianId}

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
studentId

string

Élève dont le représentant légal est demandé. Choisissez l'une des options suivantes :

  • l'identifiant numérique de l'utilisateur
  • l'adresse e-mail de l'utilisateur ;
  • Le littéral de chaîne "me", indiquant l'utilisateur à l'origine de la demande
guardianId

string

Le champ id issu d'un Guardian.

Corps de la requête

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

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Guardian.

Champs d'application des autorisations

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

  • https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students

Pour en savoir plus, consultez le guide relatif aux autorisations.