Method: userProfiles.checkUserCapability

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

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

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

  • 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

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

Возможность

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

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