Méthode « POST /openapi/v1/users »

19 avril 2024

ID 242752

Création d'un utilisateur qui est ajouté à un groupe spécifié.

Demande

En-tête :

  • Autorisation : le jeton API de l'entreprise.

Corps :

  • user : un objet – un objet contenant des informations personnelles sur l'utilisateur.
    • fullName : une chaîne – le nom complet de l'utilisateur.
    • shortName : une chaîne – le nom court de l'utilisateur.
    • email : une chaîne – l'adresse email de l'utilisateur. Il doit être indiqué en lettres minuscules. Une entrée comme AdMiN@DomAn.com produira une erreur de validation de l'entrée.
  • group : un objet – un objet contenant des informations sur le groupe auquel l'utilisateur sera attribué.
    • id : une chaîne – l'identifiant du groupe.

Exemple du corps d'une demande :

{

    user: {

        fullName: 'Jean Paillet',

        shortName: 'Jean',

        email: 'uneadresse@email.com'

    },

    group: {

        id: '627d5c63f0672a10fbac23bb'

    }

}

Réponse

  • user : un objet – un objet contenant des informations sur l'utilisateur créé.
    • id : une chaîne – l'identifiant de l'utilisateur.

Exemple de réponse :

{

    user: {

        id: '627b4aa62344090b598f7435'

    }

}

Erreurs possibles :

  • 400 : common-validation – il y a eu une erreur de validation de la demande.
  • 401 : common-unauthorized – il y a eu une erreur d'authentification.
  • 402 : no-available-license – il n'y a pas assez de licences pour attribuer l'utilisateur à un groupe dont la formation a commencé.
  • 404 : group-does-not-exists – cette entreprise ne compte pas de groupe avec l'identifiant indiqué.
  • 429 : too-many-requests – les demandes ont été trop nombreuses.
  • 409 : user-email-already-exists-in-company – cette entreprise compte déjà un utilisateur avec l'adresse email indiquée.

Cet article vous a-t-il été utile ?
Que pouvons-nous améliorer ?
Merci de nous faire part de vos commentaires. Vous nous aidez à nous améliorer.
Merci de nous faire part de vos commentaires. Vous nous aidez à nous améliorer.