Method: userProfiles.guardianInvitations.create
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Crée une invitation pour le représentant légal et lui envoie un e-mail lui demandant de confirmer qu'il est bien le représentant légal de l'élève.
Une fois que le responsable parental aura accepté l'invitation, son state
passera à COMPLETED
et il commencera à recevoir des notifications pour les responsables parentaux. Une ressource Guardian
est également créée pour représenter le responsable actif.
Les champs studentId
et invitedEmailAddress
doivent être définis dans l'objet de la requête. Si vous ne définissez pas ces champs ou si vous définissez d'autres champs dans la requête, une erreur s'affiche.
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, si les représentants légaux ne sont pas activés pour le domaine en question ou en cas d'autres erreurs d'accès.
RESOURCE_EXHAUSTED
si l'élève ou le représentant légal a dépassé la limite d'association avec un représentant légal.
INVALID_ARGUMENT
si l'adresse e-mail du représentant légal n'est pas valide (par exemple, si elle est trop longue) ou si le format de la pièce d'identité de l'élève fourni ne peut pas être reconnu (il ne s'agit pas d'une adresse e-mail ni d'un 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 le numéro d'élève fourni est valide, mais que Classroom ne dispose d'aucun enregistrement de cet élève.
ALREADY_EXISTS
si une invitation de représentant légal est déjà en attente pour l'élève et que le invitedEmailAddress
est fourni, 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
Numéro d'identification de l'étudiant (au format standard)
|
Corps de la requête
Le corps de la requête contient une instance de 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 d'autorisation.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 2025/07/25 (UTC)."],[],[],null,["# Method: userProfiles.guardianInvitations.create\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nCreates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian.\n\nOnce the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian.\n\nThe request object must have the `studentId` and `invitedEmailAddress` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other [access errors](/workspace/classroom/reference/Access.Errors).\n- `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit.\n- `INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a `userId` from this API). This error will also be returned if read-only fields are set, or if the `state` field is set to to a value other than `PENDING`.\n- `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student.\n- `ALREADY_EXISTS` if there is already a pending guardian invitation for the student and `invitedEmailAddress` provided, or if the provided `invitedEmailAddress` matches the Google account of an existing `Guardian` for this user.\n\n### HTTP request\n\n`POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------------------------------|-------------------------------------------------|\n| `guardianInvitation.studentId` | `string` ID of the student (in standard format) |\n\n### Request body\n\nThe request body contains an instance of [GuardianInvitation](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitation).\n\n### Response body\n\nIf successful, the response body contains a newly created instance of [GuardianInvitation](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/classroom.guardianlinks.students`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]