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

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

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.

object (FileDescriptorProto)

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

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.

string

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

object (PolicySchemaNoticeDescription)

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

string

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

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.

enum (TargetResource)

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

object (PolicyApiLifecycle)

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

string

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

enum (Platform)

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

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

string

Nom de clé

string

Description de la clé.

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

string

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

string

Ex. : "foo", "foo.bar", etc.

object (DescriptorProto)

Toutes les définitions de premier niveau de ce fichier.

object (EnumDescriptorProto)

string

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

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

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

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.

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).

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.

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.

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.

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 à une propriété oneof 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 ayant 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.

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

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

string

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

string

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

object (PolicySchemaFieldKnownValueDescription)

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

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.

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.

object (PolicySchemaRequiredItems)

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

value (Value format)

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

string

Uniquement en sortie. Nom du champ.

string

Uniquement en sortie. Description du champ.

object (FieldConstraints)

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

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

string

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

string

Uniquement en sortie. Description supplémentaire pour cette valeur.

object (PolicySchemaFieldDependencies)

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

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

string

Champ source dont dépend ce champ.

string

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

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

string

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

string

Champs obligatoires en raison des conditions du champ.

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

object (NumericRangeConstraint)

Plage autorisée pour les champs numériques.

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.

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

string (int64 format)

Valeur minimale.

string (int64 format)

Valeur maximale.

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

enum (ContentType)

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

string (int64 format)

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

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

string

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

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.

string

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

boolean

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

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

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.

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.

enum (PolicyApiLifecycleEnum)

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

string

Description du cycle de vie en cours.

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.

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

integer

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

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.

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.