REST Resource: partners.customers

משאב: חברה

מפיץ, ספק או לקוח בממשק ה-API של מפיץ ולקוח ללא מגע.

ייצוג JSON 
{
  "name": string,
  "companyId": string,
  "companyName": string,
  "ownerEmails": [
    string
  ],
  "adminEmails": [
    string
  ],
  "termsStatus": enum (TermsStatus),
  "skipWelcomeEmail": boolean,
  "languageCode": string,
  "googleWorkspaceAccount": {
    object (GoogleWorkspaceAccount)
  }
}
שדות
name

string

פלט בלבד. שם משאב ה-API של החברה. שם המשאב הוא אחד מהפורמטים הבאים:

  • partners/[PARTNER_ID]/customers/[CUSTOMER_ID]
  • partners/[PARTNER_ID]/vendors/[VENDOR_ID]
  • partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]

הוקצתה על ידי השרת.
companyId

string (int64 format)

פלט בלבד. המזהה של החברה. הוקצתה על ידי השרת.
companyName

string

חובה. שם החברה. לדוגמה, XYZ Corp. מוצג לעובדי החברה בפורטל ההרשמה דרך הארגון.
ownerEmails[]

string

חובה. קלט בלבד. כתובת האימייל של המשתמשים של הלקוח בתפקיד הבעלים. צריך להגדיר לפחות owner_email. למשתמשים תהיה גישה זהה לאדמינים, אבל הם יוכלו גם להוסיף, למחוק ולערוך את משתמשי הפורטל של הארגון.
adminEmails[]

string

אופציונלי. כתובת האימייל של המשתמשים בתפקיד אדמין. כל כתובת אימייל צריכה להיות משויכת לחשבון Google.
termsStatus

enum (TermsStatus)

פלט בלבד. האם משתמש כלשהו מהחברה אישר את התנאים וההגבלות העדכניים. TermsStatus.
skipWelcomeEmail

boolean

קלט בלבד. אם המדיניות מוגדרת כ-True, הלקוח לא יקבל הודעת אימייל בכניסה. מומלץ לדלג על הודעת הפתיחה אם המכשיר ייתבע במסגרת שירות DEVICE_PROTECTION נוסף, כי הלקוח יקבל אימיילים נפרדים בזמן תביעת הבעלות על המכשיר. אם הלקוח הזה הוא לא 'אפס מגע', המערכת תתעלם משדה זה.
languageCode

string

קלט בלבד. האזור המועדף של הלקוח שמיוצג כקוד שפה BCP47. השדה הזה מאומת בעת הקלט ובקשות הכוללות קודי שפה שאינם נתמכים יידחו.

googleWorkspaceAccount

object (GoogleWorkspaceAccount)

פלט בלבד. חשבון Google Workspace שמשויך ללקוח הזה. משמש רק לחברות של לקוחות.

סטטוס התנאים

קבלה של חברה לתנאים ולהגבלות בנושא הרשמה ללא מגע. משתמש יחיד יכול לקבל את התנאים וההגבלות לחברה שלו באמצעות פורטל האינטרנט.

יש תנאים והגבלות. כלומר, כשהתנאים וההגבלות משתנים, לפחות משתמש אחד חייב לאשר את התנאים וההגבלות החדשים. עד שהמשתמש הראשון יאשר את התנאים וההגבלות החדשים, סטטוס התנאים של החברה הוא TERMS_STATUS_STALE.

Enums
TERMS_STATUS_NOT_ACCEPTED אף אחד ממשתמשי החברה לא אישר את התנאים וההגבלות.
TERMS_STATUS_ACCEPTED אחד (או יותר) מהמשתמשים בחברה אישרו את התנאים וההגבלות.
TERMS_STATUS_STALE אף אחד מהמשתמשים של החברה לא אישר את התנאים וההגבלות הנוכחיים, אך לפחות משתמש אחד אישר את התנאים וההגבלות הקודמים.

חשבון Google Workspace

לקוחות של Google Workspace.

ייצוג JSON 
{
  "customerId": string,
  "preProvisioningTokens": [
    string
  ]
}
שדות
customerId

string

חובה. מספר הלקוח.
preProvisioningTokens[]

string

פלט בלבד. אסימוני ההקצאה מראש, ששימשו בעבר לתביעת בעלות על מכשירים.

שיטות

create

 יוצר לקוח להרשמה דרך הארגון.

list

 רשימה של הלקוחות הרשומים למפיץ שזוהה על ידי הארגומנט partnerId.