Method: userProfiles.checkUserCapability

Gibt an, ob ein Nutzer die angegebene Classroom-Funktion verwenden kann. Mit diesem Endpunkt kann beispielsweise geprüft werden, ob ein Nutzer Add-on-Anhänge erstellen darf.

Ein anfragender Nutzer kann die Funktionen nur für sich selbst prüfen.

Diese Methode gibt die folgenden Fehlercodes zurück:

  • PERMISSION_DENIED, wenn der anfragende Nutzer nicht berechtigt ist, die Berechtigung des angegebenen Nutzers zu prüfen.
  • INVALID_ARGUMENT, wenn die Anfrage fehlerhaft ist.

HTTP-Anfrage

GET https://classroom.googleapis.com/v1/userProfiles/{userId}:checkUserCapability

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
userId

string

Erforderlich. Die ID des Nutzers.

Wenn diese ID als Parameter einer Anfrage angegeben wird, kann sie eine der folgenden sein:

  • die numerische Kennung des Nutzers
  • die E-Mail-Adresse des Nutzers
  • das Stringliteral "me", das den anfragenden Nutzer angibt

Abfrageparameter

Parameter
capability

enum (Capability)

Erforderlich. Die Funktion, die für diesen Nutzer geprüft werden soll. Wenn Sie beispielsweise prüfen möchten, ob ein Nutzer einen Add-on-Anhang erstellen kann, legen Sie hier den Wert CREATE_ADD_ON_ATTACHMENT fest.
previewVersion

enum (PreviewVersion)

Optional. Die Vorabversion der API.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwort bei der Überprüfung der Nutzerfunktionen

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "capability": enum (Capability),
  "allowed": boolean
}
Felder
capability

enum (Capability)

Die Classroom-Funktion
allowed

boolean

Gibt an, ob die angegebene Funktion für den Nutzer zulässig ist.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/classroom.courses
  • https://www.googleapis.com/auth/classroom.courses.readonly

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.

Funktion

Enum-Wert, der die Funktion darstellt.

Enums
CAPABILITY_UNSPECIFIED Nicht unterstützt.
CREATE_ADD_ON_ATTACHMENT Die Möglichkeit, AddOnAttachments zu erstellen und zu ändern, die mit dem Developer Console-Projekt der OAuth-Client-ID verknüpft sind, die für die Anfrage verwendet wurde.
UPDATE_GRADING_PERIOD_SETTINGS Die Möglichkeit, die Einstellungen für die Benotungszeiträume zu ändern.