REST Resource: customers.policySchemas

{
  "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,
  "supportedPlatforms": [
    enum (Platform)
  ]
}

string

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

string

Nur Ausgabe. Beschreibung des Richtlinienschemas für die Nutzernutzung.

object (AdditionalTargetKeyName)

Nur Ausgabe. Zusätzliche Schlüsselnamen, die zum Identifizieren des Ziels des Richtlinienwerts verwendet werden. Beim Angeben einer policyTargetKey muss jeder der hier angegebenen zusätzlichen Schlüssel in die additionalTargetKeys-Zuordnung aufgenommen werden.

object (FileDescriptorProto)

Schemadefinition mit Proto-Deskriptor.

object (PolicySchemaFieldDescription)

Nur Ausgabe. Detaillierte Beschreibung jedes Felds, das Teil des Schemas ist. Felder sollten nach der Sortierung in dieser Liste und nicht nach Feldnummer angezeigt werden.

string

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

object (PolicySchemaNoticeDescription)

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

string

Nur Ausgabe. URI zum verwandten Hilfeartikel für dieses Schema.

string

Nur Ausgabe. Der voll qualifizierte Name des Richtlinienschemas. Mit diesem Wert wird das Feld policySchema in PolicyValue ausgefüllt, wenn BatchInheritOrgUnitPolicies BatchModifyOrgUnitPolicies BatchModifyGroupPolicies oder BatchDeleteGroupPolicies aufgerufen wird.

enum (TargetResource)

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

object (PolicyApiLifecycle)

Nur Ausgabe. Aktuelle Lebenszyklusinformationen.

string

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

enum (Platform)

Nur Ausgabe. Laut Liste gilt die Richtlinie nur für Geräte/Nutzer auf diesen Plattformen.

{
  "key": string,
  "keyDescription": string
}

string

Schlüsselname.

string

Beschreibung des Schlüssels.

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

string

Dateiname, relativ zum Stamm der Quellstruktur

string

z.B. „foo“, „foo.bar“ usw.

object (DescriptorProto)

Alle übergeordneten Definitionen in dieser Datei.

object (EnumDescriptorProto)

string

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

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

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

string

object (FieldDescriptorProto)

object (DescriptorProto)

object (EnumDescriptorProto)

object (OneofDescriptorProto)

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

string

integer

enum (Label)

enum (Type)

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

string

Bei Nachrichten- und Enum-Typen ist dies der Name des Typs. Beginnt der Name mit einem „.“, ist er voll qualifiziert. Andernfalls werden C++-ähnliche Bereichsregeln verwendet, um den Typ zu finden (d.h. zuerst werden die verschachtelten Typen innerhalb dieser Nachricht, dann innerhalb des übergeordneten Elements bis zum Stamm-Namespace durchsucht).

string

Enthält bei numerischen Typen die ursprüngliche Textdarstellung des Werts. Für boolesche Werte: „true“ oder „false“. Enthält bei Zeichenfolgen den Standardtextinhalt (keine Escapesequenz). Enthält für Bytes den maskierten C-Wert. Alle Bytes >= 128 werden maskiert.

integer

Wenn festgelegt, wird der Index eines oneof in der oneofDecl-Liste des enthaltenden Typs angegeben. Dieses Feld gehört zu diesem oneof.

string

JSON-Name dieses Felds. Der Wert wird vom Protokoll-Compiler festgelegt. Wenn der Nutzer einen „jsonName“ festgelegt hat für dieses Feld auswählen, wird der Wert dieser Option verwendet. Andernfalls wird er aus dem Feldnamen abgeleitet, indem er in „camelCase“ konvertiert wird.

boolean

Bei „true“ ist dies ein „optionales“ proto3-Element. 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 dieses Feld vorhanden ist. Dieses oneof wird als „synthetische“ oneof. Dieses Feld muss sein einziges Mitglied sein (jedes optionale 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.

Bei Nachrichtenfeldern erstellt proto3Optional keine semantische Änderung, da nicht wiederkehrende Nachrichtenfelder immer die Präsenz erfassen. Sie gibt jedoch weiterhin die semantischen Details an, ob der Nutzer „optional“ eingegeben hat. oder nicht. Dies kann beim Roundtrip der .proto-Datei nützlich sein. Aus Konsistenzgründen geben wir für Nachrichtenfelder ebenfalls ein synthetisches oneof, auch wenn dies nicht erforderlich ist, um die Präsenz zu verfolgen. Dies ist besonders wichtig, da der Parser nicht erkennen kann, ob ein Feld eine Nachricht oder eine Aufzählung ist. Daher muss er immer ein synthetisches oneof erstellen.

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

{
  "name": string,
  "value": [
    {
      object (EnumValueDescriptorProto)
    }
  ]
}

string

object (EnumValueDescriptorProto)

{
  "name": string,
  "number": integer
}

string

integer

{
  "name": string
}

string

{
  "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)
  }
}

string

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

string

Verworfen. Verwenden Sie stattdessen „name“ und „fieldDescription“. Die Beschreibung des Felds.

string

