REST Resource: userProfiles.guardianInvitations
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Risorsa: GuardianInvitation
Un invito a diventare il tutore di un utente specificato, inviato a un indirizzo email specificato.
| Rappresentazione JSON |
{
"studentId": string,
"invitationId": string,
"invitedEmailAddress": string,
"state": enum (GuardianInvitationState),
"creationTime": string
} |
| Campi |
studentId |
string
ID dello studente (in formato standard)
|
invitationId |
string
Identificatore univoco per questo invito. Sola lettura.
|
invitedEmailAddress |
string
L'indirizzo email a cui è stato inviato l'invito. Questo campo è visibile solo agli amministratori di dominio.
|
state |
enum (GuardianInvitationState)
Lo stato dell'invito.
|
creationTime |
string (Timestamp format)
L'ora in cui è stato creato questo invito. Sola lettura. Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
|
GuardianInvitationState
Stato di un invito per un tutore.
| Enum |
GUARDIAN_INVITATION_STATE_UNSPECIFIED |
Non deve mai essere restituito. |
PENDING |
L'invito è attivo e in attesa di una risposta. |
COMPLETE |
L'invito non è più attivo. Potrebbe essere stato accettato, rifiutato, ritirato o essere scaduto. |
Metodi |
|
|
Crea un invito per il tutore e gli invia un'email in cui gli viene chiesto di confermare di essere il tutore dello studente. |
|
|
Restituisce un invito per tutore specifico. |
|
|
Restituisce un elenco di inviti per tutori che l'utente richiedente è autorizzato a visualizzare, filtrati in base ai parametri forniti. |
|
|
Modifica un invito per un tutore. |
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-08-26 UTC.
[null,null,["Ultimo aggiornamento 2025-08-26 UTC."],[],[],null,["- [Resource: GuardianInvitation](#GuardianInvitation)\n - [JSON representation](#GuardianInvitation.SCHEMA_REPRESENTATION)\n- [GuardianInvitationState](#GuardianInvitationState)\n- [Methods](#METHODS_SUMMARY)\n\nResource: GuardianInvitation An invitation to become the guardian of a specified user, sent to a specified email address.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"studentId\": string, \"invitationId\": string, \"invitedEmailAddress\": string, \"state\": enum (/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitationState), \"creationTime\": string } ``` |\n\n| Fields ||\n|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `studentId` | `string` ID of the student (in standard format) |\n| `invitationId` | `string` Unique identifier for this invitation. Read-only. |\n| `invitedEmailAddress` | `string` Email address that the invitation was sent to. This field is only visible to domain administrators. |\n| `state` | `enum (`[GuardianInvitationState](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitationState)`)` The state that this invitation is in. |\n| `creationTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` The time that this invitation was created. Read-only. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`. |\n\nGuardianInvitationState State of a guardian invitation.\n\n| Enums ||\n|-----------------------------------------|------------------------------------------------------------------------------------------------------------|\n| `GUARDIAN_INVITATION_STATE_UNSPECIFIED` | Should never be returned. |\n| `PENDING` | The invitation is active and awaiting a response. |\n| `COMPLETE` | The invitation is no longer active. It may have been accepted, declined, withdrawn or it may have expired. |\n\n| Methods ||\n|------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|\n| [create](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations/create) | Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. |\n| [get](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations/get) | Returns a specific guardian invitation. |\n| [list](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations/list) | Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. |\n| [patch](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations/patch) | Modifies a guardian invitation. |"]]
