1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Directory
  7. \
  8. Resource
  9. \
  10. DomainAliases

DomainAliases

class DomainAliases extends Resource (View source)

The "domainAliases" collection of methods.

Typical usage is:

 $adminService = new Google\Service\Directory(...);
 $domainAliases = $adminService->domainAliases;

Methods

delete(string $customer, string $domainAliasName, array $optParams = [])

Deletes a domain Alias of the customer. (domainAliases.delete)

DomainAlias
get(string $customer, string $domainAliasName, array $optParams = [])

Retrieves a domain alias of the customer. (domainAliases.get)

DomainAlias
insert(string $customer, DomainAlias $postBody, array $optParams = [])

Inserts a domain alias of the customer. (domainAliases.insert)

DomainAliases
listDomainAliases(string $customer, array $optParams = [])

Lists the domain aliases of the customer. (domainAliases.listDomainAliases)

Details

at line 41
delete(string $customer, string $domainAliasName, array $optParams = [])

Deletes a domain Alias of the customer. (domainAliases.delete)

Parameters

string $customer

Immutable ID of the Google Workspace account.
string $domainAliasName

Name of domain alias to be retrieved.
array $optParams

Optional parameters.

Exceptions

Exception

at line 62
DomainAlias get(string $customer, string $domainAliasName, array $optParams = [])

Retrieves a domain alias of the customer. (domainAliases.get)

Parameters

string $customer

The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of domain. You can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the Users resource. You must provide either the customer or the domain parameter.
string $domainAliasName

Name of domain alias to be retrieved.
array $optParams

Optional parameters.

Return Value

DomainAlias

Exceptions

Exception

at line 77
DomainAlias insert(string $customer, DomainAlias $postBody, array $optParams = [])

Inserts a domain alias of the customer. (domainAliases.insert)

Parameters

string $customer

Immutable ID of the Google Workspace account.
DomainAlias $postBody
array $optParams

Optional parameters.

Return Value

DomainAlias

Exceptions

Exception

at line 100
DomainAliases listDomainAliases(string $customer, array $optParams = [])

Lists the domain aliases of the customer. (domainAliases.listDomainAliases)

Parameters

string $customer

The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of domain. You can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the Users resource. You must provide either the customer or the domain parameter.
array $optParams

Optional parameters.

Return Value

DomainAliases

Exceptions

Exception