REST Resource: customers.v2.Users

Ressource : Utilisateur

Représentation SCIM d'un utilisateur.

Représentation JSON 
{
  "schemas": [
    string
  ],
  "emails": [
    {
      object (Email)
    }
  ],
  "addresses": [
    {
      object (Address)
    }
  ],
  "phoneNumbers": [
    {
      object (Phone)
    }
  ],
  "groups": [
    {
      object (GroupReference)
    }
  ],
  "id": string,
  "externalId": string,
  "meta": {
    object (Meta)
  },
  "userName": string,
  "name": {
    object (Name)
  },
  "displayName": string,
  "active": boolean,
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    object (EnterpriseUserExtension)
  }
}
Champs
schemas[]

string

Obligatoire. Liste des URI qui indiquent les espaces de noms des schémas SCIM définissant les attributs présents dans la structure JSON actuelle. Ne doit contenir que les valeurs définies comme schema et schemaExtensions pour User ResourceType.
emails[]

object (Email)

Facultatif. Liste des adresses e-mail de l'utilisateur. La taille maximale des données autorisée est de 10 Ko. L'adresse e-mail correspondant à userName sera automatiquement ajoutée à cette liste, et son sous-attribut primary sera défini sur true. Cette entrée d'adresse e-mail principale est en lecture seule et ne peut pas être modifiée à l'aide de cet attribut.
addresses[]

object (Address)

Facultatif. Liste des adresses physiques de l'utilisateur. La taille maximale des données autorisée est de 10 Ko.
phoneNumbers[]

object (Phone)

Facultatif. Liste des numéros de téléphone de l'utilisateur. La taille maximale des données autorisée est de 1 Ko.
groups[]

object (GroupReference)

Uniquement en sortie. Liste des groupes dont l'utilisateur est membre direct, tronquée à 1 000 groupes maximum.

Cet attribut n'est pas renvoyé par défaut et doit être demandé à l'aide du paramètre de requête attributes. La lecture de cet attribut nécessite que le client soit ajouté à la liste d'autorisation. Veuillez contacter l'assistance pour expliquer votre cas d'utilisation et demander l'accès.
id

string

Identifiant. Identifiant unique de l'utilisateur. Les caractéristiques de l'attribut sont caseExact en tant que true, une mutabilité de readOnly et une caractéristique returned de always.
externalId

string

Facultatif. Identifiant défini par le client pour l'utilisateur SCIM. Ce champ est sensible à la casse et modifiable. Il incombe au client de garantir l'unicité, car le serveur ne l'applique pas.
meta

object (Meta)

Uniquement en sortie. Attribut complexe contenant les métadonnées de la ressource. Tous les sous-attributs meta sont attribués par le fournisseur de services (ils ont une mutability de readOnly) et tous ces sous-attributs ont une caractéristique returned de default. Cet attribut est ignoré lorsqu'il est fourni par les clients.
userName

string

Obligatoire. Adresse e-mail principale de l'utilisateur. Utilisé comme identifiant unique de l'utilisateur.
name

object (Name)

Obligatoire. le nom de l'utilisateur
displayName

string

Facultatif. Nom à afficher de l'utilisateur. Limite : 256 caractères.
active

boolean

Facultatif. État du compte de l'utilisateur (false signifie que le compte est suspendu). Valeur par défaut : true.
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

object (EnterpriseUserExtension)

Facultatif. Attributs d'extension utilisateur SCIM Enterprise.

Nom

Représentation SCIM du nom d'un utilisateur.

Représentation JSON 
{
  "familyName": string,
  "givenName": string
}
Champs
familyName

string

Obligatoire. Nom de famille de l'utilisateur.
givenName

string

Obligatoire. Prénom de l'utilisateur.

E-mail

Représentation SCIM de l'adresse e-mail d'un utilisateur.

Représentation JSON 
{
  "value": string,
  "type": string,
  "primary": boolean
}
Champs
value

string

Obligatoire. Adresse e-mail de l'utilisateur.
type

string

Type de compte de messagerie. Les valeurs valides sont home, work et other.
primary

boolean

Uniquement en sortie. Indique s'il s'agit de l'adresse e-mail principale de l'utilisateur. Cette valeur est définie sur true uniquement pour l'adresse e-mail correspondant à userName.

Adresse

Représentation SCIM de l'adresse d'un utilisateur.

Représentation JSON 
{
  "formatted": string,
  "streetAddress": string,
  "locality": string,
  "region": string,
  "postalCode": string,
  "country": string,
  "type": string,
  "primary": boolean
}
Champs
formatted

string

Adresse complète, mise en forme pour l'affichage.
streetAddress

string

Adresse postale.
locality

string

Ville ou localité.
region

string

Région ou État.
postalCode

string

Code postal.
country

string

Pays.
type

string

Type de l'adresse. Les valeurs valides sont home, work et other.
primary

boolean

Indique s'il s'agit de l'adresse principale de l'utilisateur.

Téléphone

Représentation SCIM du numéro de téléphone d'un utilisateur.

Représentation JSON 
{
  "value": string,
  "type": string,
  "primary": boolean
}
Champs
value

string

Obligatoire. Numéro de téléphone.
type

string

Type du numéro de téléphone. Les valeurs valides sont home, work, mobile, fax, pager et other.
primary

boolean

Indique s'il s'agit du numéro de téléphone principal de l'utilisateur.

EnterpriseUserExtension

Définit les attributs de l'extension SCIM Enterprise User. L'URN du schéma pour cette extension est la suivante : urn:ietf:params:scim:schemas:extension:enterprise:2.0:User. Pour en savoir plus, consultez la section 4.3 de la RFC 7643.

Représentation JSON 
{
  "employeeNumber": string,
  "costCenter": string,
  "organization": string,
  "department": string
}
Champs
employeeNumber

string

Facultatif. Identifiant, généralement attribué par l'organisation, utilisé pour identifier l'utilisateur au sein de l'organisation.
costCenter

string

Facultatif. Identifiant du centre de coûts auquel sont attribuées les dépenses de l'utilisateur.
organization

string

Facultatif. Nom d'une organisation à laquelle appartient un utilisateur.
department

string

Facultatif. Nom du service auquel appartient un utilisateur, au format texte.

GroupReference

Représentation SCIM de l'appartenance d'un utilisateur à un groupe.

Représentation JSON 
{
  "value": string,
  "$ref": string,
  "type": string
}
Champs
value

string

Uniquement en sortie. Le id de la ressource SCIM représentant le groupe.
$ref

string

Uniquement en sortie. URI de la ressource SCIM représentant le groupe.
type

string

Uniquement en sortie. Type d'appartenance au groupe. Les valeurs valides sont direct et indirect.

Méthodes

create

 Crée un utilisateur.

delete

 Supprime un utilisateur.

get

 Récupère un utilisateur.

list

 Récupère une liste d'utilisateurs.

patch

 Met à jour un utilisateur à l'aide de la sémantique de correctif SCIM.