REST Resource: customers.policySchemas

מקור מידע: PolicySchema

משאב שמייצג סכימת מדיניות.

ייצוג JSON 
{
  "name": string,
  "policyDescription": string,
  "additionalTargetKeyNames": [
    {
      object (AdditionalTargetKeyName)
    }
  ],
  "definition": {
    object (FileDescriptorProto)
  },
  "fieldDescriptions": [
    {
      object (PolicySchemaFieldDescription)
    }
  ],
  "accessRestrictions": [
    string
  ],
  "notices": [
    {
      object (PolicySchemaNoticeDescription)
    }
  ],
  "supportUri": string,
  "schemaName": string,
  "validTargetResources": [
    enum (TargetResource)
  ],
  "policyApiLifecycle": {
    object (PolicyApiLifecycle)
  },
  "categoryTitle": string
}
שדות
name

string

פורמט: name=customers/{customer}/policySchemas/{schema_namespace}
policyDescription

string

פלט בלבד. תיאור של סכימת המדיניות בנושא צריכת משתמשים.
additionalTargetKeyNames[]

object (AdditionalTargetKeyName)

פלט בלבד. שמות מפתח נוספים שישמשו לזיהוי היעד של ערך המדיניות. כשמציינים policyTargetKey, כל אחד מהמפתחות הנוספים שמצוינים כאן צריך להיכלל במפה של additionalTargetKeys.
definition

object (FileDescriptorProto)

הגדרת סכימה באמצעות מתאר אב.
fieldDescriptions[]

object (PolicySchemaFieldDescription)

פלט בלבד. תיאור מפורט של כל שדה שמהווה חלק מהסכימה.
accessRestrictions[]

string

פלט בלבד. הגבלות גישה ספציפיות הקשורות למדיניות הזו.
notices[]

object (PolicySchemaNoticeDescription)

פלט בלבד. הודעות של הודעות מיוחדות הקשורות להגדרת ערכים מסוימים בשדות מסוימים בסכימה.
supportUri

string

פלט בלבד. URI למאמר התמיכה שקשור לסכימה הזו.
schemaName

string

פלט בלבד. השם המלא של סכימת המדיניות. הערך הזה משמש למילוי השדה policySchema ב-PolicyValue כשמתבצעת קריאה ל-orgunits.batchInherit orgunits.batchModify groups.batchModify או ל-groups.batchDelete.
validTargetResources[]

enum (TargetResource)

פלט בלבד. מידע על משאבי היעד הרלוונטיים של המדיניות.
policyApiLifecycle

object (PolicyApiLifecycle)

פלט בלבד. מידע על מחזור החיים הנוכחי.
categoryTitle

string

שם הקטגוריה שאליה שייכת ההגדרה.

AdditionalTargetKeyName

שמות מפתח נוספים שישמשו לזיהוי היעד של ערך המדיניות.

ייצוג JSON 
{
  "key": string,
  "keyDescription": string
}
שדות
key

string

שם מפתח.
keyDescription

string

תיאור מפתח.

FileDescriptorProto

מתאר קובץ .proto מלא.

ייצוג JSON 
{
  "name": string,
  "package": string,
  "messageType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "syntax": string
}
שדות
name

string

שם קובץ, ביחס לשורש של עץ המקור
package

string

לדוגמה, "foo" , "foo.bar" וכו'.
messageType[]

object (DescriptorProto)

כל ההגדרות ברמה העליונה בקובץ הזה.
enumType[]

object (EnumDescriptorProto)
syntax

string

התחביר של קובץ האב. הערכים הנתמכים הם "proto2", "proto3" ו-"editions".

אם השדה edition קיים, הערך הזה חייב להיות 'מהדורות'.

DescriptorProto

מתאר את סוג ההודעה.

ייצוג JSON 
{
  "name": string,
  "field": [
    {
      object (FieldDescriptorProto)
    }
  ],
  "nestedType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "oneofDecl": [
    {
      object (OneofDescriptorProto)
    }
  ]
}
שדות
name

string
field[]

object (FieldDescriptorProto)
nestedType[]

