Method: users.aliases.insert

Adds an alias.

HTTP request

POST https://admin.googleapis.com/admin/directory/v1/users/{userKey}/aliases

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.

Request body

The request body contains an instance of UserAlias.

Response body

If successful, the response body contains a newly created instance of UserAlias.

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.