Method: users.aliases.delete
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 2024-08-22 UTC.
[null,null,["Last updated 2024-08-22 UTC."],[[["Permanently deletes a specified email alias for a user."],["Requires providing the user's identifier (email address or ID) and the specific alias to remove in the request URL."],["Uses an HTTP DELETE request with an empty body, complying with gRPC Transcoding syntax."],["Needs appropriate authorization with specific OAuth scopes related to directory user and alias management."],["A successful operation results in a standard HTTP response confirming the alias removal."]]],["This document outlines how to remove a user alias via an API. The `DELETE` request targets a specific user using `userKey` (primary email, alias, or ID) and the `alias` to be removed. The request body must be empty. A successful request returns a generic HTTP response. Authorization requires one of three specified OAuth scopes related to user or alias management. The API URL structure utilizes gRPC Transcoding syntax.\n"]]