object (DescriptorProto)
enumType[]

object (EnumDescriptorProto)
oneofDecl[]

object (OneofDescriptorProto)

FieldDescriptorProto

מתאר שדה בתוך הודעה.

ייצוג JSON 
{
  "name": string,
  "number": integer,
  "label": enum (Label),
  "type": enum (Type),
  "typeName": string,
  "defaultValue": string,
  "oneofIndex": integer,
  "jsonName": string,
  "proto3Optional": boolean
}
שדות
name

string
number

integer
label

enum (Label)
type

enum (Type)

אם typeName מוגדר, אין צורך להגדיר אותו. אם גם הזה וגם מסוג typeName מוגדרים, הערך הזה חייב להיות אחד מהערכים TYPE_ENUM, TYPE_MESSAGE או TYPE_GROUP.
typeName

string

במקרה של הודעות וטיפוסים בני מנייה (enum), זהו השם של הסוג. אם השם מתחיל ב-'.', סימן שהוא מלא. אחרת, כללי היקף דמויי C++ משמשים לאיתור הסוג (כלומר, תחילה מתבצע חיפוש בסוגים המקוננים בהודעה הזו, ולאחר מכן בתוך ההורה, עד למרחב השמות הבסיסי).
defaultValue

string

בסוגים מספריים, מכיל את ייצוג הטקסט המקורי של הערך. לבוליאנים, "true" או "false". עבור מחרוזות, מכיל את תוכן הטקסט שמוגדר כברירת מחדל (בלי תו בריחה (escape) בכל דרך שהיא). עבור בייטים, מכיל את הערך C שמסומן בתו בריחה (escape). כל הבייטים >= 128 מסומנים בתו בריחה (escape).
oneofIndex

integer

אם היא מוגדרת, הפונקציה מחזירה את האינדקס של סוג אחד מתוך רשימת oneofDecl של הסוג שמכיל. השדה הזה חבר באחד מהשדות האלה.
jsonName

string

שם ה-JSON של השדה הזה. הערך מוגדר על ידי מהדר הפרוטוקול. אם המשתמש הגדיר אפשרות בשם 'jsonName' בשדה הזה, המערכת תשתמש בערך של האפשרות הזו. אחרת, הוא נגזר משם השדה על ידי המרתו ל-camlCase.
proto3Optional

boolean

אם true, זהו proto3 "אופציונלי". אם שדה proto3 הוא אופציונלי, הוא עוקב אחר הנוכחות ללא קשר לסוג השדה.

כשהערך של proto3Optional הוא TRUE, השדה הזה חייב להיות שייך ל-one of כדי לאותת ללקוחות proto3 הישנים שמתקיים מעקב אחר הנוכחות בשדה הזה. השדה הזה ידוע כשדה "סינתטי", והשדה הזה חייב להיות המרכיב היחיד בו (כל שדה אופציונלי מסוג proto3 מקבל שדה סינתטי משלו). מאפיינים סינתטיים מסוימים קיימים במתאר בלבד ולא יוצרים ממשק API. אחרי כל המילים ה "אמיתיות" יש לסדר את המופעים הסינתטיים.

בשדות של הודעות, proto3Optional לא יוצר שינוי סמנטי, כי שדות של הודעות שהם לא חוזרים תמיד עוקבים אחרי הנוכחות. עם זאת, עדיין ניתן לראות את הפירוט הסמנטי שמציין אם המשתמש כתב 'אופציונלי' או לא. אפשרות זו יכולה להיות שימושית כשרוצים לבצע "הלוך ושוב" של קובץ ה- .proto. כדי לשמור על עקביות, אנחנו נותנים לשדות ההודעה גם שדה סינתטי, על אף שהוא לא נדרש כדי לעקוב אחר הנוכחות. הדבר חשוב במיוחד מכיוון שהמנתח לא יכול לזהות אם שדה הוא הודעה או טיפוסים בני מנייה (enum), ולכן הוא חייב תמיד ליצור שדה סינתטי מהם.

