Method: users.aliases.delete
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
DELETE https://admin.googleapis.com/admin/directory/v1/users/{userKey}/aliases/{alias}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
userKey |
string
Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.
|
alias |
string
The alias to be removed.
|
Request body
The request body must be empty.
Response body
If successful, the response is a generic HTTP response whose format is defined by the method.
Authorization scopes
Requires one of the following OAuth scopes:
https://apps-apis.google.com/a/feeds/alias/
https://www.googleapis.com/auth/admin.directory.user
https://www.googleapis.com/auth/admin.directory.user.alias
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-03-25 UTC.
[null,null,["Last updated 2025-03-25 UTC."],[],[],null,["# Method: users.aliases.delete\n\nRemoves an alias.\n\n### HTTP request\n\n`DELETE https://admin.googleapis.com/admin/directory/v1/users/{userKey}/aliases/{alias}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-----------|---------------------------------------------------------------------------------------------------------------------------------------------|\n| `userKey` | `string` Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. |\n| `alias` | `string` The alias to be removed. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response is a generic HTTP response whose format is defined by the method.\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://apps-apis.google.com/a/feeds/alias/`\n- `\n https://www.googleapis.com/auth/admin.directory.user`\n- `\n https://www.googleapis.com/auth/admin.directory.user.alias`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
