Users - Contacts - Delegates

API documentation
Notes
Definitions
Create contact delegates
Delete contact delegates
Display contact delegates

API documentation

Contact Delegation API

Notes

Contact delegation must be enabled, see the following:

Definitions

<UserTypeEntity>

<DomainName> ::= <String>(.<String>)+
<EmailAddress> ::= <String>@<DomainName>
<UniqueID> ::= id:<String>
<UserItem> ::= <EmailAddress>|<UniqueID>|<String>
<UserList> ::= "<UserItem>(,<UserItem>)*"
<UserEntity> ::=
        <UserList> | <FileSelector> | <CSVkmdSelector> | <CSVDataSelector>
        See: https://github.com/GAM-team/GAM/wiki/Collections-of-Users

Create contact delegates

gam <UserTypeEntity> create|add contactdelegate <UserEntity>

Delete contact delegates

gam <UserTypeEntity> delete|del contactdelegate <UserEntity>

Display contact delegates

gam <UserTypeEntity> show contactdelegates [shownames] [csv]
gam <UserTypeEntity> print contactdelegates [todrive <ToDriveAttribute>*] [shownames]

By default, delegate names are not displayed; use the shownames option to display the delegates name. This involves an extra API call per delegate email address.

By default, show delegates displays indented keys and values; use the csv option to have just the values shown as a comma separated list.

1.8 KiB Raw Permalink Blame History