Skip to main content

aliases

Overview

Namealiases
TypeResource
Idgoogleworkspace.classroom.aliases

Fields

NameDatatypeDescription
aliasesarrayThe course aliases.
nextPageTokenstringToken identifying the next page of results to return. If empty, no further results are available.

Methods

NameAccessible byRequired ParamsDescription
courses_aliases_listSELECTcourseIdReturns 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.
courses_aliases_createINSERTcourseIdCreates an alias for a course. This method returns the following error codes: PERMISSION_DENIED if the requesting user is not permitted to create the alias or for access errors. NOT_FOUND if the course does not exist. ALREADY_EXISTS if the alias already exists. FAILED_PRECONDITION if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to access a domain-scoped alias).
courses_aliases_deleteDELETEalias, courseIdDeletes an alias of a course. This method returns the following error codes: PERMISSION_DENIED if the requesting user is not permitted to remove the alias or for access errors. NOT_FOUND if the alias does not exist. * FAILED_PRECONDITION if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to delete a domain-scoped alias).