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

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

string

Solo salida. Descripción del esquema de políticas para el consumo de los usuarios.

object (AdditionalTargetKeyName)

Solo salida. Nombres de claves adicionales que se usarán para identificar el destino del valor de la política. Cuando se especifica un policyTargetKey, cada una de las claves adicionales especificadas aquí deberá incluirse en el mapa additionalTargetKeys.

object (FileDescriptorProto)

Definición de esquema con el descriptor proto.

object (PolicySchemaFieldDescription)

Solo salida. Descripción detallada de cada campo que forma parte del esquema. Se sugiere que los campos se muestren según el orden en esta lista y no por el número de campo.

string

Solo salida. Restricciones de acceso específicas relacionadas con esta política.

object (PolicySchemaNoticeDescription)

Solo salida. Mensajes de aviso especial relacionados con la configuración de ciertos valores en ciertos campos del esquema.

string

Solo salida. Es el URI del artículo de asistencia relacionado para este esquema.

string

Solo salida. El nombre completamente calificado del esquema de política. Este valor se usa para completar el campo policySchema en PolicyValue cuando se llama a BatchInheritOrgUnitPolicies BatchModifyOrgUnitPolicies BatchModifyGroupPolicies o BatchDeleteGroupPolicies.

enum (TargetResource)

Solo salida. Información sobre los recursos de destino aplicables a la política.

object (PolicyApiLifecycle)

Solo salida. Información actual del ciclo de vida.

string

Título de la categoría a la que pertenece un parámetro de configuración.

enum (Platform)

Solo salida. La lista indica que la política solo se aplicará a los dispositivos o usuarios en estas plataformas.

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

string

Nombre de la clave.

string

Descripción de la clave.

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

string

nombre del archivo, en relación con la raíz del árbol de fuentes

string

p.ej., "foo", "foo.bar", etc.

object (DescriptorProto)

Todas las definiciones de nivel superior de este archivo.

object (EnumDescriptorProto)

string

La sintaxis del archivo proto. Los valores admitidos son "proto2", "proto3" y "editions".

Si hay edition, este valor debe ser "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 se establece typeName, no es necesario establecerlo. Si se configuran este campo y typeName, este debe ser TYPE_ENUM, TYPE_MESSAGE o TYPE_GROUP.

string

Para los tipos de mensaje y enumeración, este es el nombre del tipo. Si el nombre comienza con “.”, significa que está completamente calificado. De lo contrario, se usan reglas de alcance similares a C++ para encontrar el tipo (es decir, primero se buscan los tipos anidados dentro de este mensaje y, luego, en el elemento superior, hasta el espacio de nombres raíz).

string

Para los tipos numéricos, contiene la representación de texto original del valor. Para valores booleanos, “verdadero” o “false”. Para cadenas, contiene el contenido de texto predeterminado (sin escape de ninguna manera). Para bytes, contiene el valor de escape C. Todos los bytes >= 128 tienen caracteres de escape.

integer

Si se establece, muestra el índice de un oneof en la lista oneofDecl del tipo contenedor. Este campo forma parte de ese campo.

string

Es el nombre JSON de este campo. El compilador de protocolos establece el valor. Si el usuario estableció un valor "jsonName" en este campo, se usará el valor de esa opción. De lo contrario, se deduce a partir del nombre del campo convirtiéndolo a camelCase.

boolean

Si es verdadero, este es un proto3 "opcional". Cuando un campo proto3 es opcional, realiza un seguimiento de la presencia independientemente del tipo de campo.

Cuando proto3Optional es verdadero, este campo debe pertenecer a uno de los siguientes para indicar a los clientes de proto3 anteriores que se realiza un seguimiento de la presencia de este campo. Este se conoce como “sintético” uno de los campos y este debe ser su único miembro (cada campo opcional de proto3 tiene su propio uno sintético). Los oneofs sintéticos existen solo en el descriptor y no generan ninguna API. Los caracteres sintéticos deben ordenarse después de todos los caracteres “reales” es una de ellas.

Para los campos de mensaje, proto3Optional no crea ningún cambio semántico, ya que los campos de mensaje no repetidos siempre realizan un seguimiento de la presencia. Sin embargo, todavía indica el detalle semántico de si el usuario escribió "opcional". o no. Esto puede ser útil para recorrer el archivo .proto. Por motivos de coherencia, también otorgamos un campo sintético a los campos de mensaje, aunque no es necesario para realizar un seguimiento de la presencia. Esto es muy importante porque el analizador no puede saber si un campo es un mensaje o una enumeración, por lo que siempre debe crear uno sintético.