הדגל הזה לא מוגדר בשדות האופציונליים Proto2 כי כבר צוין בהם ערך אופציונלי ב-LABEL_OPTIONAL.

תווית

טיפוסים בני מנייה (enums)
LABEL_OPTIONAL 0 שמור לשגיאות
LABEL_REQUIRED
LABEL_REPEATED

סוג

טיפוסים בני מנייה (enums)
TYPE_DOUBLE הערך 0 שמור לשגיאות. ההזמנה מוזרה מסיבות היסטוריות.
TYPE_FLOAT
TYPE_INT64 לא מקודד ZigZag. מספרים שליליים לוקחים 10 בייטים. השתמש ב-TYPE_SINT64 אם יש סבירות גבוהה לערכים שליליים.
TYPE_UINT64
TYPE_INT32 לא מקודד ZigZag. מספרים שליליים לוקחים 10 בייטים. השתמש ב-TYPE_SINT32 אם יש סבירות גבוהה לערכים שליליים.
TYPE_FIXED64
TYPE_FIXED32
TYPE_BOOL
TYPE_STRING
TYPE_GROUP צבירה מופרדת בתגים. סוג הקבוצה הוצא משימוש ולא נתמך ב-proto3. עם זאת, הטמעות של Proto3 עדיין אמורות לנתח את פורמט החוט הקבוצתי ולהתייחס לשדות הקבוצה כשדות לא ידועים.
TYPE_MESSAGE צבירה מופרדת לאורך.
TYPE_BYTES חדש בגרסה 2.
TYPE_UINT32
TYPE_ENUM
TYPE_SFIXED32
TYPE_SFIXED64
TYPE_SINT32 עושה שימוש בקידוד ZigZag.
TYPE_SINT64 עושה שימוש בקידוד ZigZag.

EnumDescriptorProto

מתאר סוג טיפוסים בני מנייה (enum).

ייצוג JSON 
{
  "name": string,
  "value": [
    {
      object (EnumValueDescriptorProto)
    }
  ]
}
שדות
name

string
value[]

object (EnumValueDescriptorProto)

EnumValueDescriptorProto

מתאר ערך בתוך טיפוסים בני מנייה (enum).

ייצוג JSON 
{
  "name": string,
  "number": integer
}
שדות
name

string
number

integer

OneofDescriptorProto

מתאר אחד מ-.

ייצוג JSON 
{
  "name": string
}
שדות
name

string

PolicySchemaFieldDescription

מספק מידע מפורט לשדה ספציפי שמהווה חלק מ-PolicySchema.

ייצוג JSON 
{
  "field": string,
  "description": string,
  "inputConstraint": string,
  "knownValueDescriptions": [
    {
      object (PolicySchemaFieldKnownValueDescription)
    }
  ],
  "nestedFieldDescriptions": [
    {
      object (PolicySchemaFieldDescription)
    }
  ],
  "fieldDependencies": [
    {
      object (PolicySchemaFieldDependencies)
    }
  ],
  "requiredItems": [
    {
      object (PolicySchemaRequiredItems)
    }
  ],
  "defaultValue": value,
  "name": string,
  "fieldDescription": string,
  "fieldConstraints": {
    object (FieldConstraints)
  }
}
שדות
field

string

פלט בלבד. שם השדה שמשויך לתיאור הזה.
description
(deprecated)

string

הוּצא משימוש. במקום זאת, צריך להשתמש בשם ובשדה fieldDescription. התיאור של השדה.
inputConstraint

string

פלט בלבד. מגבלות הקלט המשויכות לערכים של השדה.
knownValueDescriptions[]

object (PolicySchemaFieldKnownValueDescription)

פלט בלבד. אם בשדה יש קבוצה של ערכים ידועים, השדה הזה יספק תיאור של הערכים האלה.
nestedFieldDescriptions[]

object (PolicySchemaFieldDescription)

פלט בלבד. מספק את תיאור השדות המקננים בשדה הזה, אם השדה הוא סוג הודעה שמגדיר שדות מרובים.
fieldDependencies[]

object (PolicySchemaFieldDependencies)

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

object (PolicySchemaRequiredItems)

