Method: userProfiles.checkUserCapability

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.