REST Resource: customers.policySchemas

Ressource: PolicySchema

Ressource représentant un schéma de stratégie.

Représentation 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,
  "supportedPlatforms": [
    enum (Platform)
  ]
}
Champs
name

string

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

string

Uniquement en sortie. Description du schéma de règle pour la consommation par les utilisateurs.
additionalTargetKeyNames[]

object (AdditionalTargetKeyName)

Uniquement en sortie. Noms de clés supplémentaires qui seront utilisés pour identifier la cible de la valeur de la règle. Lorsque vous spécifiez un policyTargetKey, chacune des clés supplémentaires spécifiées ici doit être incluse dans le mappage additionalTargetKeys.
definition

object (FileDescriptorProto)

Définition du schéma à l'aide du descripteur proto
fieldDescriptions[]

object (PolicySchemaFieldDescription)

Uniquement en sortie. Description détaillée de chaque champ faisant partie du schéma. Les champs sont suggérés en fonction de l'ordre dans cette liste, et non de leur numéro.
accessRestrictions[]

string

Uniquement en sortie. Restrictions d'accès spécifiques associées à cette règle.
notices[]

object (PolicySchemaNoticeDescription)

Uniquement en sortie. Messages d'avertissement particuliers concernant la définition de valeurs dans certains champs du schéma.
supportUri

string

Uniquement en sortie. URI de l'article d'aide associé à ce schéma.
schemaName

string

Uniquement en sortie. Nom complet du schéma de stratégie. Cette valeur permet de remplir le champ policySchema dans PolicyValue lorsque vous appelez BatchInheritOrgUnitPolicies BatchModifyOrgUnitPolicies BatchModifyGroupPolicies ou BatchDeleteGroupPolicies.
validTargetResources[]

enum (TargetResource)

Uniquement en sortie. Informations sur les ressources cibles applicables à la stratégie.
policyApiLifecycle

object (PolicyApiLifecycle)

Uniquement en sortie. Informations sur le cycle de vie actuel.
categoryTitle

string

Titre de la catégorie à laquelle appartient un paramètre.
supportedPlatforms[]

enum (Platform)

Uniquement en sortie. "List" indique que la règle ne s'appliquera qu'aux appareils/utilisateurs de ces plates-formes.

AdditionalTargetKeyName

Noms de clés supplémentaires qui seront utilisés pour identifier la cible de la valeur de la règle.

Représentation JSON 
{
  "key": string,
  "keyDescription": string
}
Champs
key

string

Nom de clé
keyDescription

string

Description de la clé.

FileDescriptorProto

Décrit un fichier .proto complet.

Représentation JSON 
{
  "name": string,
  "package": string,
  "messageType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "syntax": string,
}
Champs
name

string

nom du fichier, par rapport à la racine de l'arborescence source
package

string

Ex. : "foo", "foo.bar", etc.
messageType[]

object (DescriptorProto)

Toutes les définitions de premier niveau de ce fichier.
enumType[]

object (EnumDescriptorProto)
syntax

string

Syntaxe du fichier proto. Les valeurs acceptées sont "proto2", "proto3" et "editions".

Si edition est présent, cette valeur doit correspondre à "editions".

DescriptorProto

Décrit un type de message.

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

string
field[]

object (FieldDescriptorProto)
nestedType[]

object (DescriptorProto)
enumType[]

object (EnumDescriptorProto)
oneofDecl[]

object (OneofDescriptorProto)

FieldDescriptorProto

Décrit un champ dans un message.

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

string
number

integer
label

enum (Label)
type

enum (Type)

Si typeName est défini, il n'est pas nécessaire de le définir. Si ce paramètre et le typeName sont tous deux définis, il doit s'agir de TYPE_ENUM, TYPE_MESSAGE ou TYPE_GROUP.
typeName

string

