Method: userProfiles.guardianInvitations.create

Cria um convite para o responsável e envia um e-mail pedindo que ele confirme que é o responsável pelo estudante.

Quando o responsável aceitar o convite, o state vai mudar para COMPLETED, e ele vai começar a receber notificações de responsável. Um recurso Guardian também será criado para representar o responsável ativo.

O objeto de solicitação precisa ter os campos studentId e invitedEmailAddress definidos. A falha na configuração desses campos ou a configuração de outros campos na solicitação resultará em um erro.

Esse método retorna os seguintes códigos de erro:

  • PERMISSION_DENIED se o usuário atual não tiver permissão para gerenciar responsáveis, se o responsável em questão já tiver rejeitado muitas solicitações para esse estudante, se os responsáveis não estiverem ativados para o domínio em questão ou por outros erros de acesso.
  • RESOURCE_EXHAUSTED se o estudante ou responsável tiver excedido o limite de vinculação.
  • INVALID_ARGUMENT se o endereço de e-mail do responsável não for válido (por exemplo, se ele for muito longo) ou se o formato do ID do estudante fornecido não puder ser reconhecido (ele não é um endereço de e-mail nem um userId dessa API). Esse erro também será retornado se campos somente leitura forem definidos ou se o campo state for definido como um valor diferente de PENDING.
  • NOT_FOUND se o ID do estudante fornecido for válido, mas o Google Sala de Aula não tiver registro desse estudante.
  • ALREADY_EXISTS se já houver um convite pendente para o responsável do estudante e o invitedEmailAddress fornecido ou se o invitedEmailAddress fornecido corresponder à Conta do Google de um Guardian existente para esse usuário.

Solicitação HTTP

POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
guardianInvitation.studentId

string

Documento de identificação do estudante (no formato padrão)

Corpo da solicitação

O corpo da solicitação contém uma instância de GuardianInvitation.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta incluirá uma instância de GuardianInvitation.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/classroom.guardianlinks.students

Para mais informações, consulte o guia de autorização.