API - Utilisateurs
Récupération de la liste des utilisateurs
Renvoie la liste de tous les utilisateurs de l'instance.
URL: https://my.vtsperform.com/api/client/user/all
Permission requise: USER_READ
Méthode: GET
Réponses:
Code | Exemple |
200 (OK) |
[ |
400 (Bad request) |
{ |
401 (Unauthorized) |
{ |
403 (Forbidden) |
{ |
Récupération des détails d'un utilisateur
Renvoie les détails d'un utilisateur de l'instance.
URL: https://my.vtsperform.com/api/client/user/{user_id}
Permission requise: USER_READ
Méthode: GET
Réponses:
Code | Exemple |
200 (OK) |
{ |
400 (Bad request) |
{ |
401 (Unauthorized) |
{ |
403 (Forbidden) |
{ |
Création d'un utilisateur
Créé un nouvel utilisateur dans votre instance. Si l'utilisateur existe déjà (email ou login connu), alors l'utilisateur est mis à jour.
URL: https://my.vtsperform.com/api/client/user/
Permission requise: USER_EDIT
Méthode: POST
Paramètres:
Paramètre | Type | Description |
firstname* | string | Le prénom de l'utilisateur |
lastname* | string | Le nom de l'utilisateur |
string | L'email de l'utilisateur | |
login | string | Le login de l'utilisateur s'il n'a pas d'adresse email |
password* | string | (optionnel si l'utilisateur a un email - obligatoire sinon) Le mot de passe de l'utilisateur. Le mot de passe doit respecter les contraintes de complexité. Si aucun mot de passe n'est fourni, l'utilisateur en créera un lors de sa première connexion. |
locale | string | La langue de l'utilisateur. Peut être 'fr' ou 'en'. Prend la langue par défaut de l'instance si le champ n'est pas défini. |
country | string | Le code pays (ISO 3166-1 alpha-2) de l'utilisateur |
region | string | La région de l'utilisateur |
city | string | La ville de l'utilisateur |
address | string | L'adresse de l'utilisateur |
zip | string | Le code postal de l'utilisateur |
company | string | L'entreprise de l'utilisateur |
service | string | Le service de l'utilisateur |
function | string | Le métier de l'utilisateur |
registration_number | string | Le matricule de l'utilisateur |
phone | string | Le téléphone de l'utilisateur |
birthdate | datetime | La date de naissance de l'utilisateur (format YYYY-MM-JJ) |
external_id | integer | Identifiant de l'utilisateur dans plateforme tierce |
Réponses:
Code | Exemple |
200 (OK) |
{ |
400 (Bad request) |
{ |
401 (Unauthorized) |
{ |
403 (Forbidden) |
{ |
Modification d'un utilisateur
Modifie les informations d'un utilisateur existant.
URL: https://my.vtsperform.com/api/client/user/{user_id}
Permission requise: USER_EDIT
Méthode: PATCH
Paramètres:
Paramètre | Type | Description |
archived | boolean | Statut de l'utilisateur |
firstname | string | Le prénom de l'utilisateur |
lastname | string | Le nom de l'utilisateur |
locale | string | La langue de l'utilisateur. Peut être 'fr' ou 'en'. Prend la langue par défaut de l'instance si le champ n'est pas défini. |
country | string | Le code pays (ISO 3166-1 alpha-2) de l'utilisateur |
region | string | La région de l'utilisateur |
city | string | La ville de l'utilisateur |
address | string | L'adresse de l'utilisateur |
zip | string | Le code postal de l'utilisateur |
company | string | L'entreprise de l'utilisateur |
service | string | Le service de l'utilisateur |
function | string | Le métier de l'utilisateur |
registration_number | string | Le matricule de l'utilisateur |
phone | string | Le téléphone de l'utilisateur |
birthdate | datetime | La date de naissance de l'utilisateur (format YYYY-MM-JJ) |
Réponses:
Code | Exemple |
200 (OK) |
{ |
400 (Bad request) |
{ |
401 (Unauthorized) |
{ |
403 (Forbidden) |
{ |
Suppression d'un utilisateur
Supprime une utilisateur de votre instance.
URL: https://my.vtsperform.com/api/client/user/{user_id}
Permission requise: USER_DELETE
Méthode: DELETE
Réponses:
Code | Exemple |
200 (OK) |
{ |
400 (Bad request) |
{ |
401 (Unauthorized) |
{ |
403 (Forbidden) |
{ |
- ${ child.title }