Pour les types message et énumération, il s'agit du nom du type. Si le nom commence par ".", il est complet. Sinon, des règles de champ d'application de type C++ sont utilisées pour trouver le type (par exemple, la recherche est d'abord effectuée sur les types imbriqués dans ce message, puis dans le parent, jusqu'à l'espace de noms racine).
defaultValue

string

Pour les types numériques, contient la représentation textuelle d'origine de la valeur. Pour les valeurs booléennes, "true" ou "false". Pour les chaînes, contient le contenu textuel par défaut (sans échappement). Pour les octets, contient la valeur d'échappement C. Tous les octets ≥ à 128 sont échappés.
oneofIndex

integer

S'il est défini, donne l'index d'un objet oneof dans la liste oneofDecl du type conteneur. Ce champ fait partie de celui-ci.
jsonName

string

Nom JSON de ce champ. La valeur est définie par le compilateur de protocole. Si l'utilisateur a défini un "jsonName" l'option sur ce champ, la valeur de cette option sera utilisée. Sinon, il est déduit du nom du champ en le convertissant en camelCase.
proto3Optional

boolean

Si la valeur est "true", il s'agit d'un proto3 "facultatif". Lorsqu'un champ proto3 est facultatif, il suit la présence, quel que soit le type de champ.

Lorsque proto3Optional est défini sur "true", ce champ doit appartenir à un ensemble pour signaler aux anciens clients proto3 que la présence de ce champ est suivie. Celui-ci est appelé "synthétique" oneof, qui doit être son seul membre (chaque champ facultatif proto3 possède son propre oneof synthétique). Les Oneof synthétiques n'existent que dans le descripteur et ne génèrent aucune API. Les Oneof synthétiques doivent être commandés après tous les "vrais" Oneofs.

Pour les champs de message, proto3Optional ne crée aucune modification sémantique, car les champs de message non répétés suivent toujours la présence. Toutefois, elle indique toujours le détail sémantique qui détermine si l'utilisateur a écrit "facultatif" ou non. ou non. Cela peut être utile pour l'aller-retour du fichier .proto. Par souci de cohérence, nous attribuons également aux champs de message un oneof synthétique, même s'il n'est pas nécessaire pour suivre la présence. Ce point est particulièrement important, car l'analyseur ne peut pas déterminer si un champ est un message ou une énumération. Il doit donc toujours créer un oneof synthétique.

Les champs facultatifs Proto2 ne définissent pas cet indicateur, car ils indiquent déjà facultatifs avec LABEL_OPTIONAL.

Libellé

Enums
LABEL_OPTIONAL La valeur 0 est réservée aux erreurs
LABEL_REPEATED
LABEL_REQUIRED L'étiquette obligatoire n'est autorisée que dans proto2. Elle est explicitement interdite dans proto3 et les éditions. Dans les éditions, la fonctionnalité fieldPresence peut être utilisée pour obtenir ce comportement.

Type

Enums
TYPE_DOUBLE La valeur 0 est réservée aux erreurs. L'ordre est bizarre pour des raisons historiques.
TYPE_FLOAT
TYPE_INT64 Non codé en ZigZag. Les nombres négatifs prennent 10 octets. Utilisez TYPE_SINT64 si des valeurs négatives sont probables.
TYPE_UINT64
TYPE_INT32 Non codé en ZigZag. Les nombres négatifs prennent 10 octets. Utilisez TYPE_SINT32 si des valeurs négatives sont probables.
TYPE_FIXED64
TYPE_FIXED32
TYPE_BOOL
TYPE_STRING
TYPE_GROUP Agrégat délimité par des tags. type de groupe est obsolète et n'est pas pris en charge après proto2. Toutefois, les implémentations Proto3 devraient toujours être en mesure d'analyser le format de transmission du groupe et de traiter les champs de groupe comme des champs inconnus. Dans les éditions, le format de fil de groupe peut être activé via la fonctionnalité messageEncoding.
TYPE_MESSAGE Agrégat délimité par la longueur.
TYPE_BYTES Nouveauté de la version 2.
TYPE_UINT32
TYPE_ENUM
TYPE_SFIXED32
TYPE_SFIXED64
TYPE_SINT32 Utilise l'encodage ZigZag.
TYPE_SINT64 Utilise l'encodage ZigZag.

EnumDescriptorProto

Décrit un type d'énumération.

Représentation JSON 
{
  "name": string,
  "value": [
    {
      object (EnumValueDescriptorProto)
    }
  ]
}
Champs
name

string
value[]

object (EnumValueDescriptorProto)

EnumValueDescriptorProto

Décrit une valeur dans une énumération.

Représentation JSON 
{
  "name": string,
  "number": integer
}
Champs
name

string
number

integer

OneofDescriptorProto

Décrit un oneof.

Représentation JSON 
{
  "name": string
}
Champs
name

string

PolicySchemaFieldDescription

Fournit des informations détaillées sur un champ particulier faisant partie d'un PolicySchema.

Représentation 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)
  }
}
Champs
field

string

Uniquement en sortie. Nom du champ associé à cette description.
description
(deprecated)

string

Obsolète. Utilisez plutôt name et fieldDescription. Description du champ.
inputConstraint

string

Uniquement en sortie. Toute contrainte d'entrée associée aux valeurs du champ.
knownValueDescriptions[]

object (PolicySchemaFieldKnownValueDescription)

Uniquement en sortie. Si le champ comporte un ensemble de valeurs connues, ce champ fournira une description de ces valeurs.
nestedFieldDescriptions[]

object (PolicySchemaFieldDescription)

Uniquement en sortie. Fournit la description des champs imbriqués dans ce champ s'il s'agit d'un type de message qui définit plusieurs champs. Les champs sont suggérés en fonction de l'ordre dans cette liste, et non de leur numéro.
fieldDependencies[]

