Method: userProfiles.guardianInvitations.patch
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Modifie une invitation à un représentant légal.
Actuellement, la seule modification valide consiste à remplacer PENDING par COMPLETE dans state. L'invitation est alors annulée.
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 les représentants légaux ne sont pas activés pour le domaine en question ou en cas d'autres erreurs d'accès.FAILED_PRECONDITION si le lien de représentant légal n'est pas à l'état PENDING.INVALID_ARGUMENT 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), ou si le GuardianInvitation transmis possède un state autre que COMPLETE, ou s'il modifie des champs autres que state.NOT_FOUND si le numéro d'élève fourni est valide, mais que Classroom ne dispose d'aucune information sur cet élève, ou si le champ id ne fait pas référence à une invitation de responsable parental connue de Classroom.
Requête HTTP
PATCH https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
| Paramètres |
studentId |
string
ID de l'élève dont l'invitation au représentant légal doit être modifiée.
|
invitationId |
string
Champ id de GuardianInvitation à modifier.
|
Paramètres de requête
| Paramètres |
updateMask |
string (FieldMask format)
Masque qui identifie les champs du cours à mettre à jour. Ce champ est obligatoire pour effectuer une mise à jour. La mise à jour échoue si des champs non valides sont spécifiés. Les champs suivants sont valides:
Lorsqu'il est défini dans un paramètre de requête, ce champ doit être spécifié comme updateMask=<field1>,<field2>,...
Il s'agit d'une liste de noms de champs complets séparés par une virgule. Exemple : "user.displayName,photo"
|
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 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.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nModifies a guardian invitation.\n\nCurrently, the only valid modification is to change the `state` from `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other [access errors](/workspace/classroom/reference/Access.Errors).\n- `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state.\n- `INVALID_ARGUMENT` if the format of the student ID provided cannot be recognized (it is not an email address, nor a `userId` from this API), or if the passed `GuardianInvitation` has a `state` other than `COMPLETE`, or if it modifies fields other than `state`.\n- `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the `id` field does not refer to a guardian invitation known to Classroom.\n\n### HTTP request\n\n`PATCH https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------------|-----------------------------------------------------------------------------|\n| `studentId` | `string` The ID of the student whose guardian invitation is to be modified. |\n| `invitationId` | `string` The `id` field of the `GuardianInvitation` to be modified. |\n\n### Query parameters\n\n| Parameters ||\n|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` Mask that identifies which fields on the course to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields are valid: - `state` When set in a query parameter, this field should be specified as `updateMask=\u003cfield1\u003e,\u003cfield2\u003e,...` This is a comma-separated list of fully qualified names of fields. Example: `\"user.displayName,photo\"`. |\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 an 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)."]]
