REST Resource: customers.policySchemas

Ressource: PolicySchema

Ressource, die ein Richtlinienschema darstellt.

JSON-Darstellung 
{
  "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
}
Felder
name

string

Format: name=customers/{customer}/policySchemas/{schema_namespace}
policyDescription

string

Nur Ausgabe Beschreibung des Richtlinienschemas für die Verwendung durch die Nutzer.
additionalTargetKeyNames[]

object (AdditionalTargetKeyName)

Nur Ausgabe Zusätzliche Schlüsselnamen, mit denen das Ziel des Richtlinienwerts identifiziert wird. Wenn Sie einen policyTargetKey angeben, muss jeder der hier angegebenen zusätzlichen Schlüssel in die additionalTargetKeys-Zuordnung aufgenommen werden.
definition

object (FileDescriptorProto)

Schemadefinition mit dem Proto-Deskriptor.
fieldDescriptions[]

object (PolicySchemaFieldDescription)

Nur Ausgabe Detaillierte Beschreibung jedes Feldes, das Teil des Schemas ist.
accessRestrictions[]

string

Nur Ausgabe Spezifische Zugriffsbeschränkungen im Zusammenhang mit dieser Richtlinie.
notices[]

object (PolicySchemaNoticeDescription)

Nur Ausgabe Besondere Hinweise zum Festlegen bestimmter Werte in bestimmten Feldern des Schemas.
supportUri

string

Nur Ausgabe URI zum zugehörigen Hilfeartikel für dieses Schema.
schemaName

string

Nur Ausgabe Der voll qualifizierte Name des Richtlinienschemas. Mit diesem Wert wird das Feld policySchema in PolicyValue ausgefüllt, wenn orgunits.batchInherit, orgunits.batchModify, groups.batchModify oder groups.batchDelete aufgerufen wird.
validTargetResources[]

enum (TargetResource)

Nur Ausgabe Informationen zu anwendbaren Zielressourcen für die Richtlinie.
policyApiLifecycle

object (PolicyApiLifecycle)

Nur Ausgabe Aktuelle Lebenszyklusinformationen.
categoryTitle

string

Titel der Kategorie, zu der eine Einstellung gehört.

AdditionalTargetKeyName

Zusätzliche Schlüsselnamen, mit denen das Ziel des Richtlinienwerts identifiziert wird.

JSON-Darstellung 
{
  "key": string,
  "keyDescription": string
}
Felder
key

string

Schlüsselname.
keyDescription

string

Schlüsselbeschreibung.

FileDescriptorProto

Beschreibt eine vollständige .proto-Datei.

JSON-Darstellung 
{
  "name": string,
  "package": string,
  "messageType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "syntax": string
}
Felder
name

string

Dateiname, relativ zur Stammstruktur der Quellstruktur
package

string

z.B. "foo", "foo.bar" usw.
messageType[]

object (DescriptorProto)

Alle Definitionen der obersten Ebene in dieser Datei.
enumType[]

object (EnumDescriptorProto)
syntax

string

Die Syntax der .proto-Datei. Die unterstützten Werte sind „proto2“, „proto3“ und „editions“.

Wenn edition vorhanden ist, muss dieser Wert „editions“ sein.

DescriptorProto

Beschreibt einen Nachrichtentyp.

JSON-Darstellung 
{
  "name": string,
  "field": [
    {
      object (FieldDescriptorProto)
    }
  ],
  "nestedType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "oneofDecl": [
    {
      object (OneofDescriptorProto)
    }
  ]
}
Felder
name

string
field[]

object (FieldDescriptorProto)
nestedType[]

object (DescriptorProto)
enumType[]

object (EnumDescriptorProto)
oneofDecl[]

object (OneofDescriptorProto)

FieldDescriptorProto

Beschreibt ein Feld in einer Nachricht.

JSON-Darstellung 
{
  "name": string,
  "number": integer,
  "label": enum (Label),
  "type": enum (Type),
  "typeName": string,
  "defaultValue": string,
  "oneofIndex": integer,
  "jsonName": string,
  "proto3Optional": boolean
}
Felder
name