object (PolicySchemaFieldDependencies)

Uniquement en sortie. Fournit une liste de champs et de valeurs. Au moins un des champs doit avoir la valeur correspondante pour que ce champ puisse être défini.
requiredItems[]

object (PolicySchemaRequiredItems)

Uniquement en sortie. Fournit la liste des champs à définir si la valeur du champ est définie.
defaultValue

value (Value format)

Uniquement en sortie. Valeur par défaut du client si la règle n'est pas configurée.
name

string

Uniquement en sortie. Nom du champ.
fieldDescription

string

Uniquement en sortie. Description du champ.
fieldConstraints

object (FieldConstraints)

Uniquement en sortie. Informations sur les contraintes d'entrée associées aux valeurs du champ.

PolicySchemaFieldKnownValueDescription

Fournit des informations détaillées sur une valeur connue autorisée pour un champ particulier dans PolicySchema.

Représentation JSON 
{
  "value": string,
  "description": string,
  "fieldDependencies": [
    {
      object (PolicySchemaFieldDependencies)
    }
  ]
}
Champs
value

string

Uniquement en sortie. Chaîne représentant la valeur pouvant être définie pour le champ.
description

string

Uniquement en sortie. Description supplémentaire pour cette valeur.
fieldDependencies[]

object (PolicySchemaFieldDependencies)

Uniquement en sortie. Les conditions du champ sont obligatoires pour que cette valeur soit valide.

PolicySchemaFieldDependencies

Le champ et la valeur qu'il doit avoir pour qu'un autre champ puisse être défini.

Représentation JSON 
{
  "sourceField": string,
  "sourceFieldValue": string
}
Champs
sourceField

string

Champ source dont dépend ce champ.
sourceFieldValue

string

Valeur que le champ source doit avoir pour que ce champ puisse être défini.

PolicySchemaRequiredItems

Champs qui deviendront obligatoires en fonction de la valeur de ce champ.

Représentation JSON 
{
  "fieldConditions": [
    string
  ],
  "requiredFields": [
    string
  ]
}
Champs
fieldConditions[]

string

Valeur(s) du champ qui déclenche l'application forcée du champ. Un champ fieldConditions vide signifie que toute valeur attribuée à ce champ déclenchera l'application forcée du champ obligatoire.
requiredFields[]

string

Champs obligatoires en raison des conditions du champ.

FieldConstraints

Informations sur les contraintes de plage.

Représentation JSON 
{
  "numericRangeConstraint": {
    object (NumericRangeConstraint)
  },
  "uploadedFileConstraints": {
    object (UploadedFileConstraints)
  }
}
Champs
numericRangeConstraint

object (NumericRangeConstraint)

Plage autorisée pour les champs numériques.
uploadedFileConstraints

object (UploadedFileConstraints)

Contraintes appliquées au fichier importé d'une règle de fichier. Si cette règle est présente, cette règle nécessite une URL qui peut être récupérée en important un fichier avec les contraintes spécifiées dans ce proto.

NumericRangeConstraint

Contrainte appliquée aux limites supérieure et/ou inférieure, au moins une étant définie.

Représentation JSON 
{
  "minimum": string,
  "maximum": string
}
Champs
minimum

string (int64 format)

Valeur minimale.
maximum

string (int64 format)

Valeur maximale.

UploadedFileConstraints

Contraintes appliquées au fichier importé d'une règle de fichier.

Représentation JSON 
{
  "supportedContentTypes": [
    enum (ContentType)
  ],
  "sizeLimitBytes": string
}
Champs
supportedContentTypes[]

enum (ContentType)

Types de fichiers pouvant être importés pour un paramètre.
sizeLimitBytes

string (int64 format)

Taille maximale des fichiers importés pour un paramètre, en octets.

ContentType

Types de fichiers pouvant être importés pour un paramètre.

Enums
CONTENT_TYPE_UNSPECIFIED Type de contenu non spécifié.
CONTENT_TYPE_PLAIN_TEXT Texte brut.
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

Fournit des messages d'avis spéciaux liés à une valeur particulière dans un champ faisant partie d'un PolicySchema.

Représentation JSON 
{
  "field": string,
  "noticeValue": string,
  "noticeMessage": string,
  "acknowledgementRequired": boolean
}
Champs
field

string

Uniquement en sortie. Nom de champ associé à la notification.
noticeValue

string

Uniquement en sortie. Valeur du champ qui comporte une notification. Lorsque vous définissez le champ sur cette valeur, l'utilisateur peut être tenu d'accuser réception du message de notification pour que la valeur soit définie.
noticeMessage

string

Uniquement en sortie. Le message d'avertissement associé à la valeur du champ.
acknowledgementRequired

boolean

