Method: userProfiles.checkUserCapability
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Indique si un utilisateur peut utiliser la fonctionnalité Classroom spécifiée. Par exemple, ce point de terminaison peut être utilisé pour vérifier si un utilisateur peut créer des pièces jointes de modules complémentaires.Un utilisateur qui envoie une demande ne peut vérifier les fonctionnalités que pour lui-même.
Cette méthode renvoie les codes d'erreur suivants :
PERMISSION_DENIED si l'utilisateur qui envoie la demande n'est pas autorisé à vérifier l'éligibilité de l'utilisateur spécifié.INVALID_ARGUMENT si la requête est mal formulée.
Requête HTTP
GET https://classroom.googleapis.com/v1/userProfiles/{userId}:checkUserCapability
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
| Paramètres |
userId |
string
Obligatoire. Identifiant de l'utilisateur. Lorsqu'il est spécifié en tant que paramètre d'une requête, cet identifiant peut être l'un des suivants :
- Identifiant numérique de l'utilisateur
- l'adresse e-mail de l'utilisateur ;
- le littéral de chaîne
"me", indiquant l'utilisateur demandeur.
|
Paramètres de requête
| Paramètres |
capability |
enum (Capability)
Obligatoire. Capacité à vérifier pour cet utilisateur. Par exemple, pour vérifier si un utilisateur peut créer une pièce jointe de module complémentaire, définissez cette valeur sur CREATE_ADD_ON_ATTACHMENT.
|
previewVersion |
enum (PreviewVersion)
Facultatif. Version preview de l'API.
|
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Réponse de la vérification des capacités de l'utilisateur.
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
| Représentation JSON |
{
"capability": enum (Capability),
"allowed": boolean
} |
| Champs |
capability |
enum (Capability)
La fonctionnalité Classroom.
|
allowed |
boolean
Indique si la fonctionnalité spécifiée est autorisée pour l'utilisateur.
|
Champs d'application des autorisations
Nécessite l'un des champs d'application OAuth suivants :
https://www.googleapis.com/auth/classroom.courses
https://www.googleapis.com/auth/classroom.courses.readonly
Pour en savoir plus, consultez le guide d'autorisation.
Capacité
Énumération représentant la fonctionnalité.
| Enums |
CAPABILITY_UNSPECIFIED |
Non compatible. |
CREATE_ADD_ON_ATTACHMENT |
La possibilité de créer et de modifier des AddOnAttachments associés au projet de la console Développeur de l'ID client OAuth utilisé pour effectuer la requête. |
CREATE_RUBRIC |
Possibilité de créer et de modifier des rubriques. |
UPDATE_GRADING_PERIOD_SETTINGS |
Possibilité de modifier les paramètres des périodes de notation. |
CREATE_STUDENT_GROUP |
La possibilité de créer et de modifier des groupes d'élèves et leurs membres. |
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/08/06 (UTC).
[null,null,["Dernière mise à jour le 2025/08/06 (UTC)."],[],[],null,["# Method: userProfiles.checkUserCapability\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.CheckUserCapabilityResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Capability](#Capability)\n\n\u003cbr /\u003e\n\n| **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features. This feature is available in [V1_20240930_PREVIEW](https://developers.google.com/workspace/classroom/reference/rest/v1/PreviewVersion) and later. See [Access Preview APIs](https://developers.google.com/workspace/classroom/reference/preview) to learn more.\nReturns whether a user may use the specified Classroom capability. For example, this endpoint can be used to check whether a user may create add- on attachments.\n\n\u003cbr /\u003e\n\nA requesting user can only check capabilities for themselves.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the requesting user is not permitted to check eligibility for the specified user.\n- `INVALID_ARGUMENT` if the request is malformed.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/userProfiles/{userId}:checkUserCapability`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `userId` | `string` Required. Identifier of the user. When specified as a parameter of a request, this identifier can be 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\n### Query parameters\n\n| Parameters ||\n|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `capability` | `enum (`[Capability](/workspace/classroom/reference/rest/v1/userProfiles/checkUserCapability#Capability)`)` Required. The Capability that should be checked for this user. For example, to check whether a user can create an [add-on attachment](https://developers.google.com/workspace/classroom/reference/rest/v1/courses.courseWork.addOnAttachments#resource:-addonattachment), set this to `CREATE_ADD_ON_ATTACHMENT`. |\n| `previewVersion` | `enum (`[PreviewVersion](/workspace/classroom/reference/rest/v1/PreviewVersion)`)` Optional. The preview version of the API. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse from checking user capabilities.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"capability\": enum (/workspace/classroom/reference/rest/v1/userProfiles/checkUserCapability#Capability), \"allowed\": boolean } ``` |\n\n| Fields ||\n|--------------|---------------------------------------------------------------------------------------------------------------------------------------|\n| `capability` | `enum (`[Capability](/workspace/classroom/reference/rest/v1/userProfiles/checkUserCapability#Capability)`)` The Classroom capability. |\n| `allowed` | `boolean` Whether the specified capability is allowed for the user. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/classroom.courses`\n- `\n https://www.googleapis.com/auth/classroom.courses.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nCapability\n----------\n\nEnum to represent the capability.\n\n| Enums ||\n|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `CAPABILITY_UNSPECIFIED` | Not supported. |\n| `CREATE_ADD_ON_ATTACHMENT` | The capability to create and modify AddOnAttachments associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to make the request. |\n| `CREATE_RUBRIC` | The capability to create and modify Rubrics. |\n| `UPDATE_GRADING_PERIOD_SETTINGS` | The capability to modify grading period settings. |\n| `CREATE_STUDENT_GROUP` | The capability to create and modify student groups and their members. |"]]
