REST Resource: customers.v2.Schemas

Ressource : Schéma

Extrait de la section 7 de la RFC 7643. Spécifie les métadonnées d'un schéma.

Représentation JSON 
{
  "attributes": [
    {
      object (Attribute)
    }
  ],
  "id": string,
  "name": string,
  "description": string
}
Champs
attributes[]

object (Attribute)

Obligatoire. Liste des attributs du schéma.
id

string

Obligatoire. URI unique du schéma. Le cas échéant, les fournisseurs de services doivent spécifier l'URI, par exemple urn:ietf:params:scim:schemas:core:2.0:User. Contrairement à la plupart des autres schémas, qui utilisent une sorte d'identifiant unique global (GUID) pour id, le schéma id est un URI afin qu'il puisse être enregistré et portable entre différents fournisseurs de services et clients.
name

string

Facultatif. Nom lisible du schéma. Le cas échéant, les fournisseurs de services doivent spécifier le nom, par exemple User ou Group.
description

string

Facultatif. Description lisible du schéma. Le cas échéant, les fournisseurs de services doivent spécifier la description.

Attribut

Extrait de la section 7 de la RFC 7643. Définit les caractéristiques d'un attribut.

Représentation JSON 
{
  "subAttributes": [
    {
      object (Attribute)
    }
  ],
  "canonicalValues": [
    string
  ],
  "referenceTypes": [
    string
  ],
  "name": string,
  "type": string,
  "multiValued": boolean,
  "description": string,
  "required": boolean,
  "caseExact": boolean,
  "mutability": string,
  "returned": string,
  "uniqueness": string
}
Champs
subAttributes[]

object (Attribute)

Lorsqu'un attribut est de type complex, subAttributes définit un ensemble de sous-attributs. subAttributes comporte les mêmes sous-attributs de schéma que attributes.
canonicalValues[]

string

Facultatif. Collection de valeurs canoniques suggérées pouvant être utilisées (par exemple, work et home). Dans certains cas, les fournisseurs de services peuvent choisir d'ignorer les valeurs non compatibles.
referenceTypes[]

string

Tableau à valeurs multiples de chaînes JSON indiquant les types de ressources SCIM pouvant être référencés. Les valeurs admises sont les suivantes :

  • Un type de ressource SCIM (par exemple, User ou Group)
  • external : indique que la ressource est une ressource externe (par exemple, une photo).
  • uri : indique que la référence concerne un point de terminaison de service ou un identifiant (par exemple, un URN de schéma).

Cet attribut ne s'applique qu'aux attributs de type reference (section 2.3.7).
name

string

Nom de l'attribut.
type

string

Type de données de l'attribut. Les valeurs valides sont string, boolean, decimal, integer, dateTime, reference et complex. Lorsqu'un attribut est de type complex, un attribut de schéma subAttributes correspondant doit être défini, listant les sous-attributs de l'attribut.
multiValued

boolean

Indique le pluriel de l'attribut.
description

string

Description de l'attribut dans un format lisible. Le cas échéant, les fournisseurs de services doivent spécifier la description.
required

boolean

Indique si l'attribut est obligatoire ou non.
caseExact

boolean

Indique si un attribut de chaîne est sensible à la casse. Le serveur est sensible à la casse lorsqu'il évalue les filtres. Pour les attributs sensibles à la casse, le serveur conserve la casse de toute valeur envoyée. Si l'attribut n'est pas sensible à la casse, le serveur peut modifier la casse d'une valeur envoyée. La sensibilité à la casse a également un impact sur la façon dont les valeurs d'attributs peuvent être comparées aux valeurs de filtre (voir la section 3.4.2.2 de la RFC 7644).

Conformément aux sections 2.3.6 et 2.3.7 de la RFC 7643, les types binary et reference sont caseExact.
mutability

string

Mot clé unique indiquant les circonstances dans lesquelles la valeur de l'attribut peut être (re)définie :

  • readOnly : l'attribut n'est pas modifiable.
  • readWrite : valeur par défaut. L'attribut peut être mis à jour et lu à tout moment.
  • immutable : l'attribut peut être défini lors de la création d'une ressource (par exemple, POST) ou lors du remplacement d'un enregistrement via une requête (par exemple, PUT). Cet attribut ne peut pas être modifié après sa définition initiale.
  • writeOnly : l'attribut peut être mis à jour à tout moment. Les valeurs d'attribut ne sont pas renvoyées (par exemple, parce que la valeur est un hachage stocké). Remarque : Un attribut dont la mutabilité est définie sur writeOnly a généralement un paramètre de retour défini sur never.
returned

string

Mot clé unique qui indique quand un attribut et les valeurs associées sont renvoyés en réponse à une requête GET ou à une requête PUT, POST ou PATCH. Voici les mots clés valides :

  • always : l'attribut est toujours renvoyé, quel que soit le contenu du paramètre attributes. Par exemple, id est toujours renvoyé pour identifier une ressource SCIM.
  • never : l'attribut n'est jamais renvoyé. Cela peut se produire, car le fournisseur de services ne conserve pas la valeur d'attribut d'origine (par exemple, une valeur hachée). Un fournisseur de services peut autoriser l'utilisation d'attributs dans un filtre de recherche.
  • default : valeur par défaut. L'attribut est renvoyé par défaut dans toutes les réponses aux opérations SCIM où des valeurs d'attribut sont renvoyées. Si le paramètre attributes de la requête GET est spécifié, les valeurs d'attribut ne sont renvoyées que si l'attribut est nommé dans le paramètre attributes.
  • request : l'attribut est renvoyé en réponse à toute opération PUT, POST ou PATCH si l'attribut a été spécifié par le client (par exemple, si l'attribut a été modifié). L'attribut n'est renvoyé dans une opération de requête SCIM que s'il est spécifié dans le paramètre attributes.
uniqueness

string

Valeur de mot clé unique qui spécifie comment le fournisseur de services applique l'unicité des valeurs d'attribut. Un serveur peut rejeter une valeur non valide basée sur l'unicité en renvoyant le code de réponse HTTP 400 Bad Request. Un client peut appliquer l'unicité côté client dans une mesure plus importante que celle appliquée par le fournisseur de services. Par exemple, un client peut rendre une valeur unique alors que le serveur a une unicité de none. Voici les mots clés valides :

  • none : valeur par défaut. Les valeurs ne sont pas censées être uniques.
  • server : la valeur doit être unique dans le contexte du point de terminaison SCIM (ou du locataire) actuel et peut être unique au niveau mondial (par exemple, un nom d'utilisateur, une adresse e-mail ou une autre clé ou un autre compteur générés par le serveur). Deux ressources sur le même serveur ne doivent pas avoir la même valeur.
  • global : la valeur doit être unique au niveau mondial (par exemple, une adresse e-mail, un GUID ou une autre valeur). Aucune ressource sur un serveur ne doit posséder la même valeur.

Comme indiqué dans la section 2.3 de la norme RFC 7643, les types de données Boolean, DateTime, Binary et Complex ne sont pas uniques.

Méthodes

get

 Récupère un schéma.

list

 Récupère tous les schémas.