- Solicitud HTTP
- Parámetros de ruta
- Parámetros de consulta
- cuerpo de la solicitud
- Cuerpo de respuesta
- Ámbitos de autorización
- ¡Intentalo!
Devuelve una lista de guardianes que el usuario solicitante puede ver, restringida a aquellos que coinciden con la solicitud.
Para enumerar los tutores de cualquier estudiante cuyos tutores pueda ver el usuario solicitante, use el carácter literal -
para la identificación del estudiante.
Este método devuelve los siguientes códigos de error:
-
PERMISSION_DENIED
si se especifica unstudentId
. de estudiante y el usuario solicitante no tiene permiso para ver la información del tutor de ese estudiante, si se especifica"-"
comostudentId
. de estudiante y el usuario no es un administrador de dominio, si los tutores no están habilitados para el dominio en cuestión , si el filtroinvitedEmailAddress
está configurado por un usuario que no es administrador del dominio, o por otros errores de acceso . -
INVALID_ARGUMENT
si se especifica unstudentId
de estudiante, pero no se puede reconocer su formato (no es una dirección de correo electrónico, ni unstudentId
de estudiante de la API, ni la cadena literalme
). También se puede devolver si se proporciona unpageToken
de página no válido. -
NOT_FOUND
si se especifica unstudentId
de estudiante y se puede reconocer su formato, pero Classroom no tiene registro de ese estudiante.
Solicitud HTTP
GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians
La URL usa la sintaxis de transcodificación de gRPC .
Parámetros de ruta
Parámetros | |
---|---|
studentId | Filtre los resultados por el estudiante al que está vinculado el tutor. El identificador puede ser uno de los siguientes:
|
Parámetros de consulta
Parámetros | |
---|---|
invitedEmailAddress | Filtre los resultados por la dirección de correo electrónico a la que se envió la invitación original, lo que da como resultado este enlace de tutor. Este filtro solo lo pueden usar los administradores de dominio. |
pageToken | La solicitud de |
pageSize | Número máximo de artículos a devolver. Cero o no especificado indica que el servidor puede asignar un máximo. El servidor puede devolver un número de resultados inferior al especificado. |
cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de respuesta
Si tiene éxito, el cuerpo de la respuesta contiene datos con la siguiente estructura:
Respuesta al listar tutores.
Representación JSON |
---|
{
"guardians": [
{
object ( |
Campos | |
---|---|
guardians[] | Tutores en esta página de resultados que cumplieron con los criterios especificados en la solicitud. |
nextPageToken | Token que identifica la siguiente página de resultados a devolver. Si está vacío, no hay más resultados disponibles. |
Ámbitos de autorización
Requiere uno de los siguientes ámbitos de OAuth:
-
https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly
-
https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
-
https://www.googleapis.com/auth/classroom.guardianlinks.students
Para obtener más información, consulte la Descripción general de OAuth 2.0 .