Nur Ausgabe. Alle Eingabeeinschränkungen, die den Werten für das Feld zugeordnet sind.

object (PolicySchemaFieldKnownValueDescription)

Nur Ausgabe. Wenn das Feld eine Reihe bekannter Werte enthält, enthält dieses Feld eine Beschreibung dieser Werte.

object (PolicySchemaFieldDescription)

Nur Ausgabe. Liefert die Beschreibung der in diesem Feld verschachtelten Felder, wenn es sich um einen Nachrichtentyp handelt, mit dem mehrere Felder definiert sind. Felder sollten nach der Sortierung in dieser Liste und nicht nach Feldnummer angezeigt werden.

object (PolicySchemaFieldDependencies)

Nur Ausgabe. Stellt eine Liste von Feldern und Werten bereit. Mindestens eines der Felder muss den entsprechenden Wert enthalten, damit dieses Feld festgelegt werden kann.

object (PolicySchemaRequiredItems)

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

value (Value format)

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

string

Nur Ausgabe. Der Name des Felds.

string

Nur Ausgabe. Die Beschreibung des Felds.

object (FieldConstraints)

Nur Ausgabe. Informationen zu Eingabeeinschränkungen, die für die Werte für das Feld gelten.

{
  "value": string,
  "description": string,
  "fieldDependencies": [
    {
      object (PolicySchemaFieldDependencies)
    }
  ]
}

string

Nur Ausgabe. Die String-Darstellung des Werts, der für das Feld festgelegt werden kann.

string

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

object (PolicySchemaFieldDependencies)

Nur Ausgabe. Feldbedingungen, die erforderlich sind, damit dieser Wert gültig ist.

{
  "sourceField": string,
  "sourceFieldValue": string
}

string

Das Quellenfeld, von dem dieses Feld abhängt.

string

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

{
  "fieldConditions": [
    string
  ],
  "requiredFields": [
    string
  ]
}

string

Die Werte des Felds, die die Erzwingung von Pflichtfeldern auslösen. Ein leeres FeldConditions impliziert, dass jeder diesem Feld zugewiesene Wert die Erzwingung eines Pflichtfelds auslöst.

string

Die Felder, die aufgrund der Feldbedingungen erforderlich sind.

{
  "numericRangeConstraint": {
    object (NumericRangeConstraint)
  },
  "uploadedFileConstraints": {
    object (UploadedFileConstraints)
  }
}

object (NumericRangeConstraint)

Der zulässige Bereich für numerische Felder.

object (UploadedFileConstraints)

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

{
  "minimum": string,
  "maximum": string
}

string (int64 format)

Minimalwert.

string (int64 format)

Höchstwert.

{
  "supportedContentTypes": [
    enum (ContentType)
  ],
  "sizeLimitBytes": string
}

enum (ContentType)

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

string (int64 format)

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

{
  "field": string,
  "noticeValue": string,
  "noticeMessage": string,
  "acknowledgementRequired": boolean
}

string

Nur Ausgabe. Der Feldname, der mit der Benachrichtigung verknüpft ist.

string

Nur Ausgabe. Der Wert des Felds mit einem Hinweis. Wenn das Feld auf diesen Wert gesetzt wird, muss der Nutzer möglicherweise die Benachrichtigung bestätigen, damit der Wert festgelegt werden kann.

string

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

boolean

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

{
  "deprecatedInFavorOf": [
    string
  ],
  "scheduledToDeprecatePolicies": [
    string
  ],
  "policyApiLifecycleStage": enum (PolicyApiLifecycleEnum),
  "description": string,
  "endSupport": {
    object (Date)
  }
}

string

Für den Fall, dass diese Richtlinie zugunsten einer anderen Richtlinie eingestellt wurde, die vollständig qualifizierten Namespaces der neuen Richtlinien, wie sie in PolicyAPI angezeigt werden. Kann nur festgelegt werden, wenn policyApiLifecycleStage den Wert API_DEPRECATED hat.

string

Die vollständig qualifizierten Namespaces der alten Richtlinien, die aufgrund der Einführung dieser Richtlinie eingestellt werden, entsprechen dem Thema „InFavorOf“, das eingestellt wurde.

enum (PolicyApiLifecycleEnum)

Gibt die aktuelle Lebenszyklusphase der Richtlinien-API an.

string

Beschreibung des aktuellen Lebenszyklus.

object (Date)

Enddatum der Unterstützung für die aktuelle Richtlinie. Der Versuch, eine Richtlinie nach ihrem Enddatum zu ändern, führt zu einer ungültigen Anfrage (Fehler 400). Kann nur festgelegt werden, wenn policyApiLifecycleStage den Wert API_DEPRECATED hat.

{
  "year": integer,
  "month": integer,
  "day": integer
}

integer

Jahr des Datums. Muss zwischen 1 und 9999 liegen oder 0, um ein Datum ohne Jahr anzugeben.

integer

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

integer

Tag im Monat. Muss zwischen 1 und 31 liegen und für das Jahr und den Monat gültig sein, oder 0, um ein Jahr allein oder ein Jahr und Monat anzugeben, wenn der Tag nicht von Bedeutung ist.