Method: userProfiles.checkUserCapability

Возвращает, может ли пользователь использовать указанную возможность Classroom. Например, эту конечную точку можно использовать для проверки того, может ли пользователь создавать вложения-надстройки.

Пользователь, отправивший запрос, может проверить возможности только для себя.

Этот метод возвращает следующие коды ошибок:

  • PERMISSION_DENIED если запрашивающему пользователю не разрешено проверять правомерность указанного пользователя.
  • INVALID_ARGUMENT , если запрос неверен.

HTTP-запрос

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

URL использует синтаксис перекодировки gRPC .

Параметры пути

Параметры
userId

string

Обязательно. Идентификатор пользователя.

При указании в качестве параметра запроса этот идентификатор может быть одним из следующих:

  • числовой идентификатор пользователя
  • адрес электронной почты пользователя
  • строковый литерал "me" , указывающий на запрашивающего пользователя

Параметры запроса

Параметры
capability

enum ( Capability )

Обязательно. Возможность, которую следует проверить для этого пользователя. Например, чтобы проверить, может ли пользователь создавать дополнения , установите значение CREATE_ADD_ON_ATTACHMENT .

previewVersion

enum ( PreviewVersion )

Необязательно. Предварительная версия API.

Текст запроса

Тело запроса должно быть пустым.

Тело ответа

Ответ на проверку возможностей пользователя.

В случае успеха тело ответа содержит данные со следующей структурой:

JSON-представление 
{
  "capability": enum (Capability),
  "allowed": boolean
}
Поля
capability

enum ( Capability )

Возможности класса.

allowed

boolean

Разрешена ли указанная возможность для пользователя.

Области авторизации

Требуется одна из следующих областей OAuth:

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

Более подробную информацию смотрите в Руководстве по авторизации .

Возможность

Перечисление для представления возможности.

Перечисления
CAPABILITY_UNSPECIFIED Не поддерживается.
CREATE_ADD_ON_ATTACHMENT Возможность создания и изменения AddOnAttachments, связанных с проектом консоли разработчика идентификатора клиента OAuth, используемого для выполнения запроса.
CREATE_RUBRIC Возможность создания и изменения рубрик.
UPDATE_GRADING_PERIOD_SETTINGS Возможность изменения настроек периода оценки.
CREATE_STUDENT_GROUP Возможность создавать и изменять студенческие группы и их участников.