Method: userProfiles.guardianInvitations.create

Crée une invitation au représentant légal et envoie un e-mail au tuteur pour lui demander de confirmer qu'il est bien celui de l'élève.

Une fois que le représentant légal a accepté l'invitation, son state devient COMPLETED et il commence à recevoir des notifications. Une ressource Guardian sera également créée pour représenter le représentant légal actif.

Les champs studentId et invitedEmailAddress doivent être définis pour l'objet de la requête. Si vous ne définissez pas ces champs ou si vous définissez tout autre champ dans la requête, une erreur se produit.

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

  • PERMISSION_DENIED si l'utilisateur actuel n'est pas autorisé à gérer les représentants légaux, si le représentant légal en question a déjà refusé trop de demandes pour cet élève ou si les représentants légaux ne sont pas activés pour le domaine en question, ou encore en cas d'erreur d'accès.
  • RESOURCE_EXHAUSTED si l'élève ou le représentant légal a dépassé la limite de liens pour les représentants légaux.
  • INVALID_ARGUMENT si l'adresse e-mail du représentant légal n'est pas valide (si elle est trop longue, par exemple) ou si le format de l'ID étudiant fourni n'est pas reconnu (il ne s'agit pas d'une adresse e-mail, ni d'un fichier userId de cette API). Cette erreur est également renvoyée si des champs en lecture seule sont définis ou si le champ state est défini sur une valeur autre que PENDING.
  • NOT_FOUND si la carte d'étudiant fournie est un numéro d'étudiant valide, mais que Classroom n'a aucune trace de cet élève
  • ALREADY_EXISTS si une invitation de représentant légal est déjà en attente pour l'élève et invitedEmailAddress, ou si le invitedEmailAddress fourni correspond au compte Google d'un Guardian existant pour cet utilisateur.

Requête HTTP

POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
guardianInvitation.studentId

string

Identifiant de l'élève (au format standard)

Corps de la requête

Le corps de la requête contient une instance GuardianInvitation.

Corps de la réponse

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

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

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