Method: userProfiles.guardians.list

Affiche une liste des représentants légaux que l'utilisateur à l'origine de la demande est autorisé à consulter, limités à ceux qui correspondent à la demande.

Pour afficher la liste des représentants légaux d'un élève dont l'utilisateur à l'origine la demande peut voir les représentants légaux, utilisez le caractère littéral - pour l'ID étudiant.

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

  • PERMISSION_DENIED si un studentId est spécifié et que l'utilisateur à l'origine de la demande n'est pas autorisé à afficher les informations relatives au représentant légal de cet élève, si "-" est défini comme studentId et que l'utilisateur n'est pas administrateur de domaine, si les représentants légaux ne sont pas activés pour le domaine en question, si le filtre invitedEmailAddress est défini par un utilisateur qui n'est pas un administrateur de domaine, ou en cas d'autres erreurs d'accès.
  • INVALID_ARGUMENT si un studentId est spécifié, mais que son format ne peut pas être reconnu (il ne s'agit pas d'une adresse e-mail, ni d'un studentId de l'API, ni de la chaîne littérale me). Peut également être renvoyé si un pageToken non valide est fourni.
  • NOT_FOUND si un studentId est spécifié et que son format est reconnu, mais que Classroom ne contient aucune trace de cet élève.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
studentId

string

Filtrer les résultats en fonction de l'élève auquel le représentant légal est associé. Il peut s'agir de l'un des types d'identifiants suivants:

  • l'identifiant numérique de l'utilisateur
  • L'adresse e-mail de l'utilisateur
  • Le littéral de chaîne "me", indiquant l'utilisateur demandeur
  • Le littéral de chaîne "-", indiquant que les résultats doivent être renvoyés pour tous les élèves que l'utilisateur à l'origine de la demande peut consulter

Paramètres de requête

Paramètres
invitedEmailAddress

string

Filtrer les résultats en fonction de l'adresse e-mail à laquelle l'invitation initiale a été envoyée, permettant ainsi d'obtenir le lien du représentant légal. Ce filtre ne peut être utilisé que par les administrateurs du domaine.
pageToken

string

Valeur nextPageToken renvoyée par un appel list précédent, indiquant que la page de résultats suivante doit être renvoyée.

Par ailleurs, la requête list doit être identique à celle qui a généré ce jeton.
pageSize

integer

Nombre maximal d'articles à renvoyer. "0" ou "non spécifié" indique que le serveur peut attribuer une valeur maximale.

Le serveur peut renvoyer moins de résultats que le nombre spécifié.

Corps de la requête

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

Corps de la réponse

Réponse lors de la création de la liste des représentants légaux.

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

Représentation JSON 
{
  "guardians": [
    {
      object (Guardian)
    }
  ],
  "nextPageToken": string
}
Champs
guardians[]

object (Guardian)

Représentants légaux figurant sur cette page de résultats qui ont répondu aux critères spécifiés dans la demande.
nextPageToken

string

Jeton identifiant la page de résultats suivante à renvoyer. Si ce champ est vide, aucun autre résultat n'est disponible.

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.