Uniquement en sortie. Indique si l'utilisateur doit accuser réception du message de notification avant de pouvoir définir la valeur.

TargetResource

Types de ressources cibles

Enums
TARGET_RESOURCE_UNSPECIFIED Ressource cible non spécifiée.
ORG_UNIT Ressource cible de l'unité organisationnelle.
GROUP ressource cible du groupe.

PolicyApiLifecycle

Informations sur le cycle de vie.

Représentation JSON 
{
  "deprecatedInFavorOf": [
    string
  ],
  "scheduledToDeprecatePolicies": [
    string
  ],
  "policyApiLifecycleStage": enum (PolicyApiLifecycleEnum),
  "description": string,
  "endSupport": {
    object (Date)
  }
}
Champs
deprecatedInFavorOf[]

string

Si cette règle est abandonnée au profit d'une autre, le ou les espaces de noms complets des nouvelles règles, tels qu'ils apparaîtront dans PolicyAPI. Ne peut être défini que si policyApiLifecycleStage est défini sur API_DEPRECATED.
scheduledToDeprecatePolicies[]

string

Correspond à obsolèteInFavorOf, le ou les espaces de noms complets des anciennes règles qui seront abandonnées en raison de l'introduction de cette règle.
policyApiLifecycleStage

enum (PolicyApiLifecycleEnum)

Indique l'étape actuelle du cycle de vie de l'API Policy.
description

string

Description du cycle de vie en cours.
endSupport

object (Date)

Date de fin de prise en charge du règlement actuel. Toute tentative de modification d'une stratégie après sa date de fin de prise en charge entraînera une requête incorrecte (erreur 400). Ne peut être défini que si policyApiLifecycleStage est défini sur API_DEPRECATED.

PolicyApiLifecycleEnum

Étape du cycle de vie de l'API Policy.

Enums
API_UNSPECIFIED Le cycle de vie de l'API Policy n'est pas spécifié.
API_PREVIEW Les règles ne fonctionnent pas encore, mais elles permettent aux développeurs de prévenir les problèmes de format. Cette étape peut être transférée vers API_DEVELOPEMNT ou API_CURRENT.
API_DEVELOPMENT La règle peut modifier le format de manière incompatible avec les versions antérieures (modification destructive). Cette étape peut être transférée vers API_CURRENT ou API_DEPRECATED. Vous pouvez l'utiliser pour les règles destinées uniquement aux TT ou destinées à certains clients à des fins d'urgence.
API_CURRENT Règlement dans son format officiel La règle peut modifier le format de manière rétrocompatible (modification non destructive). Exemple: Cette règle peut introduire un nouveau champ, considéré comme une modification non destructive, lorsque les masques de champ sont correctement utilisés. Cette étape peut être transférée vers API_DEPRECATED.
API_DEPRECATED Veuillez cesser d'utiliser cette règle. Cette règle étant obsolète, elle est susceptible d'être supprimée ou sera supprimée à l'avenir. Une nouvelle règle a très probablement été introduite pour remplacer celle-ci.

Date

Représente une date du calendrier entière ou partielle, par exemple un anniversaire. L'heure de la journée et le fuseau horaire sont spécifiés ailleurs, ou ne sont pas significatifs. La date est donnée selon le calendrier grégorien. Il peut s'agir de l'un des éléments suivants:

  • Une date complète, avec des valeurs non nulles pour l'année, le mois et le jour.
  • Un mois et un jour, avec une année nulle (par exemple, un anniversaire).
  • une année seule, avec un mois et un jour zéro.
  • Une année et un mois, avec un jour zéro (par exemple, la date d'expiration d'une carte de crédit).

Types associés:

Représentation JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Champs
year

integer

Année de la date. Doit être comprise entre 1 et 9999, ou 0 pour indiquer une date sans année.
month

integer

Mois de l'année. La valeur doit être comprise entre 1 et 12, ou égale à 0 pour spécifier une année sans mois ni jour.
day

integer

Jour du mois. Doit être compris entre 1 et 31, et valide pour l'année et le mois, ou 0 pour indiquer une année seule, ou une année et un mois où le jour n'est pas significatif.

Plate-forme

Il s'agit d'une énumération des différents groupes de plates-formes sur lesquels Chrome est pris en charge.

Enums
PLATFORM_UNSPECIFIED Plate-forme non spécifiée.
CHROME_OS ChromeOS :
CHROME_BROWSER Navigateur Chrome pour OSX/Windows/Linux
CHROME_BROWSER_FOR_ANDROID Navigateur Chrome pour Android
CHROME_BROWSER_FOR_IOS Navigateur Chrome pour iOS

Méthodes

get

 Obtenez un schéma de stratégie spécifique pour un client en fonction de son nom de ressource.

list

 Récupère la liste des schémas de règles qui correspondent à une valeur de filtre spécifiée pour un client donné.