Method: userProfiles.guardians.list

Renvoie une liste de représentants légaux que l'utilisateur demandeur est autorisé à consulter, limitée à ceux qui correspondent à la requête.

Pour lister les représentants légaux d'un élève pour lequel l'utilisateur à l'origine de la demande peut consulter les représentants légaux, utilisez le caractère littéral - dans l'ID élève.

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

  • PERMISSION_DENIED si le studentId est spécifié, et que l'utilisateur à l'origine de la demande n'est pas autorisé à consulter 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 un administrateur du 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 du domaine, ou en cas d'erreur d'accès.
  • INVALID_ARGUMENT si une valeur 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 ou de la chaîne littérale me). Peut également être renvoyé si une valeur pageToken non valide est fournie.
  • NOT_FOUND si un élément studentId est spécifié et que son format est reconnu, mais que Classroom n'a 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 éléments 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 à l'origine de la demande
  • 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 a accès.

Paramètres de requête

Paramètres
invitedEmailAddress

string

Filtrez les résultats en fonction de l'adresse e-mail à laquelle l'invitation initiale a été envoyée, ce qui génère ce lien vers le représentant légal. Ce filtre ne peut être utilisé que par les administrateurs de 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'éléments à renvoyer. La valeur "zéro" ou "non spécifié" indique que le serveur peut attribuer une valeur maximale.

Le serveur peut renvoyer un nombre de résultats inférieur au 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 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 sur cette page de résultats et répondant aux critères spécifiés dans la demande.
nextPageToken

string

Jeton identifiant la page suivante de résultats à renvoyer. Si ce champ n'est pas renseigné, 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.