# Admin Directory API . users . aliases

## Instance Methods

Remove a alias for the user

Add a alias for the user

List all aliases for a user

Watch for changes in user aliases list

### Method Details

`delete(userKey, alias)`

    Remove a alias for the user

    Args:
      userKey: string, Email or immutable Id of the user (required)
      alias: string, The alias to be removed (required)

`insert(userKey, body)`

    Add a alias for the user

    Args:
      userKey: string, Email or immutable Id of the user (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # JSON template for Alias object in Directory API.
        "alias": "A String", # A alias email
        "kind": "admin#directory#alias", # Kind of resource this is.
        "etag": "A String", # ETag of the resource.
        "primaryEmail": "A String", # Group's primary email (Read-only) User's primary email (Read-only)
        "id": "A String", # Unique id of the group (Read-only) Unique id of the user (Read-only)
      }

    Returns:
      An object of the form:

        { # JSON template for Alias object in Directory API.
          "alias": "A String", # A alias email
          "kind": "admin#directory#alias", # Kind of resource this is.
          "etag": "A String", # ETag of the resource.
          "primaryEmail": "A String", # Group's primary email (Read-only) User's primary email (Read-only)
          "id": "A String", # Unique id of the group (Read-only) Unique id of the user (Read-only)
        }

`list(userKey, event=None)`

    List all aliases for a user

    Args:
      userKey: string, Email or immutable Id of the user (required)
      event: string, Event on which subscription is intended (if subscribing)
        Allowed values
          add - Alias Created Event
          delete - Alias Deleted Event

    Returns:
      An object of the form:

        { # JSON response template to list aliases in Directory API.
        "kind": "admin#directory#aliases", # Kind of resource this is.
        "etag": "A String", # ETag of the resource.
        "aliases": [ # List of alias objects.
          "",
        ],
      }

`watch(userKey, body, event=None)`

    Watch for changes in user aliases list

    Args:
      userKey: string, Email or immutable Id of the user (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # An notification channel used to watch for resource changes.
        "resourceUri": "A String", # A version-specific identifier for the watched resource.
        "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
        "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
        "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
        "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
        "params": { # Additional parameters controlling delivery channel behavior. Optional.
          "a_key": "A String", # Declares a new parameter by name.
        },
        "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
        "address": "A String", # The address where notifications are delivered for this channel.
        "type": "A String", # The type of delivery mechanism used for this channel.
        "id": "A String", # A UUID or similar unique string that identifies this channel.
      }

      event: string, Event on which subscription is intended (if subscribing)
        Allowed values
          add - Alias Created Event
          delete - Alias Deleted Event

    Returns:
      An object of the form:

        { # An notification channel used to watch for resource changes.
          "resourceUri": "A String", # A version-specific identifier for the watched resource.
          "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
          "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
          "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
          "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
          "params": { # Additional parameters controlling delivery channel behavior. Optional.
            "a_key": "A String", # Declares a new parameter by name.
          },
          "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
          "address": "A String", # The address where notifications are delivered for this channel.
          "type": "A String", # The type of delivery mechanism used for this channel.
          "id": "A String", # A UUID or similar unique string that identifies this channel.
        }