Method: domainAliases.list
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
רשימת כינויי הדומיינים של הלקוח.
בקשת HTTP
GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/domainaliases
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של נתיב
פרמטרים |
customer |
string
המזהה הייחודי של חשבון Google Workspace של הלקוח. בחשבון עם כמה דומיינים, כדי לאחזר את כל הקבוצות של לקוח, משתמשים בשדה הזה במקום ב-domain . אפשר גם להשתמש בכתובת החלופית my_customer כדי לייצג את customerId של החשבון. הערך customerId מוחזר גם כחלק מהמשאב Users. חובה לספק את הפרמטר customer או את הפרמטר domain .
|
פרמטרים של שאילתה
פרמטרים |
parentDomainName |
string
שם הדומיין ההורה שעבורו צריך לאחזר כתובות אימייל חלופיות של דומיינים.
|
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:
ייצוג ב-JSON |
{
"kind": string,
"etag": string,
"domainAliases": [
{
object (DomainAlias )
}
]
} |
שדות |
kind |
string
סוג המשאב.
|
etag |
string
ה-ETag של המשאב.
|
domainAliases[] |
object (DomainAlias )
רשימה של אובייקטים של דומיינים חלופיים.
|
היקפי הרשאה
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/admin.directory.domain
https://www.googleapis.com/auth/admin.directory.domain.readonly
מידע נוסף זמין במדריך ההרשאות.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-25 (שעון UTC)."],[],[],null,["# Method: domainAliases.list\n\nLists the domain aliases of the customer.\n\n### HTTP request\n\n`GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/domainaliases`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. |\n\n### Query parameters\n\n| Parameters ||\n|--------------------|--------------------------------------------------------------------------------|\n| `parentDomainName` | `string` Name of the parent domain for which domain aliases are to be fetched. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"etag\": string, \"domainAliases\": [ { object (/workspace/admin/directory/reference/rest/v1/domainAliases#DomainAlias) } ] } ``` |\n\n| Fields ||\n|-------------------|------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Kind of resource this is. |\n| `etag` | `string` ETag of the resource. |\n| `domainAliases[]` | `object (`[DomainAlias](/workspace/admin/directory/reference/rest/v1/domainAliases#DomainAlias)`)` A list of domain alias objects. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/admin.directory.domain`\n- `\n https://www.googleapis.com/auth/admin.directory.domain.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]