Method: userProfiles.checkUserCapability

Zwraca informację, czy użytkownik może korzystać z określonej funkcji Classroom. Możesz na przykład użyć tego punktu końcowego, aby sprawdzić, czy użytkownik może tworzyć załączniki dodatków.

Użytkownik wysyłający prośbę może sprawdzić uprawnienia tylko dla siebie.

Ta metoda zwraca te kody błędów:

  • PERMISSION_DENIED jeśli użytkownik wysyłający żądanie nie ma uprawnień do sprawdzania uprawnień określonego użytkownika.
  • INVALID_ARGUMENT, jeśli żądanie jest nieprawidłowo sformatowane.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
userId

string

Wymagany. Identyfikator użytkownika.

Jeśli ten identyfikator jest określony jako parametr żądania, może mieć jedną z tych wartości:

  • identyfikator numeryczny użytkownika;
  • adres e-mail użytkownika;
  • ciąg literału "me", który wskazuje użytkownika wysyłającego żądanie;

Parametry zapytania

Parametry
capability

enum (Capability)

Wymagany. Funkcja, która powinna być sprawdzana w przypadku tego użytkownika. Aby na przykład sprawdzić, czy użytkownik może utworzyć załącznik dodatku, ustaw tę wartość na CREATE_ADD_ON_ATTACHMENT.
previewVersion

enum (PreviewVersion)

Opcjonalnie. Wersja przedpremierowa interfejsu API.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź z sprawdzania uprawnień użytkownika.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "capability": enum (Capability),
  "allowed": boolean
}
Pola
capability

enum (Capability)

funkcja Classroom,
allowed

boolean

Określa, czy określona funkcja jest dozwolona dla użytkownika.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.

Możliwości

Wyliczenie reprezentujące uprawnienia.

Wartości w polu enum
CAPABILITY_UNSPECIFIED Nieobsługiwane.
CREATE_ADD_ON_ATTACHMENT Możliwość tworzenia i modyfikowania obiektów AddOnAttachment powiązanych z projektem w Developer Console, w którym znajduje się identyfikator klienta OAuth użyty do wysłania żądania.
CREATE_RUBRIC Możliwość tworzenia i modyfikowania rubryk.
UPDATE_GRADING_PERIOD_SETTINGS możliwość modyfikowania ustawień okresu oceniania;
CREATE_STUDENT_GROUP możliwość tworzenia i modyfikowania grup uczniów oraz ich członków;