Documentation

API Utilisateurs

L'API Utilisateurs vous permet de gérer les utilisateurs de votre organisation Diamy, y compris la création, la modification et la suppression de comptes utilisateurs, ainsi que la gestion des rôles et des permissions.

Permissions requises

L'accès à ces endpoints nécessite une clé API avec les permissions users:read et/ou users:write.

Lister les utilisateurs

Récupère une liste paginée des utilisateurs de votre organisation.

Requête

GET /users

curl -X GET "https://api.diamy.io/v1/users" \
  -H "Authorization: Bearer votre_clé_api" \
  -H "Content-Type: application/json"

Paramètres de requête

Paramètre	Type	Description
page	integer	Numéro de page (défaut: 1)
per_page	integer	Nombre d'utilisateurs par page (défaut: 10, max: 100)
role	string	Filtrer par rôle (admin, user, guest)
status	string	Filtrer par statut (active, inactive, pending)
search	string	Rechercher par nom ou email

Réponse

{
  "status": "success",
  "data": {
    "users": [
      {
        "id": "usr_123456",
        "name": "Jean Dupont",
        "email": "jean.dupont@example.com",
        "role": "admin",
        "status": "active",
        "created_at": "2023-01-15T14:30:00Z",
        "updated_at": "2023-03-20T09:15:22Z",
        "last_login_at": "2023-04-01T08:45:12Z"
      },
      {
        "id": "usr_789012",
        "name": "Marie Martin",
        "email": "marie.martin@example.com",
        "role": "user",
        "status": "active",
        "created_at": "2023-02-10T11:20:00Z",
        "updated_at": "2023-02-10T11:20:00Z",
        "last_login_at": "2023-03-28T14:22:45Z"
      }
    ]
  },
  "pagination": {
    "total": 42,
    "page": 1,
    "per_page": 10,
    "pages": 5
  }
}

Récupérer un utilisateur

Récupère les détails d'un utilisateur spécifique.

Requête

GET /users/{user_id}

curl -X GET "https://api.diamy.io/v1/users/usr_123456" \
  -H "Authorization: Bearer votre_clé_api" \
  -H "Content-Type: application/json"

Paramètres de chemin

Paramètre	Type	Description
user_id	string	L'identifiant unique de l'utilisateur

Réponse

{
  "status": "success",
  "data": {
    "user": {
      "id": "usr_123456",
      "name": "Jean Dupont",
      "email": "jean.dupont@example.com",
      "role": "admin",
      "status": "active",
      "phone": "+33612345678",
      "department": "Ventes",
      "location": "Paris",
      "created_at": "2023-01-15T14:30:00Z",
      "updated_at": "2023-03-20T09:15:22Z",
      "last_login_at": "2023-04-01T08:45:12Z",
      "preferences": {
        "language": "fr",
        "timezone": "Europe/Paris",
        "notifications": {
          "email": true,
          "sms": false,
          "push": true
        }
      }
    }
  }
}

Créer un utilisateur

Crée un nouvel utilisateur dans votre organisation.

Permissions requises

Cet endpoint nécessite une clé API avec la permission users:write.

Requête

POST /users

curl -X POST "https://api.diamy.io/v1/users" \
  -H "Authorization: Bearer votre_clé_api" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Pierre Durand",
    "email": "pierre.durand@example.com",
    "role": "user",
    "department": "Marketing",
    "location": "Lyon",
    "phone": "+33687654321",
    "send_welcome_email": true
  }'

Paramètres du corps

Paramètre	Type	Requis	Description
name	string	Oui	Nom complet de l'utilisateur
email	string	Oui	Adresse email de l'utilisateur
role	string	Non	Rôle de l'utilisateur (admin, user, guest). Par défaut: user
department	string	Non	Département ou service de l'utilisateur
location	string	Non	Localisation de l'utilisateur
phone	string	Non	Numéro de téléphone de l'utilisateur
send_welcome_email	boolean	Non	Envoyer un email de bienvenue avec les instructions de connexion. Par défaut: true

Réponse

{
  "status": "success",
  "data": {
    "user": {
      "id": "usr_789012",
      "name": "Pierre Durand",
      "email": "pierre.durand@example.com",
      "role": "user",
      "status": "pending",
      "department": "Marketing",
      "location": "Lyon",
      "phone": "+33687654321",
      "created_at": "2023-04-05T10:15:30Z",
      "updated_at": "2023-04-05T10:15:30Z"
    }
  }
}

Mettre à jour un utilisateur

Met à jour les informations d'un utilisateur existant.

Permissions requises

Cet endpoint nécessite une clé API avec la permission users:write.

Requête

PATCH /users/{user_id}

curl -X PATCH "https://api.diamy.io/v1/users/usr_123456" \
  -H "Authorization: Bearer votre_clé_api" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Jean Dupont-Martin",
    "department": "Direction",
    "role": "admin"
  }'

Paramètres de chemin

Paramètre	Type	Description
user_id	string	L'identifiant unique de l'utilisateur

Paramètres du corps

Tous les paramètres sont optionnels. Seuls les champs fournis seront mis à jour.

Paramètre	Type	Description
name	string	Nom complet de l'utilisateur
email	string	Adresse email de l'utilisateur
role	string	Rôle de l'utilisateur (admin, user, guest)
status	string	Statut de l'utilisateur (active, inactive)
department	string	Département ou service de l'utilisateur
location	string	Localisation de l'utilisateur
phone	string	Numéro de téléphone de l'utilisateur

Réponse

{
  "status": "success",
  "data": {
    "user": {
      "id": "usr_123456",
      "name": "Jean Dupont-Martin",
      "email": "jean.dupont@example.com",
      "role": "admin",
      "status": "active",
      "department": "Direction",
      "location": "Paris",
      "phone": "+33612345678",
      "created_at": "2023-01-15T14:30:00Z",
      "updated_at": "2023-04-05T11:20:15Z",
      "last_login_at": "2023-04-01T08:45:12Z"
    }
  }
}

Supprimer un utilisateur

Supprime un utilisateur de votre organisation.

Attention

Cette action est irréversible. Toutes les données associées à cet utilisateur seront également supprimées.

Permissions requises

Cet endpoint nécessite une clé API avec la permission users:write.

Requête

DELETE /users/{user_id}

curl -X DELETE "https://api.diamy.io/v1/users/usr_123456" \
  -H "Authorization: Bearer votre_clé_api" \
  -H "Content-Type: application/json"

Paramètres de chemin

Paramètre	Type	Description
user_id	string	L'identifiant unique de l'utilisateur

Réponse

{
  "status": "success",
  "data": {
    "deleted": true,
    "id": "usr_123456"
  }
}

Points de terminaison Appels