Method: userProfiles.guardians.delete
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Supprime un représentant légal.
Le responsable ne recevra plus de notifications et ne sera plus accessible via l'API.
Cette méthode renvoie les codes d'erreur suivants:
PERMISSION_DENIED si aucun utilisateur correspondant au studentId fourni n'est visible par l'utilisateur à l'origine de la requête, si l'utilisateur à l'origine de la requête n'est pas autorisé à gérer les représentants légaux de l'élève identifié par le studentId, 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.INVALID_ARGUMENT si un studentId est spécifié, mais que son format ne peut pas être reconnu (il ne s'agit pas d'une adresse e-mail ni d'un studentId de l'API).NOT_FOUND si l'utilisateur à l'origine de la demande est autorisé à modifier les représentants légaux pour le studentId demandé, mais qu'aucun enregistrement Guardian n'existe pour cet élève avec le guardianId fourni.
Requête HTTP
DELETE https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians/{guardianId}
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
| Paramètres |
studentId |
string
L'élève dont le représentant légal doit être supprimé. Choisissez l'une des options suivantes :
- Identifiant numérique de l'utilisateur
- l'adresse e-mail de l'utilisateur ;
- le littéral de chaîne
"me", qui indique l'utilisateur à l'origine de la requête
|
guardianId |
string
Champ id d'un Guardian.
|
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Si la requête aboutit, le corps de la réponse est un objet JSON vide.
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.guardians.delete\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\nDeletes a guardian.\n\nThe guardian will no longer receive guardian notifications and the guardian will no longer be accessible via the API.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if no user that matches the provided `studentId` is visible to the requesting user, if the requesting user is not permitted to manage guardians for the student identified by the `studentId`, if guardians are not enabled for the domain in question, or for other [access errors](/workspace/classroom/reference/Access.Errors).\n- `INVALID_ARGUMENT` if a `studentId` is specified, but its format cannot be recognized (it is not an email address, nor a `studentId` from the API).\n- `NOT_FOUND` if the requesting user is permitted to modify guardians for the requested `studentId`, but no `Guardian` record exists for that student with the provided `guardianId`.\n\n### HTTP request\n\n`DELETE https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians/{guardianId}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `studentId` | `string` The student whose guardian is to be deleted. One of the following: - the numeric identifier for the user - the email address of the user - the string literal `\"me\"`, indicating the requesting user |\n| `guardianId` | `string` The `id` field from a `Guardian`. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body is an empty JSON object.\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)."]]
