Method: domainAliases.get
Retrieves a domain alias of the customer.
HTTP request
GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
customer |
string
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.
|
domainAliasName |
string
Name of domain alias to be retrieved.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of DomainAlias.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/admin.directory.domain
https://www.googleapis.com/auth/admin.directory.domain.readonly
For more information, see the Authorization guide.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-22 UTC.
[null,null,["Last updated 2024-08-22 UTC."],[[["Retrieves a specific domain alias for a Google Workspace customer using the provided customer ID and domain alias name."],["Request must use the `GET` method and provide `customer` or `domain` and `domainAliasName` as path parameters."],["Requires authorization with either `admin.directory.domain` or `admin.directory.domain.readonly` scope."],["Successful response returns a `DomainAlias` object containing information about the retrieved alias."]]],[]]
