Ressource: GuardianInvitation
Invitation à devenir le représentant légal d'un utilisateur spécifié, envoyée à une adresse e-mail donnée.
Représentation JSON |
---|
{
"studentId": string,
"invitationId": string,
"invitedEmailAddress": string,
"state": enum ( |
Champs | |
---|---|
studentId |
Identifiant de l'élève (au format standard) |
invitationId |
Identifiant unique de cette invitation. Lecture seule. |
invitedEmailAddress |
Adresse e-mail à laquelle l'invitation a été envoyée. Seuls les administrateurs du domaine peuvent voir ce champ. |
state |
État dans lequel se trouve cette invitation. |
creationTime |
Heure à laquelle cette invitation a été créée. Lecture seule. Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: |
GuardianInvitationState
État de l'invitation d'un représentant légal.
Enums | |
---|---|
GUARDIAN_INVITATION_STATE_UNSPECIFIED |
Ne doit jamais être renvoyé. |
PENDING |
L'invitation est active et attend une réponse. |
COMPLETE |
L'invitation n'est plus active. Il a peut-être été accepté, refusé ou annulé, ou il a expiré. |
Méthodes |
|
---|---|
|
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. |
|
Renvoie une invitation à un représentant légal spécifique. |
|
Renvoie une liste d'invitations destinées aux représentants légaux que l'utilisateur à l'origine de la demande est autorisé à consulter, filtrées en fonction des paramètres fournis. |
|
Modifie l'invitation du représentant légal. |