REST Resource: schemas

Ressource: schéma

Type de ressource API. Pour les ressources de schéma, cette valeur est toujours admin#directory#schema.

Représentation JSON 
{
  "schemaId": string,
  "schemaName": string,
  "fields": [
    {
      object (SchemaFieldSpec)
    }
  ],
  "displayName": string,
  "kind": string,
  "etag": string
}
Champs
schemaId

string

Identifiant unique du schéma (lecture seule)
schemaName

string

Nom du schéma.

Chaque schemaName doit être unique pour un client. La réutilisation d'un nom génère une erreur 409: Entity already exists.
fields[]

object (SchemaFieldSpec)

Liste des champs du schéma.
displayName

string

Nom à afficher pour le schéma.
kind

string

Type de ressource
etag

string

ETag de la ressource.

SchemaFieldSpec

Vous pouvez utiliser des schémas pour ajouter des champs personnalisés aux profils utilisateur. Vous pouvez utiliser ces champs pour stocker des informations telles que les projets sur lesquels travaillent vos utilisateurs, leur lieu de résidence, leurs dates d'embauche ou tout autre élément adapté aux besoins de votre entreprise. Pour en savoir plus, consultez Champs utilisateur personnalisés.

Représentation JSON 
{
  "fieldName": string,
  "fieldId": string,
  "fieldType": string,
  "multiValued": boolean,
  "kind": string,
  "etag": string,
  "indexed": boolean,
  "displayName": string,
  "readAccessType": string,
  "numericIndexingSpec": {
    "minValue": number,
    "maxValue": number
  }
}
Champs
fieldName

string

Nom du champ.
fieldId

string

Identifiant unique du champ (lecture seule)
fieldType

string

Type du champ.

Les valeurs acceptées sont les suivantes :

  • BOOL: valeurs booléennes.
  • DATE: dates au format ISO-8601.
  • DOUBLE: valeurs à virgule flottante à double précision.
  • EMAIL: adresses e-mail.
  • INT64: valeurs entières de 64 bits.
  • PHONE: numéros de téléphone.
  • STRING: valeurs de chaîne.
multiValued

boolean

Valeur booléenne indiquant si ce champ est multi-valeur ou non. Valeur par défaut : false
kind

string

Type de ressource dont il s'agit. Pour les champs de schéma, la valeur est toujours admin#directory#schema#fieldspec.
etag

string

ETag du champ.
indexed

boolean

Booléen spécifiant si le champ est indexé ou non. Valeur par défaut : true
displayName

string

Nom à afficher du champ.
readAccessType

string

Spécifie qui peut afficher les valeurs de ce champ. Pour en savoir plus, consultez Récupérer des utilisateurs en tant que non-administrateur.

Remarque: La prise en compte des modifications apportées à ce champ peut prendre jusqu'à 24 heures.

Les valeurs acceptées sont les suivantes :

  • ADMINS_AND_SELF: seuls les administrateurs et l'utilisateur associé peuvent voir les valeurs.
  • ALL_DOMAIN_USERS: tous les utilisateurs de votre domaine peuvent voir les valeurs.
numericIndexingSpec

object

Spécification d'indexation pour un champ numérique. Par défaut, seules les requêtes de correspondance exacte sont acceptées pour les champs numériques. Définir numericIndexingSpec permet de prendre en charge les requêtes de plage.
numericIndexingSpec.minValue

number

Valeur minimale de ce champ. Il s'agit d'une indication, et non d'une obligation. Les valeurs situées en dehors de cette plage seront toujours indexées, mais la recherche risque de ne pas être aussi performante.
numericIndexingSpec.maxValue

number

Valeur maximale de ce champ. Il s'agit d'une indication, et non d'une obligation. Les valeurs situées en dehors de cette plage seront tout de même indexées, mais la recherche risque de ne pas être aussi performante.

Méthodes

delete

 Supprime un schéma.

get

 Récupère un schéma.

insert

 Crée un schéma.

list

 Récupère tous les schémas d'un client.

patch

 Applique un correctif à un schéma.

update

 Met à jour un schéma.