Method: userProfiles.guardianInvitations.create
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Crea un invito al tutore e invia un'email al tutore chiedendo di confermare di essere il tutore dello studente.
Una volta accettato l'invito, il suo state diventerà COMPLETED e inizierà a ricevere notifiche per i tutori. Verrà inoltre creata una risorsa Guardian per rappresentare il tutore attivo.
L'oggetto request deve avere i campi studentId e invitedEmailAddress impostati. La mancata impostazione di questi campi o l'impostazione di altri campi nella richiesta comporterà un errore.
Questo metodo restituisce i seguenti codici di errore:
PERMISSION_DENIED se l'utente corrente non dispone dell'autorizzazione per gestire i tutori, se il tutore in questione ha già rifiutato troppe richieste per lo studente, se i tutori non sono abilitati per il dominio in questione o per altri errori di accesso.RESOURCE_EXHAUSTED se lo studente o il tutore ha superato il limite di collegamento dei tutori.INVALID_ARGUMENT se l'indirizzo email del tutore non è valido (ad esempio se è troppo lungo) o se non è possibile riconoscere il formato dell'ID studente fornito (non è un indirizzo email né un userId di questa API). Questo errore viene restituito anche se sono impostati campi di sola lettura o se il campo state è impostato su un valore diverso da PENDING.NOT_FOUND se l'ID studente fornito è valido, ma Classroom non ha dati su questo studente.ALREADY_EXISTS se esiste già un invito al tutore in attesa per lo studente e per il invitedEmailAddress fornito oppure se il invitedEmailAddress fornito corrisponde all'Account Google di un Guardian esistente per questo utente.
Richiesta HTTP
POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
L'URL utilizza la sintassi di transcodifica gRPC.
Parametri del percorso
| Parametri |
guardianInvitation.studentId |
string
ID dello studente (in formato standard)
|
Corpo della richiesta
Il corpo della richiesta contiene un'istanza di GuardianInvitation.
Corpo della risposta
In caso di esito positivo, il corpo della risposta contiene un'istanza di GuardianInvitation appena creata.
Ambiti di autorizzazione
Richiede il seguente ambito OAuth:
https://www.googleapis.com/auth/classroom.guardianlinks.students
Per ulteriori informazioni, consulta la Guida all'autorizzazione.
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2025-07-25 UTC.
[null,null,["Ultimo aggiornamento 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)."]]
