REST Resource: customers.v2.Users

משאב: משתמש

ייצוג SCIM של משתמש.

ייצוג JSON 
{
  "schemas": [
    string
  ],
  "emails": [
    {
      object (Email)
    }
  ],
  "addresses": [
    {
      object (Address)
    }
  ],
  "phoneNumbers": [
    {
      object (Phone)
    }
  ],
  "groups": [
    {
      object (GroupReference)
    }
  ],
  "id": string,
  "externalId": string,
  "meta": {
    object (Meta)
  },
  "userName": string,
  "name": {
    object (Name)
  },
  "displayName": string,
  "active": boolean,
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    object (EnterpriseUserExtension)
  }
}
שדות
schemas[]

string

חובה. רשימה של URI שמציינים את מרחבי השמות של סכימות SCIM שמגדירות את המאפיינים שמופיעים במבנה ה-JSON הנוכחי. חייב להכיל רק את הערכים schema ו-schemaExtensions עבור User ResourceType.
emails[]

object (Email)

זה שינוי אופציונלי. רשימת כתובות האימייל של המשתמש. הגודל המקסימלי המותר של הנתונים הוא 10KB. כתובת האימייל שמתאימה ל-userName תתווסף אוטומטית לרשימה הזו עם מאפיין המשנה primary שמוגדר לערך true. הערך של כתובת האימייל הראשית הוא לקריאה בלבד ואי אפשר לשנות אותו באמצעות המאפיין הזה.
addresses[]

object (Address)

זה שינוי אופציונלי. רשימת הכתובות הפיזיות של המשתמש. הגודל המקסימלי המותר של הנתונים הוא 10KB.
phoneNumbers[]

object (Phone)

זה שינוי אופציונלי. רשימה של מספרי הטלפון של המשתמש. הגודל המקסימלי המותר של הנתונים הוא 1KB.
groups[]

object (GroupReference)

פלט בלבד. רשימת הקבוצות שהמשתמש חבר בהן באופן ישיר, מקוצרת למקסימום של 1,000 קבוצות.

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

string

מזהה. המזהה הייחודי של המשתמש. מאפייני המאפיין הם caseExact בתור true, יכולת שינוי של readOnly ומאפיין returned של always.
externalId

string

זה שינוי אופציונלי. מזהה שהוגדר על ידי הלקוח עבור משתמש SCIM. השדה הזה תלוי אותיות רישיות וניתן לשינוי. הלקוח אחראי לוודא שהערך הוא ייחודי, כי השרת לא אוכף את זה.
meta

object (Meta)

פלט בלבד. תכונה מורכבת שמכילה מטא-נתונים של משאב. את כל מאפייני המשנה של meta מקצה ספק השירות (ערך mutability של readOnly), ולכל מאפייני המשנה האלה יש מאפיין returned עם ערך default. המערכת מתעלמת מהמאפיין הזה אם הוא מסופק על ידי לקוחות.
userName

string

חובה. כתובת האימייל הראשית של המשתמש. משמש כמזהה הייחודי של המשתמש.
name

object (Name)

חובה. השם של המשתמש.
displayName

string

זה שינוי אופציונלי. השם המוצג של המשתמש. הגבלה: 256 תווים.
active

boolean

זה שינוי אופציונלי. סטטוס החשבון של המשתמש (false מציין שהחשבון מושעה). ברירת מחדל: true.
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

object (EnterpriseUserExtension)

זה שינוי אופציונלי. מאפייני הרחבה של משתמשים בארגון במערכת SCIM.

שם

ייצוג SCIM של שם המשתמש.

ייצוג JSON 
{
  "familyName": string,
  "givenName": string
}
שדות
familyName

string

חובה. שם המשפחה של המשתמש.
givenName

string

חובה. השם הפרטי של המשתמש.

אימייל

ייצוג SCIM של אימייל של משתמש.

ייצוג JSON 
{
  "value": string,
  "type": string,
  "primary": boolean
}
שדות
value

string

חובה. כתובת האימייל של המשתמש.
type

string

סוג חשבון האימייל. הערכים התקפים הם home,‏ work ו-other.
primary

boolean

פלט בלבד. מציין אם זו כתובת האימייל הראשית של המשתמש. הערך הזה מוגדר כ-true רק באימייל שתואם ל-userName.

כתובת

ייצוג SCIM של כתובת משתמש.

ייצוג JSON 
{
  "formatted": string,
  "streetAddress": string,
  "locality": string,
  "region": string,
  "postalCode": string,
  "country": string,
  "type": string,
  "primary": boolean
}
שדות
formatted

string

הכתובת המלאה, בפורמט שמתאים לתצוגה.
streetAddress

string

כתובת הרחוב.
locality

string

העיר או הרשות המקומית.
region

string

האזור או המדינה.
postalCode

string

המיקוד.
country

string

המדינה.
type

string

סוג הכתובת. הערכים התקפים הם home,‏ work ו-other.
primary

boolean

מציין אם זו הכתובת הראשית של המשתמש.

טלפון

ייצוג SCIM של מספר הטלפון של המשתמש.

ייצוג JSON 
{
  "value": string,
  "type": string,
  "primary": boolean
}
שדות
value

string

חובה. מספר הטלפון.
type

string

סוג מספר הטלפון. הערכים התקפים הם home,‏ work,‏ mobile,‏ fax,‏ pager ו-other.
primary

boolean

מציין אם זה מספר הטלפון הראשי של המשתמש.

EnterpriseUserExtension

הגדרת המאפיינים של תוסף SCIM Enterprise User. ה-URN של הסכימה של התוסף הזה הוא: urn:ietf:params:scim:schemas:extension:enterprise:2.0:User. פרטים נוספים זמינים ב-RFC 7643 סעיף 4.3.

ייצוג JSON 
{
  "employeeNumber": string,
  "costCenter": string,
  "organization": string,
  "department": string
}
שדות
employeeNumber

string

זה שינוי אופציונלי. מזהה, בדרך כלל מוקצה על ידי הארגון, שמשמש לזיהוי המשתמש בתוך הארגון.
costCenter

string

זה שינוי אופציונלי. מזהה של מרכז העלויות שאליו משויכים ההוצאות של המשתמש.
organization

string

זה שינוי אופציונלי. השם של הארגון שהמשתמש שייך אליו.
department

string

זה שינוי אופציונלי. השם של המחלקה שהמשתמש שייך אליה בפורמט טקסט.

GroupReference

ייצוג SCIM של חברות בקבוצה של משתמש.

ייצוג JSON 
{
  "value": string,
  "$ref": string,
  "type": string
}
שדות
value

string

פלט בלבד. ה-id של משאב ה-SCIM שמייצג את הקבוצה.
$ref

string

פלט בלבד. ה-URI של משאב SCIM שמייצג את הקבוצה.
type

string

פלט בלבד. סוג החברות בקבוצה. הערכים התקינים הם direct ו-indirect.

Methods

create

 יצירת משתמש.

delete

 מחיקת משתמש.

get

 שליפת משתמש.

list

 מאחזר רשימה של משתמשים.

patch

 עדכון משתמש באמצעות סמנטיקה של תיקון SCIM.