Los complementos de Google Classroom ya están en fase de disponibilidad general para desarrolladores. Consulta la
documentación sobre complementos para obtener más información.
Method: userProfiles.checkUserCapability
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Devuelve si un usuario puede usar la capacidad 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 sus propias capacidades.
Este método devuelve los siguientes códigos de error:
PERMISSION_DENIED si el usuario solicitante no tiene permiso para verificar la elegibilidad del usuario especificadoINVALID_ARGUMENT si la solicitud tiene un formato incorrecto
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
Es obligatorio. Es el identificador del usuario. Cuando se especifica como parámetro de una solicitud, este identificador puede ser uno de los siguientes:
- 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)
Es obligatorio. Es la capacidad que se debe verificar para este usuario. Por ejemplo, para verificar si un usuario puede crear un adjunto de complemento, establece este valor en CREATE_ADD_ON_ATTACHMENT.
|
previewVersion |
enum (PreviewVersion)
Opcional. Es la versión preliminar de la API.
|
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Es la 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 capacidad de Classroom
|
allowed |
boolean
Indica si la capacidad especificada está permitida para el usuario.
|
Permisos 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 que representa la capacidad.
| Enumeraciones |
CAPABILITY_UNSPECIFIED |
No compatible. |
CREATE_ADD_ON_ATTACHMENT |
Capacidad para crear y modificar AddOnAttachments asociados con el proyecto de Developer Console del ID de cliente de OAuth que se usó para realizar la solicitud. |
CREATE_RUBRIC |
Capacidad para crear y modificar rúbricas |
UPDATE_GRADING_PERIOD_SETTINGS |
Capacidad para modificar la configuración del período de calificación |
CREATE_STUDENT_GROUP |
Capacidad para crear y modificar grupos de estudiantes y sus miembros |
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-08-06 (UTC)
[null,null,["Última actualización: 2025-08-06 (UTC)"],[],[],null,["# Method: userProfiles.checkUserCapability\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.CheckUserCapabilityResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Capability](#Capability)\n\n\u003cbr /\u003e\n\n| **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features. This feature is available in [V1_20240930_PREVIEW](https://developers.google.com/workspace/classroom/reference/rest/v1/PreviewVersion) and later. See [Access Preview APIs](https://developers.google.com/workspace/classroom/reference/preview) to learn more.\nReturns whether a user may use the specified Classroom capability. For example, this endpoint can be used to check whether a user may create add- on attachments.\n\n\u003cbr /\u003e\n\nA requesting user can only check capabilities for themselves.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the requesting user is not permitted to check eligibility for the specified user.\n- `INVALID_ARGUMENT` if the request is malformed.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/userProfiles/{userId}:checkUserCapability`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `userId` | `string` Required. Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: - the numeric identifier for the user - the email address of the user - the string literal `\"me\"`, indicating the requesting user |\n\n### Query parameters\n\n| Parameters ||\n|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `capability` | `enum (`[Capability](/workspace/classroom/reference/rest/v1/userProfiles/checkUserCapability#Capability)`)` Required. The Capability that should be checked for this user. For example, to check whether a user can create an [add-on attachment](https://developers.google.com/workspace/classroom/reference/rest/v1/courses.courseWork.addOnAttachments#resource:-addonattachment), set this to `CREATE_ADD_ON_ATTACHMENT`. |\n| `previewVersion` | `enum (`[PreviewVersion](/workspace/classroom/reference/rest/v1/PreviewVersion)`)` Optional. The preview version of the API. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse from checking user capabilities.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"capability\": enum (/workspace/classroom/reference/rest/v1/userProfiles/checkUserCapability#Capability), \"allowed\": boolean } ``` |\n\n| Fields ||\n|--------------|---------------------------------------------------------------------------------------------------------------------------------------|\n| `capability` | `enum (`[Capability](/workspace/classroom/reference/rest/v1/userProfiles/checkUserCapability#Capability)`)` The Classroom capability. |\n| `allowed` | `boolean` Whether the specified capability is allowed for the user. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/classroom.courses`\n- `\n https://www.googleapis.com/auth/classroom.courses.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nCapability\n----------\n\nEnum to represent the capability.\n\n| Enums ||\n|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `CAPABILITY_UNSPECIFIED` | Not supported. |\n| `CREATE_ADD_ON_ATTACHMENT` | The capability to create and modify AddOnAttachments associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to make the request. |\n| `CREATE_RUBRIC` | The capability to create and modify Rubrics. |\n| `UPDATE_GRADING_PERIOD_SETTINGS` | The capability to modify grading period settings. |\n| `CREATE_STUDENT_GROUP` | The capability to create and modify student groups and their members. |"]]