string
number

integer
label

enum (Label)
type

enum (Type)

Wenn „typeName“ festgelegt ist, muss dieser Wert nicht festgelegt werden. Wenn sowohl dieser Wert als auch typeName festgelegt sind, muss dieser Wert TYPE_ENUM, TYPE_MESSAGE oder TYPE_GROUP sein.
typeName

string

Bei Nachrichten- und Enum-Typen ist dies der Name des Typs. Beginnt der Name mit einem Punkt (.), ist er voll qualifiziert. Andernfalls werden C++-ähnliche Zugehörigkeitsregeln verwendet, um den Typ zu finden (d.h. zuerst werden die verschachtelten Typen in dieser Nachricht, dann im übergeordneten Element und dann bis zum Stamm-Namespace durchsucht).
defaultValue

string

Enthält bei numerischen Typen die ursprüngliche Textdarstellung des Werts. Bei booleschen Werten „true“ oder „false“. Enthält für Zeichenfolgen den Standardtextinhalt (keine Escape-Angabe). Enthält für Bytes den maskierten C-Wert. Alle Byte >= 128 werden maskiert.
oneofIndex

integer

Falls festgelegt, wird der Index eines oneof in der oneofDecl-Liste des enthaltenden Typs angegeben. Dieses Feld ist ein Element dieses oneof.
jsonName

string

JSON-Name dieses Felds. Der Wert wird vom Protokollcompiler festgelegt. Wenn der Nutzer die Option „jsonName“ für dieses Feld festgelegt hat, wird der Wert dieser Option verwendet. Andernfalls wird es aus dem Feldnamen abgeleitet, indem es in „camelCase“ konvertiert wird.
proto3Optional

boolean

Bei „true“ ist dies ein Proto3 „optional“. Wenn ein Proto3-Feld optional ist, wird die Präsenz unabhängig vom Feldtyp erfasst.

Wenn „proto3Optional“ auf „true“ gesetzt ist, muss dieses Feld zu einem oneof gehören, um alten Proto3-Clients zu signalisieren, dass die Präsenz für dieses Feld erfasst wird. Dieses oneof wird als „synthetisches“ oneof bezeichnet und dieses Feld muss sein einziges Element sein (jedes optionales Proto3-Feld erhält ein eigenes synthetisches Oneof). Synthetische oneofs sind nur im Deskriptor vorhanden und generieren keine API. Synthetische Oneofs müssen nach allen "echten" oneofs geordnet werden.

Bei Nachrichtenfeldern nimmt proto3Optional keine semantische Änderung vor, da nicht wiederkehrende Nachrichtenfelder immer die Anwesenheit erfassen. Er gibt jedoch immer noch die semantischen Details dazu an, ob der Nutzer „optional“ geschrieben hat oder nicht. Dies kann nützlich sein, um die .proto-Datei umzukehren. Aus Konsistenzgründen weisen wir Nachrichtenfeldern auch ein synthetisches oneof zu, obwohl dies nicht erforderlich ist, um die Anwesenheit zu verfolgen. Das ist besonders wichtig, da der Parser nicht erkennen kann, ob ein Feld eine Nachricht oder ein Enum ist. Daher muss immer ein synthetisches oneof erstellt werden.

In optionalen Proto2-Feldern wird dieses Flag nicht festgelegt, da sie bereits mit LABEL_OPTIONAL als optional gekennzeichnet sind.

Label

Enums
LABEL_OPTIONAL 0 ist für Fehler reserviert
LABEL_REQUIRED
LABEL_REPEATED

Typ

