- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Returns a list of aliases for a course.
This method returns the following error codes:
PERMISSION_DENIED
if the requesting user is not permitted to access the course or for access errors.NOT_FOUND
if the course does not exist.
HTTP request
GET https://classroom.googleapis.com/v1/courses/{courseId}/aliases
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
courseId |
The identifier of the course. This identifier can be either the Classroom-assigned identifier or an |
Query parameters
Parameters | |
---|---|
pageSize |
Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. |
pageToken |
The |
Request body
The request body must be empty.
Response body
Response when listing course aliases.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"aliases": [
{
object ( |
Fields | |
---|---|
aliases[] |
The course aliases. |
nextPageToken |
Token identifying the next page of results to return. If empty, no further results are available. |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/classroom.courses
https://www.googleapis.com/auth/classroom.courses.readonly
For more information, see the Authorization guide.