REST Resource: customers.v2.Groups

משאב: קבוצה

ייצוג SCIM של קבוצה.

ייצוג JSON 
{
  "schemas": [
    string
  ],
  "members": [
    {
      object (Member)
    }
  ],
  "id": string,
  "externalId": string,
  "meta": {
    object (Meta)
  },
  "displayName": string,
  "urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityGroup": {
    object (CloudIdentityGroupExtension)
  }
}
שדות
schemas[]

string

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

object (Member)

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

string

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

string

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

object (Meta)

פלט בלבד. מטא-נתונים של המשאב. לכל מאפייני המשנה יש יכולת השתנות של readOnly ומאפיין returned של default.
displayName

string

חובה. השם המוצג של הקבוצה.
urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityGroup

object (CloudIdentityGroupExtension)

חובה. מאפייני קבוצה ספציפיים ל-Cloud Identity.

חבר

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

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

string

אי אפשר לשנות. מזהה של החבר בקבוצה הזו.
$ref

string

אי אפשר לשנות. ה-URI של המשתמש.

CloudIdentityGroupExtension

הגדרת המאפיינים של התוסף Google Cloud Identity Group. ה-URN של הסכימה של התוסף הזה הוא: urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityGroup.

ייצוג JSON 
{
  "email": string,
  "description": string
}
שדות
email

string

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

string

זה שינוי אופציונלי. תיאור מורחב שיעזור למשתמשים להבין את המטרה של Group.

הגבלה: 4,096 תווים.

Methods

create

 יוצר קבוצה.

delete

 מחיקת קבוצה.

get

 שליפת קבוצה.

list

 מאחזר רשימה של קבוצות.

patch

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