Enums
TYPE_DOUBLE 0 ist für Fehler reserviert. Die Reihenfolge ist aus historischen Gründen seltsam.
TYPE_FLOAT
TYPE_INT64 Nicht ZigZag-codiert. Negative Zahlen haben 10 Byte. Verwenden Sie TYPE_SINT64, wenn negative Werte wahrscheinlich sind.
TYPE_UINT64
TYPE_INT32 Nicht ZigZag-codiert. Negative Zahlen haben 10 Byte. Verwenden Sie TYPE_SINT32, wenn negative Werte wahrscheinlich sind.
TYPE_FIXED64
TYPE_FIXED32
TYPE_BOOL
TYPE_STRING
TYPE_GROUP Aggregierte Daten als Tag-getrennt. Der Gruppentyp wurde verworfen und wird in proto3 nicht unterstützt. Proto3-Implementierungen sollten jedoch in der Lage sein, das Gruppenübertragungsformat zu parsen und Gruppenfelder als unbekannte Felder zu behandeln.
TYPE_MESSAGE Durch Länge getrenntes Aggregat.
TYPE_BYTES Neu in Version 2.
TYPE_UINT32
TYPE_ENUM
TYPE_SFIXED32
TYPE_SFIXED64
TYPE_SINT32 Verwendet ZigZag-Codierung.
TYPE_SINT64 Verwendet ZigZag-Codierung.

EnumDescriptorProto

Beschreibt einen Enum-Typ.

JSON-Darstellung 
{
  "name": string,
  "value": [
    {
      object (EnumValueDescriptorProto)
    }
  ]
}
Felder
name

string
value[]

object (EnumValueDescriptorProto)

EnumValueDescriptorProto

Beschreibt einen Wert innerhalb einer Enumeration.

JSON-Darstellung 
{
  "name": string,
  "number": integer
}
Felder
name

string
number

integer

OneofDescriptorProto

Beschreibt eine oneof.

JSON-Darstellung 
{
  "name": string
}
Felder
name

string

PolicySchemaFieldDescription

Liefert detaillierte Informationen für ein bestimmtes Feld, das Teil eines PolicySchema ist.

JSON-Darstellung 
{
  "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)
  }
}
Felder
field

string

Nur Ausgabe Der Name des Feldes, das mit dieser Beschreibung verknüpft ist.
description
(deprecated)

string

Veraltet. Verwenden Sie stattdessen „name“ und „fieldDescription“. Die Beschreibung für das Feld.
inputConstraint

string

Nur Ausgabe Alle Eingabeeinschränkungen im Zusammenhang mit den Werten für das Feld.
knownValueDescriptions[]

object (PolicySchemaFieldKnownValueDescription)

Nur Ausgabe Wenn das Feld mehrere bekannte Werte enthält, enthält dieses Feld eine Beschreibung für diese Werte.
nestedFieldDescriptions[]

object (PolicySchemaFieldDescription)

Nur Ausgabe Liefert die Beschreibung der in diesem Feld verschachtelten Felder, wenn das Feld einen Nachrichtentyp ist, der mehrere Felder definiert.
fieldDependencies[]

object (PolicySchemaFieldDependencies)

Nur Ausgabe Liefert eine Liste mit Feldern und Werten. Mindestens eines der Felder muss den entsprechenden Wert haben, damit dieses Feld festgelegt werden kann.
requiredItems[]

object (PolicySchemaRequiredItems)

Nur Ausgabe Liefert eine Liste der Felder, die festgelegt werden müssen, wenn dieses Feld einen bestimmten Wert hat.
defaultValue

value (Value format)

Nur Ausgabe Standardeinstellung des Clients, wenn die Richtlinie nicht konfiguriert ist.
name

string

Nur Ausgabe Der Name des Felds.
fieldDescription

string

Nur Ausgabe Die Beschreibung des Felds.
fieldConstraints

object (FieldConstraints)

Nur Ausgabe Informationen zu Eingabeeinschränkungen im Zusammenhang mit den Werten für das Feld.

PolicySchemaFieldKnownValueDescription

Liefert detaillierte Informationen zu einem bekannten Wert, der für ein bestimmtes Feld in einem PolicySchema zulässig ist.

JSON-Darstellung 
{
  "value": string,
  "description": string
}
Felder
value

string

Nur Ausgabe Die Stringdarstellung des Werts, der für das Feld festgelegt werden kann.
description

string

Nur Ausgabe Zusätzliche Beschreibung für diesen Wert.

PolicySchemaFieldDependencies

Das Feld und der Wert, den es enthalten muss, damit ein anderes Feld festgelegt werden kann.

