REST Resource: invitations
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Recurso: convite
Um convite para participar de um curso.
| Representação JSON |
{
"id": string,
"userId": string,
"courseId": string,
"role": enum (CourseRole)
} |
| Campos |
id |
string
Identificador atribuído pelo Google Sala de Aula. Somente leitura.
|
userId |
string
Identificador do usuário convidado. Quando especificado como um parâmetro de uma solicitação, esse identificador pode ser definido como uma das seguintes opções:
- o identificador numérico do usuário
- o endereço de e-mail do usuário
- o literal de string
"me", indicando o usuário solicitante
|
courseId |
string
Identificador do curso para convidar o usuário.
|
role |
enum (CourseRole)
Função que você quer convidar o usuário a ter. Não pode ser COURSE_ROLE_UNSPECIFIED.
|
CourseRole
Possíveis funções que um usuário pode receber.
| Enums |
COURSE_ROLE_UNSPECIFIED |
Sem função no curso. |
STUDENT |
Aluno do curso. |
TEACHER |
Professor do curso. |
OWNER |
Proprietário do curso. |
Métodos |
|
|
Aceita um convite, removendo-o e adicionando o usuário convidado aos professores ou estudantes (conforme apropriado) do curso especificado. |
|
|
Cria um convite. |
|
|
Exclui um convite. |
|
|
Retorna um convite. |
|
|
Retorna uma lista de convites que o usuário solicitante tem permissão para visualizar, restrita aos que correspondem à solicitação de lista. |
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 2025-07-25 UTC."],[],[],null,["# REST Resource: invitations\n\n- [Resource: Invitation](#Invitation)\n - [JSON representation](#Invitation.SCHEMA_REPRESENTATION)\n- [CourseRole](#CourseRole)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Invitation\n--------------------\n\nAn invitation to join a course.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"userId\": string, \"courseId\": string, \"role\": enum (/workspace/classroom/reference/rest/v1/invitations#CourseRole) } ``` |\n\n| Fields ||\n|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` Identifier assigned by Classroom. Read-only. |\n| `userId` | `string` Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: - the numeric identifier for the user - the email address of the user - the string literal `\"me\"`, indicating the requesting user |\n| `courseId` | `string` Identifier of the course to invite the user to. |\n| `role` | `enum (`[CourseRole](/workspace/classroom/reference/rest/v1/invitations#CourseRole)`)` Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`. |\n\nCourseRole\n----------\n\nPossible roles a user may be invite to have.\n\n| Enums ||\n|---------------------------|------------------------|\n| `COURSE_ROLE_UNSPECIFIED` | No course role. |\n| `STUDENT` | Student in the course. |\n| `TEACHER` | Teacher of the course. |\n| `OWNER` | Owner of the course. |\n\n| Methods ------- ||\n|-------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|\n| ### [accept](/workspace/classroom/reference/rest/v1/invitations/accept) | Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. |\n| ### [create](/workspace/classroom/reference/rest/v1/invitations/create) | Creates an invitation. |\n| ### [delete](/workspace/classroom/reference/rest/v1/invitations/delete) | Deletes an invitation. |\n| ### [get](/workspace/classroom/reference/rest/v1/invitations/get) | Returns an invitation. |\n| ### [list](/workspace/classroom/reference/rest/v1/invitations/list) | Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. |"]]
