Method: userProfiles.guardians.delete

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.