Aller au contenu principal

Créer un utilisateur

Ce guide décrit le processus de création d'un nouvel utilisateur sur la plateforme Stonal à l'aide de l'API. Le processus comprend plusieurs étapes permettant de rassembler les informations requises avant de créer l'utilisateur.

Prérequis
  • Un jeu valide d'identifiants API
  • Un jeton d'accès valide (voir : Obtenir un jeton)
  • Un code d'organisation

Étape 1 : Rechercher un utilisateur existant​

Avant de créer un nouvel utilisateur, vérifiez s'il existe déjà afin d'éviter les doublons.

Voir : Spécification de l'API

POST /v1/organizations/{organizationCode}/users/search

Corps de la requête :

{
  "email": "firstName.lastName@corp.com"
}

Si l'utilisateur existe, vous recevrez une réponse 200 avec les détails de l'utilisateur (voir : Modifier un utilisateur). Sinon, poursuivez avec la création de l'utilisateur.

Étape 2 : Récupérer les informations nécessaires sur l'utilisateur​

Récupérez la liste des sociétés disponibles pouvant être attribuées à l'utilisateur :

Voir : Spécification de l'API

GET /v1/organizations/{organizationCode}/users/companies

Paramètres de requête :

  • page (optionnel) : Numéro de page (par défaut : 0)
  • size (optionnel) : Éléments par page (par défaut : 100)

Les sociétés obtenues peuvent être utilisées pour créer un utilisateur avec le champ company. L'utilisateur obtient ainsi le droit d'accéder aux objets de la société correspondante.

Étape 3 : Créer l'utilisateur​

Enfin, créez l'utilisateur avec toutes les informations rassemblées :

Voir : Spécification de l'API

POST /v1/organizations/{organizationCode}/users

Corps de la requête :

{
  "email": "firstName.lastName@corp.com",
  "firstName": "firstName",
  "lastName": "lastName",
  "company": "companyName",
  "fromExternalIdp": false,
  "groupUids": ["0192d7b7-2994-7ad5-9952-26862f33c21a"],
  "authorization": {
    "modelId": "2b2e8a4b-bfbd-4c56-b8d6-c8cb1d8c58ba",
    "profile": "Developer",
    "asset": {
      "all": false
    }
  },
  "permissionUids": [
    "0192d7b7-2994-7ad5-9952-26862f33c21a",
    "0192d7b7-7073-7e58-896c-07113f22363a"
  ]
}

Champs requis :

  • email : Adresse e-mail de l'utilisateur
  • firstName : Prénom de l'utilisateur
  • lastName : Nom de l'utilisateur
  • company : Nom de la société (doit faire partie des sociétés disponibles)
  • groupUids : Tableau des UID de groupes
  • authorization : Configuration de l'autorisation
    • modelId : Identifiant du modèle d'autorisation
    • profile : Profil de l'utilisateur
    • asset : Configuration de l'accès aux objets
  • permissionUids : Tableau des UID d'autorisations

Réponses possibles :

  • 201 : Utilisateur créé avec succès
  • 202 : La création de l'utilisateur semble réussie mais ne peut être confirmée
  • 409 : L'utilisateur existe déjà

Notes​

  • Toutes les adresses e-mail doivent être uniques dans le système
  • L'attribution de la société détermine les objets auxquels l'utilisateur peut accéder
  • Si fromExternalIdp est à true, l'utilisateur doit s'authentifier via son fournisseur d'identité
  • L'accès aux objets peut être accordé à tous les objets ("all": true) ou à des objets spécifiques en utilisant permissionUids
  • Les UID d'autorisations doivent être valides et récupérés depuis le point de terminaison des autorisations

Gestion des erreurs​

Scénarios d'erreur courants :

  • Identifiant de modèle d'autorisation invalide
  • Nom de société invalide
  • Adresse e-mail en double
  • UID d'autorisations invalides
  • Champs requis manquants

Vérifiez toujours le statut de la réponse et gérez les erreurs de manière appropriée dans votre implémentation.