Method: userProfiles.checkUserCapability

Retorna se um usuário pode usar o recurso do Google Sala de Aula especificado. Por exemplo, esse endpoint pode ser usado para verificar se um usuário pode criar anexos de complementos.

O usuário solicitante só pode verificar os recursos para si mesmo.

Esse método retorna os seguintes códigos de erro:

  • PERMISSION_DENIED se o usuário solicitante não tiver permissão para verificar a qualificação do usuário especificado.
  • INVALID_ARGUMENT se a solicitação estiver incorreta.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
userId

string

Obrigatório. Identificador do usuário.

Quando especificado como um parâmetro de uma solicitação, esse identificador pode ser um dos seguintes:

  • o identificador numérico do usuário
  • o endereço de e-mail do usuário
  • o literal de string "me", indicando o usuário solicitante

Parâmetros de consulta

Parâmetros
capability

enum (Capability)

Obrigatório. O capability que precisa ser verificado para esse usuário. Por exemplo, para verificar se um usuário pode criar um anexo de complemento, defina como CREATE_ADD_ON_ATTACHMENT.
previewVersion

enum (PreviewVersion)

Opcional. A versão de pré-lançamento da API.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Resposta da verificação de recursos do usuário.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "capability": enum (Capability),
  "allowed": boolean
}
Campos
capability

enum (Capability)

o recurso Sala de Aula;
allowed

boolean

Indica se o recurso especificado é permitido para o usuário.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte o Guia de autorização.

Capacidade

Enum para representar o recurso.

Enums
CAPABILITY_UNSPECIFIED Incompatível.
CREATE_ADD_ON_ATTACHMENT A capacidade de criar e modificar AddOnAttachments associados ao projeto do Developer Console do ID do cliente OAuth usado para fazer a solicitação.
UPDATE_GRADING_PERIOD_SETTINGS A capacidade de modificar as configurações do período de avaliação.