Google Classroom add-ons are now generally available to developers! Please see the
add-ons documentation for more information.
Method: courses.aliases.create
Stay organized with collections
Save and categorize content based on your preferences.
Creates 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).
HTTP request
POST https://classroom.googleapis.com/v1/courses/{courseId}/aliases
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
courseId |
string
Identifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an alias.
|
Request body
The request body contains an instance of CourseAlias.
Response body
If successful, the response body contains a newly created instance of CourseAlias.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/classroom.courses
For more information, see the Authorization guide.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-17 UTC.
[null,null,["Last updated 2025-04-17 UTC."],[],[],null,["# Method: courses.aliases.create\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nCreates an alias for a course.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the requesting user is not permitted to create the alias or for [access errors](/workspace/classroom/reference/Access.Errors).\n- `NOT_FOUND` if the course does not exist.\n- `ALREADY_EXISTS` if the alias already exists.\n- `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).\n\n### HTTP request\n\n`POST https://classroom.googleapis.com/v1/courses/{courseId}/aliases`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `courseId` | `string` Identifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an [alias](/workspace/classroom/reference/rest/v1/courses.aliases#CourseAlias). |\n\n### Request body\n\nThe request body contains an instance of [CourseAlias](/workspace/classroom/reference/rest/v1/courses.aliases#CourseAlias).\n\n### Response body\n\nIf successful, the response body contains a newly created instance of [CourseAlias](/workspace/classroom/reference/rest/v1/courses.aliases#CourseAlias).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/classroom.courses`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
