Recurso: Schema
Es el tipo de recurso de la API. Para los recursos de esquema, siempre es admin#directory#schema
.
Representación JSON |
---|
{
"schemaId": string,
"schemaName": string,
"fields": [
{
object ( |
Campos | |
---|---|
schemaId |
El identificador único del esquema (solo lectura) |
schemaName |
El nombre del esquema. Cada |
fields[] |
Una lista de campos en el esquema. |
displayName |
Es el nombre visible del esquema. |
kind |
Este es el tipo de recurso. |
etag |
La ETag del recurso |
SchemaFieldSpec
Puedes usar esquemas para agregar campos personalizados a los perfiles de usuario. Puede utilizar estos campos para almacenar información como los proyectos en los que trabajan los usuarios, sus ubicaciones físicas, sus fechas de contratación o cualquier otro dato que se ajuste a las necesidades de su empresa. Para obtener más información, consulta Campos de usuario personalizados.
Representación JSON |
---|
{ "fieldName": string, "fieldId": string, "fieldType": string, "multiValued": boolean, "kind": string, "etag": string, "indexed": boolean, "displayName": string, "readAccessType": string, "numericIndexingSpec": { "minValue": number, "maxValue": number } } |
Campos | |
---|---|
fieldName |
El nombre del campo |
fieldId |
El identificador único del campo (solo lectura) |
fieldType |
Es el tipo del campo. Los valores aceptables son:
|
multiValued |
Booleano que especifica si se trata de un campo con valores múltiples o no. Valor predeterminado: |
kind |
El tipo de recurso es este. Para los campos de esquema, siempre es |
etag |
La ETag del campo |
indexed |
Es un valor booleano que especifica si el campo está indexado o no. Valor predeterminado: |
displayName |
Nombre visible del campo. |
readAccessType |
Especifica quién puede ver los valores de este campo. Para obtener más información, consulta Recuperar usuarios como no administradores. Nota: Los cambios en este campo pueden tardar hasta 24 horas en reflejarse. Los valores aceptables son:
|
numericIndexingSpec |
Especificación de indexación para un campo numérico. De forma predeterminada, solo se admitirán consultas de concordancia exacta para los campos numéricos. Si estableces |
numericIndexingSpec.minValue |
Valor mínimo de este campo. El propósito de esto es ser indicativo y no obligatorio. Los valores fuera de este rango se indexarán, pero es posible que la búsqueda no tenga el mismo rendimiento. |
numericIndexingSpec.maxValue |
Valor máximo de este campo. El propósito de esto es ser indicativo y no obligatorio. Los valores fuera de este rango se indexarán, pero es posible que la búsqueda no tenga el mismo rendimiento. |
Métodos |
|
---|---|
|
Borra un esquema. |
|
Recupera un esquema. |
|
Crea un esquema. |
|
Recupera todos los esquemas de un cliente. |
|
Aplica parches a un esquema. |
|
Actualiza un esquema. |