JSON-Darstellung 
{
  "sourceField": string,
  "sourceFieldValue": string
}
Felder
sourceField

string

Das Quellfeld, von dem dieses Feld abhängt.
sourceFieldValue

string

Der Wert, den das Quellfeld enthalten muss, damit dieses Feld festgelegt werden kann.

PolicySchemaRequiredItems

Die Felder, die basierend auf dem Wert dieses Felds erforderlich werden.

JSON-Darstellung 
{
  "fieldConditions": [
    string
  ],
  "requiredFields": [
    string
  ]
}
Felder
fieldConditions[]

string

Der/die Wert(e) des Feldes, das/die die Pflichtfelderzwingung auslösen soll. Bei einem leeren Feld "fieldConditions" wird impliziert, dass bei jedem Wert, der diesem Feld zugewiesen ist, die Erzwingung eines erforderlichen Felds ausgelöst wird.
requiredFields[]

string

Die Felder, die aufgrund der Feldbedingungen erforderlich sind.

FieldConstraints

Informationen zu Bereichseinschränkungen.

JSON-Darstellung 
{
  "numericRangeConstraint": {
    object (NumericRangeConstraint)
  },
  "uploadedFileConstraints": {
    object (UploadedFileConstraints)
  }
}
Felder
numericRangeConstraint

object (NumericRangeConstraint)

Der zulässige Bereich für numerische Felder.
uploadedFileConstraints

object (UploadedFileConstraints)

Einschränkungen für die hochgeladene Datei einer Dateirichtlinie. Falls vorhanden, erfordert diese Richtlinie eine URL, die durch Hochladen einer Datei mit den in diesem Protokoll angegebenen Einschränkungen abgerufen werden kann.

NumericRangeConstraint

Eine Einschränkung für die Ober- und/oder Untergrenze, wobei mindestens eine festgelegt ist.

JSON-Darstellung 
{
  "minimum": string,
  "maximum": string
}
Felder
minimum

string (int64 format)

Minimalwert.
maximum

string (int64 format)

Höchstwert.

UploadedFileConstraints

Einschränkungen für die hochgeladene Datei einer Dateirichtlinie.

JSON-Darstellung 
{
  "supportedContentTypes": [
    enum (ContentType)
  ],
  "sizeLimitBytes": string
}
Felder
supportedContentTypes[]

enum (ContentType)

Dateitypen, die für eine Einstellung hochgeladen werden können.
sizeLimitBytes

string (int64 format)

Die Größenbeschränkung für hochgeladene Dateien für eine Einstellung in Byte.

ContentType

Dateitypen, die für eine Einstellung hochgeladen werden können.

Enums
CONTENT_TYPE_UNSPECIFIED Nicht angegebener Inhaltstyp.
CONTENT_TYPE_PLAIN_TEXT Nur Text
CONTENT_TYPE_HTML HTML.
CONTENT_TYPE_IMAGE_JPEG JPEG aus.
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-Datei.
CONTENT_TYPE_YAML YAML
CONTENT_TYPE_IMAGE_WEBP WebP

PolicySchemaNoticeDescription

Liefert besondere Hinweise, die sich auf einen bestimmten Wert in einem Feld beziehen, das Teil eines PolicySchema ist.

JSON-Darstellung 
{
  "field": string,
  "noticeValue": string,
  "noticeMessage": string,
  "acknowledgementRequired": boolean
}
Felder
field

string

Nur Ausgabe Der mit der Mitteilung verknüpfte Feldname.
noticeValue

string

Nur Ausgabe Der Wert des Felds, das einen Hinweis enthält. Wenn Sie das Feld auf diesen Wert setzen, muss der Nutzer möglicherweise die Mitteilung bestätigen, damit der Wert festgelegt werden kann.
noticeMessage

string

Nur Ausgabe Die Benachrichtigung, die mit dem Wert des Felds verknüpft ist.
acknowledgementRequired

boolean

Nur Ausgabe Gibt an, ob der Nutzer die Mitteilung bestätigen muss, bevor der Wert festgelegt werden kann.

TargetResource