פלט בלבד. מספקת רשימת שדות שיש להגדיר אם בשדה הזה יש ערך מסוים.
defaultValue

value (Value format)

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

string

פלט בלבד. שם השדה.
fieldDescription

string

פלט בלבד. תיאור השדה.
fieldConstraints

object (FieldConstraints)

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

PolicySchemaFieldKnownValueDescription

מספקת מידע מפורט לגבי ערך ידוע שמותר בשדה מסוים ב-PolicySchema.

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

string

פלט בלבד. ייצוג מחדש של המחרוזת של הערך שניתן להגדיר בשדה.
description

string

פלט בלבד. תיאור נוסף לערך הזה.

PolicySchemaFieldDependencies

השדה והערך חייבים להיות כדי שניתן יהיה להגדיר שדה אחר.

ייצוג JSON 
{
  "sourceField": string,
  "sourceFieldValue": string
}
שדות
sourceField

string

שדה המקור שבו תלוי השדה הזה.
sourceFieldValue

string

הערך שנדרש לשדה המקור כדי שניתן יהיה להגדיר את השדה הזה.

PolicySchemaRequiredItems

השדות שיחויבו בהתאם לערך בשדה הזה.

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

string

ערכי השדה שמפעילים את אכיפת השדות הנדרשים. אם השדה fieldConditions ריק, כל ערך שמוקצה לשדה הזה יעורר אכיפת שדה נדרשת.
requiredFields[]

string

השדות הנדרשים כתוצאה מתנאי השדות.

FieldConstraints

מידע על מגבלות טווח.

ייצוג JSON 
{
  "numericRangeConstraint": {
    object (NumericRangeConstraint)
  },
  "uploadedFileConstraints": {
    object (UploadedFileConstraints)
  }
}
שדות
numericRangeConstraint

object (NumericRangeConstraint)

הטווח המותר לשדות מספריים.
uploadedFileConstraints

object (UploadedFileConstraints)

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

NumericRangeConstraint

מגבלה על הגבול העליון ו/או התחתון, כאשר מוגדר לפחות גבול אחד.

ייצוג JSON 
{
  "minimum": string,
  "maximum": string
}
שדות
minimum

string (int64 format)

ערך מינימלי.
maximum

string (int64 format)

ערך מקסימלי.

UploadedFileConstraints

מגבלות על הקובץ שהועלה של מדיניות קבצים.

ייצוג JSON 
{
  "supportedContentTypes": [
    enum (ContentType)
  ],
  "sizeLimitBytes": string
}
שדות
supportedContentTypes[]

enum (ContentType)

סוגי קבצים שניתן להעלות עבור הגדרה מסוימת.
sizeLimitBytes

string (int64 format)

מגבלת הגודל של קבצים שהועלו להגדרה, בבייטים.

ContentType

סוגי קבצים שניתן להעלות עבור הגדרה מסוימת.

טיפוסים בני מנייה (enums)
CONTENT_TYPE_UNSPECIFIED סוג התוכן לא צוין.
CONTENT_TYPE_PLAIN_TEXT טקסט פשוט.
CONTENT_TYPE_HTML HTML.
CONTENT_TYPE_IMAGE_JPEG JPEG.
CONTENT_TYPE_IMAGE_GIF GIF.
CONTENT_TYPE_IMAGE_PNG PNG.
CONTENT_TYPE_JSON JSON.
CONTENT_TYPE_ZIP ZIP.
CONTENT_TYPE_GZIP GZIP.
CONTENT_TYPE_CSV CSV.
CONTENT_TYPE_YAML YAML.
CONTENT_TYPE_IMAGE_WEBP WEBP.

PolicySchemaNoticeDescription

מספקת הודעות מיוחדות שקשורות לערך מסוים בשדה שהוא חלק מ-PolicySchema.

ייצוג JSON 
{
  "field": string,
  "noticeValue": string,
  "noticeMessage": string,
  "acknowledgementRequired": boolean
}
שדות
field

string

פלט בלבד. שם השדה המשויך להודעה.
noticeValue

string

