aliases

Creates, updates, deletes, gets or lists an aliases resource.

Overview

Name	aliases
Type	Resource
Id	googleadmin.directory.aliases

Fields

The following fields are returned by SELECT queries:

list

Successful response

Name	Datatype	Description
aliases	array
etag	string
kind	string	(default: admin#directory#aliases)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	userKey	event	Lists all aliases for a user.
insert	insert	userKey		Adds an alias.
delete	delete	userKey, alias		Removes an alias.
watch	exec	userKey	event	Watches for changes in users list.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
alias	string
userKey	string
event	string

SELECT examples

list

Lists all aliases for a user.

SELECT
aliases,
etag,
kind
FROM googleadmin.directory.aliases
WHERE userKey = '{{ userKey }}' -- required
AND event = '{{ event }}';

INSERT examples

insert

Adds an alias.

INSERT INTO googleadmin.directory.aliases (
data__alias,
data__etag,
data__id,
data__kind,
data__primaryEmail,
userKey
)
SELECT 
'{{ alias }}',
'{{ etag }}',
'{{ id }}',
'{{ kind }}',
'{{ primaryEmail }}',
'{{ userKey }}'
RETURNING
id,
alias,
etag,
kind,
primaryEmail
;

Manifest

# Description fields are for documentation purposes
- name: aliases
  props:
    - name: userKey
      value: string
      description: Required parameter for the aliases resource.
    - name: alias
      value: string
    - name: etag
      value: string
    - name: id
      value: string
    - name: kind
      value: string
      default: admin#directory#alias
    - name: primaryEmail
      value: string

DELETE examples

delete

Removes an alias.

DELETE FROM googleadmin.directory.aliases
WHERE userKey = '{{ userKey }}' --required
AND alias = '{{ alias }}' --required;

Lifecycle Methods

watch

Watches for changes in users list.

EXEC googleadmin.directory.aliases.watch 
@userKey='{{ userKey }}' --required, 
@event='{{ event }}' 
@@json=
'{
"id": "{{ id }}", 
"token": "{{ token }}", 
"expiration": "{{ expiration }}", 
"type": "{{ type }}", 
"address": "{{ address }}", 
"payload": {{ payload }}, 
"params": "{{ params }}", 
"resourceId": "{{ resourceId }}", 
"resourceUri": "{{ resourceUri }}", 
"kind": "{{ kind }}"
}';