Recurso: GuardianInvitation
Um convite para se tornar responsável de um usuário específico, enviado para um endereço de e-mail especificado.
Representação JSON |
---|
{
"studentId": string,
"invitationId": string,
"invitedEmailAddress": string,
"state": enum ( |
Campos | |
---|---|
studentId |
Documento de identificação do estudante (no formato padrão) |
invitationId |
Identificador exclusivo do convite. Somente leitura. |
invitedEmailAddress |
Endereço de e-mail para o qual o convite foi enviado. Esse campo só é visível para administradores de domínio. |
state |
O estado em que este convite se encontra. |
creationTime |
A hora em que este convite foi criado. Somente leitura. Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: |
GuardianInvitationState
Estado de um convite de responsável.
Enums | |
---|---|
GUARDIAN_INVITATION_STATE_UNSPECIFIED |
Nunca deve ser retornado. |
PENDING |
O convite está ativo e aguardando uma resposta. |
COMPLETE |
O convite não está mais ativo. Ela pode ter sido aceita, recusada, retirada ou expirou. |
Métodos |
|
---|---|
|
Cria um convite para o responsável e envia um e-mail para o responsável solicitando a confirmação de identidade do responsável. |
|
Retorna o convite de um responsável específico. |
|
Retorna uma lista de convites para os responsáveis que o usuário solicitante tem permissão para ver, filtrados pelos parâmetros fornecidos. |
|
Modifica um convite de responsável. |