Los campos opcionales de Proto2 no configuran esta marca, porque ya indican que es opcional con 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

Solo salida. El nombre del campo asociado con esta descripción.

string

Obsoleta. En su lugar, usa name y fieldDescription. La descripción del campo.

string

Solo salida. Cualquier restricción de entrada asociada a los valores del campo.

object (PolicySchemaFieldKnownValueDescription)

Solo salida. Si el campo tiene un conjunto de valores conocidos, proporcionará una descripción para esos valores.

object (PolicySchemaFieldDescription)

Solo salida. Proporciona la descripción de los campos anidados en este campo, si el campo es de un tipo de mensaje que define varios campos. Se sugiere que los campos se muestren según el orden en esta lista y no por el número de campo.

object (PolicySchemaFieldDependencies)

Solo salida. Proporciona una lista de campos y valores. Al menos uno de los campos debe tener el valor correspondiente para que se pueda establecer este campo.

object (PolicySchemaRequiredItems)

Solo salida. Proporciona una lista de campos que se deben configurar si este campo tiene un valor determinado.

value (Value format)

Solo salida. Configuración predeterminada del cliente si no se establece la política.

string

Solo salida. El nombre del campo

string

Solo salida. La descripción del campo.

object (FieldConstraints)

Solo salida. Información sobre las restricciones de entrada asociadas a los valores del campo.

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

string

Solo salida. La representación de cadena del valor que se puede establecer para el campo.

string

Solo salida. Es la descripción adicional de este valor.

object (PolicySchemaFieldDependencies)

Solo salida. Son las condiciones de campo obligatorias para que este valor sea válido.

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

string

El campo de origen del que depende este campo.

string

Es el valor que debe tener el campo de origen para que se pueda configurar este campo.

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

string

Los valores del campo que provocan la aplicación forzosa del campo obligatorio. Un fieldConditions vacío implica que cualquier valor asignado a este campo provocará la aplicación obligatoria del campo.

string

Son los campos que son obligatorios como consecuencia de las condiciones del campo.

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

object (NumericRangeConstraint)

El rango permitido para los campos numéricos.

object (UploadedFileConstraints)

Las restricciones del archivo subido de una política de archivo Si está presente, esta política requiere una URL que se pueda recuperar subiendo un archivo con las restricciones especificadas en este proto.

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

string (int64 format)

Valor mínimo.

string (int64 format)

Valor máximo

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

enum (ContentType)

Tipos de archivos que se pueden subir para un parámetro de configuración.

string (int64 format)

Es el límite, en bytes, de los archivos subidos para un parámetro de configuración.

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

string

Solo salida. El nombre del campo asociado con el aviso.

string

Solo salida. El valor del campo que tiene un aviso. Cuando se configura el campo en este valor, es posible que el usuario deba confirmar el mensaje de aviso para establecer el valor.

string

Solo salida. El mensaje de aviso asociado con el valor del campo.

boolean

Solo salida. Si el usuario debe confirmar o no el mensaje de aviso antes de que se pueda establecer el valor.

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

string

En el caso de que esta política deje de estar disponible en favor de otra política, los espacios de nombres completamente calificados de las políticas nuevas como se mostrarán en PolicyAPI. Solo se puede configurar si policyApiLifecycleStage es API_DEPRECATED.

string

Los espacios de nombres completamente calificados de las políticas anteriores que dejarán de estar disponibles debido a la introducción de esta política y corresponde a obsoletosInFavorOf.

enum (PolicyApiLifecycleEnum)

Indica la etapa del ciclo de vida actual de la API de políticas.

string

Descripción del ciclo de vida actual.

object (Date)

Fecha de finalización de la compatibilidad de la política actual. Si intentas modificar una política después de su fecha de finalización de la asistencia, se generará una solicitud incorrecta (error 400). Solo se puede configurar si policyApiLifecycleStage es API_DEPRECATED.

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

integer

Año de la fecha. Debe ser entre 1 y 9,999, o bien 0 para especificar una fecha sin año.

integer

Mes del año. Debe ser del 1 al 12 o 0 para especificar un año sin un mes ni un día.

integer

Día del mes. Debe ser entre 1 y 31 y ser válido para el año y el mes o bien 0 para especificar un año solo o un año y un mes en los que el día no sea significativo.