Zielressourcentypen

Enums
TARGET_RESOURCE_UNSPECIFIED Nicht angegebene Zielressource.
ORG_UNIT Zielressource für Organisationseinheit.
GROUP Zielressource gruppieren.

PolicyApiLifecycle

JSON-Darstellung 
{
  "policyApiLifecycleStage": enum (PolicyApiLifecycleEnum),
  "description": string,
  "endSupport": {
    object (Date)
  },
  "deprecatedInFavorOf": [
    string
  ]
}
Felder
policyApiLifecycleStage

enum (PolicyApiLifecycleEnum)

Geben Sie die aktuelle Lebenszyklusphase der Policy API an.
description

string

Beschreibung des aktuellen Lebenszyklus.
endSupport

object (Date)

Enddatum für die aktuelle Richtlinie.
deprecatedInFavorOf[]

string

Falls diese Richtlinie zugunsten einer anderen Richtlinie eingestellt wurde, sind dies die voll qualifizierten Namespaces der neuen Richtlinien, wie sie in der PolicyAPI angezeigt werden.

PolicyApiLifecycleEnum

Enums
API_UNSPECIFIED nicht angegeben.
API_PREVIEW Die Richtlinie funktioniert noch nicht, wir informieren Entwickler jedoch über das Format. Diese Phase kann zu API_DEVELOPEMNT oder API_CURRENT übertragen werden.
API_DEVELOPMENT Die Richtlinie kann das Format nicht abwärtskompatibel ändern (nicht abwärtskompatible Änderung). Diese Phase kann zu API_CURRENT oder API_DEPRECATED übertragen werden. Diese Option kann für Richtlinien verwendet werden, die nur für TTs oder nur für bestimmte Kunden im Notfall eingeführt werden.
API_CURRENT Richtlinie im offiziellen Format. Die Richtlinie kann das Format abwärtskompatibel ändern (abwärtskompatible Änderung). Beispiel: Mit dieser Richtlinie kann ein neues Feld eingeführt werden, das als abwärtskompatible Änderung gilt, wenn Feldmasken korrekt verwendet werden. Diese Phase kann an API_DEPRECATED übertragen werden.
API_DEPRECATED Bitte verwenden Sie diese Richtlinie nicht mehr. Diese Richtlinie ist veraltet und wird möglicherweise in Zukunft entfernt. Höchstwahrscheinlich wurde diese Richtlinie durch eine neue Richtlinie ersetzt.

Datum

Stellt ein ganzes Kalenderdatum oder einen Teil davon dar, z. B. einen Geburtstag. Tageszeit und Zeitzone werden entweder an anderer Stelle angegeben oder sind unbedeutend. Das Datum bezieht sich auf den gregorianischen Kalender. Dies kann Folgendes bedeuten:

  • Ein vollständiges Datum mit Werten für Jahr, Monat und Tag ungleich null.
  • Monat und Tag mit einem Jahr 0 (z. B. ein Jahrestag)
  • Ein Jahr für sich allein, mit einem Monat 0 und einem Tag 0.
  • Ein Jahr und ein Monat mit einem Tag null (z. B. das Ablaufdatum einer Kreditkarte).

Ähnliche Typen:

JSON-Darstellung 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Felder
year

integer

Jahr des Datums. Der Wert muss zwischen 1 und 9999 liegen, oder 0, um ein Datum ohne Jahr anzugeben.
month

integer

Monat eines Jahres. Muss zwischen 1 und 12 liegen, oder 0, um ein Jahr ohne Monat und Tag anzugeben.
day

integer

Tag eines Monats Der Wert muss zwischen 1 und 31 liegen und für das Jahr und den Monat gültig sein. Mit 0 können Sie ein Jahr allein oder ein Jahr und einen Monat angeben, bei dem der Tag nicht von Bedeutung ist.

Methoden

get

 Sie können ein bestimmtes Richtlinienschema für einen Kunden anhand des Ressourcennamens abrufen.

list

 Ruft eine Liste mit Richtlinienschemas ab, die einem angegebenen Filterwert für einen bestimmten Kunden entsprechen.