Method: userProfiles.checkUserCapability

Muestra si un usuario puede usar la función de Classroom especificada. Por ejemplo, este extremo se puede usar para verificar si un usuario puede crear archivos adjuntos de complementos.

Un usuario solicitante solo puede verificar las capacidades por su cuenta.

Este método muestra los siguientes códigos de error:

  • PERMISSION_DENIED si el usuario solicitante no tiene permiso para verificar la elegibilidad del usuario especificado.
  • Es INVALID_ARGUMENT si la solicitud no tiene el formato correcto.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
userId

string

Obligatorio. Es el identificador del usuario.

Cuando se especifica como un parámetro de una solicitud, este identificador puede ser uno de los siguientes:

  • el identificador numérico del usuario
  • la dirección de correo electrónico del usuario
  • el literal de cadena "me", que indica el usuario solicitante

Parámetros de consulta

Parámetros
capability

enum (Capability)

Obligatorio. Es la capability que se debe verificar para este usuario. Por ejemplo, para verificar si un usuario puede crear un archivo adjunto de complemento, configúralo como CREATE_ADD_ON_ATTACHMENT.
previewVersion

enum (PreviewVersion)

Opcional. La versión preliminar de la API.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Respuesta de la verificación de las capacidades del usuario.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "capability": enum (Capability),
  "allowed": boolean
}
Campos
capability

enum (Capability)

La función de Classroom
allowed

boolean

Indica si se permite la capability especificada para el usuario.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta la Guía de autorización.

Función

Es una enumeración para representar la capability.

Enumeraciones
CAPABILITY_UNSPECIFIED No compatible.
CREATE_ADD_ON_ATTACHMENT La capacidad de crear y modificar AddOnAttachments asociados con el proyecto de Play Console del ID de cliente de OAuth que se usó para realizar la solicitud
UPDATE_GRADING_PERIOD_SETTINGS La capacidad de modificar la configuración del período de calificación