REST Resource: invitations
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Ressource: Invitation
Invitation à rejoindre un cours
| Représentation JSON |
{
"id": string,
"userId": string,
"courseId": string,
"role": enum (CourseRole)
} |
| Champs |
id |
string
Identifiant attribué par Classroom. Lecture seule.
|
userId |
string
Identifiant de l'utilisateur invité. Lorsqu'il est spécifié en tant que paramètre d'une requête, cet identifiant peut être défini sur l'un des éléments suivants:
- Identifiant numérique de l'utilisateur
- l'adresse e-mail de l'utilisateur ;
- le littéral de chaîne
"me", qui indique l'utilisateur à l'origine de la requête
|
courseId |
string
Identifiant du cours auquel inviter l'utilisateur.
|
role |
enum (CourseRole)
Rôle que vous invitez l'utilisateur à occuper. Ne doit pas être COURSE_ROLE_UNSPECIFIED.
|
CourseRole
Rôles possibles qu'un utilisateur peut être invité à occuper.
| Enums |
COURSE_ROLE_UNSPECIFIED |
Aucun rôle dans le cours. |
STUDENT |
Élève participant au cours. |
TEACHER |
Enseignant du cours. |
OWNER |
Propriétaire du cours. |
Méthodes |
|
|
Accepte une invitation, la supprime et ajoute l'utilisateur invité aux enseignants ou aux élèves (selon le cas) du cours spécifié. |
|
|
Crée une invitation. |
|
|
Supprime une invitation. |
|
|
Renvoie une invitation. |
|
|
Affiche la liste des invitations que l'utilisateur à l'origine de la requête est autorisé à consulter, limitées à celles qui correspondent à la requête de liste. |
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 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. |"]]
