Method: domainAliases.list

מפרט את כינויי הדומיין של הלקוח.

בקשת HTTP

GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/domainaliases

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

פרמטרים של נתיב

פרמטרים
customer

string

המזהה הייחודי של חשבון Google Workspace של הלקוח. אם מדובר בחשבון מרובה דומיינים, כדי לאחזר את כל הקבוצות של לקוח מסוים, יש להשתמש בשדה הזה במקום בשדה domain. אפשר גם להשתמש בכינוי my_customer כדי לייצג את customerId של החשבון. הערך customerId גם מוחזר כחלק מהמשאב משתמשים. עליך לספק את הפרמטר 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

למידע נוסף, ניתן לעיין במדריך ההרשאות.