Method: domains.list
Lists the domains of the customer.
HTTP request
GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/domains
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.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
| JSON representation |
{
"kind": string,
"etag": string,
"domains": [
{
object (Domain)
}
]
} |
| Fields |
kind |
string
Kind of resource this is.
|
etag |
string
ETag of the resource.
|
domains[] |
object (Domain)
A list of domain objects.
|
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 list of domains associated with a specific Google Workspace customer account."],["Requires providing either the `customer` or `domain` parameter in the request URL to identify the target account."],["The response includes details such as the kind of resource, ETag, and an array of domain objects containing information about each domain."],["Requires specific authorization scopes, either `admin.directory.domain` or `admin.directory.domain.readonly`, for access."]]],["This document details how to retrieve a customer's domain list via an HTTP GET request to `https://admin.googleapis.com/admin/directory/v1/customer/{customer}/domains`. The request requires a `customer` ID or the `my_customer` alias. The response includes `kind`, `etag`, and a list of domain objects. Authorization requires either `admin.directory.domain` or `admin.directory.domain.readonly` OAuth scopes. The request body must be empty.\n"]]