פלט בלבד. ערך השדה עם ההודעה. כשמגדירים בשדה את הערך הזה, יכול להיות שהמשתמש יידרש לאשר את הודעת ההתראה כדי להגדיר את הערך.
noticeMessage

string

פלט בלבד. הודעת ההודעה משויכת לערך של השדה.
acknowledgementRequired

boolean

פלט בלבד. האם המשתמש צריך לאשר את הודעת ההודעה לפני שניתן להגדיר את הערך.

TargetResource

סוגי המשאבים לטירגוט

טיפוסים בני מנייה (enums)
TARGET_RESOURCE_UNSPECIFIED משאב יעד לא צוין.
ORG_UNIT משאב יעד של יחידה ארגונית.
GROUP משאב יעד של קבוצה.

PolicyApiLifecycle

ייצוג JSON 
{
  "policyApiLifecycleStage": enum (PolicyApiLifecycleEnum),
  "description": string,
  "endSupport": {
    object (Date)
  },
  "deprecatedInFavorOf": [
    string
  ]
}
שדות
policyApiLifecycleStage

enum (PolicyApiLifecycleEnum)

ציון השלב הנוכחי במחזור החיים של ה-API של המדיניות.
description

string

תיאור של מחזור החיים הנוכחי.
endSupport

object (Date)

סיום תאריך התמיכה במדיניות הנוכחית.
deprecatedInFavorOf[]

string

אם המדיניות הזו הוצאה משימוש לטובת מדיניות אחרת, מרחבי השמות המלאים של כללי המדיניות החדשים יוצגו ב-PolicyAPI.

PolicyApiLifecycleEnum

טיפוסים בני מנייה (enums)
API_UNSPECIFIED לא צוין.
API_PREVIEW המדיניות עדיין לא פועלת, אבל המפתחים מקבלים התראה לגבי הפורמט. ניתן להעביר את השלב הזה אל API_DEהוצאה משימוש או אל API_CURRENT.
API_DEVELOPMENT המדיניות יכולה לשנות את הפורמט בדרך שאינה תואמת לאחור (שינויי מעבר). השלב הזה יכול לעבור אל API_CURRENT או אל API_DEPRECATED. ניתן להשתמש באפשרות הזו עבור כללי מדיניות שהושקו רק עבור מכשירי TT או שהושקו ללקוחות נבחרים לשימוש במקרה חירום.
API_CURRENT המדיניות בפורמט רשמי. המדיניות יכולה להשתנות בהתאם לאחור בתאימות לאחור (שינוי שלא עלול לגרום לשיבושים). דוגמה: אם משתמשים במסכות של שדות בצורה נכונה, יכול להיות שהמדיניות הזו תכניס שדה חדש שנחשב כשינוי בלתי הפיך. ניתן להעביר את השלב הזה אל API_DEPRECATED.
API_DEPRECATED יש להפסיק להשתמש במדיניות הזו. המדיניות הזו הוצאה משימוש וייתכן שהיא תוסר בעתיד. סביר להניח שנוספה מדיניות חדשה שמחליפה את המדיניות הזו.

תאריך

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

  • תאריך מלא, עם ערכים שונים של שנה, חודש ויום.
  • חודש ויום, עם שנה של אפס (למשל יום נישואין).
  • שנה בפני עצמה, עם חודש של אפס ואפס יום.
  • שנה וחודש, עם אפס יום (לדוגמה, תאריך תפוגה של כרטיס אשראי).

סוגים קשורים:

ייצוג JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
שדות
year

integer

שנת התאריך. חייב להיות בין 1 ל-9999, או 0 כדי לציין תאריך ללא שנה.
month

integer

החודש בשנה. צריך להיות בין 1 ל-12, או 0 כדי לציין שנה בלי חודש ויום.
day

integer

היום בחודש. הערך צריך להיות בין 1 ל-31 והוא תקף לשנה ולחודש, או 0 כדי לציין שנה בלבד או שנה וחודש שבהם היום לא משמעותי.

שיטות

get

 קבלת סכימת מדיניות ספציפית ללקוח לפי שם המשאב שלו.

list

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