Method: userProfiles.checkUserCapability
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Restituisce un valore che indica se un utente può utilizzare la funzionalità di Classroom specificata. Ad esempio, questo endpoint può essere utilizzato per verificare se un utente può creare allegati di componenti aggiuntivi.Un utente richiedente può controllare le funzionalità solo per se stesso.
Questo metodo restituisce i seguenti codici di errore:
PERMISSION_DENIED se l'utente richiedente non è autorizzato a verificare l'idoneità dell'utente specificato.INVALID_ARGUMENT se la richiesta non è valida.
Richiesta HTTP
GET https://classroom.googleapis.com/v1/userProfiles/{userId}:checkUserCapability
L'URL utilizza la sintassi di transcodifica gRPC.
Parametri del percorso
| Parametri |
userId |
string
Obbligatorio. Identificatore dell'utente. Se specificato come parametro di una richiesta, questo identificatore può essere uno dei seguenti:
- l'identificatore numerico dell'utente
- l'indirizzo email dell'utente
- il valore letterale della stringa
"me", che indica l'utente richiedente
|
Parametri di query
| Parametri |
capability |
enum (Capability)
Obbligatorio. La funzionalità da controllare per questo utente. Ad esempio, per verificare se un utente può creare un allegato del componente aggiuntivo, imposta questo valore su CREATE_ADD_ON_ATTACHMENT.
|
previewVersion |
enum (PreviewVersion)
(Facoltativo) La versione di anteprima dell'API.
|
Corpo della richiesta
Il corpo della richiesta deve essere vuoto.
Corpo della risposta
Risposta alla verifica delle funzionalità dell'utente.
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
| Rappresentazione JSON |
{
"capability": enum (Capability),
"allowed": boolean
} |
| Campi |
capability |
enum (Capability)
La funzionalità Classroom.
|
allowed |
boolean
Indica se la funzionalità specificata è consentita per l'utente.
|
Ambiti di autorizzazione
Richiede uno dei seguenti ambiti OAuth:
https://www.googleapis.com/auth/classroom.courses
https://www.googleapis.com/auth/classroom.courses.readonly
Per ulteriori informazioni, consulta la Guida all'autorizzazione.
Capacità
Enumerazione per rappresentare la funzionalità.
| Enum |
CAPABILITY_UNSPECIFIED |
Non supportati. |
CREATE_ADD_ON_ATTACHMENT |
La possibilità di creare e modificare AddOnAttachments associati al progetto Developer Console dell'ID client OAuth utilizzato per effettuare la richiesta. |
CREATE_RUBRIC |
Possibilità di creare e modificare rubriche. |
UPDATE_GRADING_PERIOD_SETTINGS |
La possibilità di modificare le impostazioni del periodo di valutazione. |
CREATE_STUDENT_GROUP |
La possibilità di creare e modificare i gruppi di studenti e i relativi membri. |
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2025-08-06 UTC.
[null,null,["Ultimo aggiornamento 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. |"]]
