Ajouter un membre (crée le compte + invite si inconnu)

POST /company/users

Scope users:admin
Clé API x-api-key
URL de base https://api.hub.akuasense.com/v1

E-mail déjà connu : le compte est rattaché à la société. Inconnu : le compte est créé (name requis), et une invitation part par e-mail avec un lien pour choisir son mot de passe. Réservé à un OWNER.

En-têtes

Idempotency-Key string

Rejoue la même réponse 2xx (24 h)

Corps de la requête

email string email obligatoire
name string

Nom du compte à créer. Requis si l’e-mail est inconnu.
role string obligatoire

Rôle d’un membre dans une société. OWNER et MANAGER peuvent écrire, VIEWER ne fait que lire. Seul un OWNER gère les membres (scope users:admin).

Valeurs : OWNERMANAGERVIEWER

Réponse

201

Membre ajouté

userId string toujours présent
email string email toujours présent

En minuscules.
role string toujours présent

Rôle d’un membre dans une société. OWNER et MANAGER peuvent écrire, VIEWER ne fait que lire. Seul un OWNER gère les membres (scope users:admin).

Valeurs : OWNERMANAGERVIEWER
invited boolean toujours présent

true : compte créé à l’instant, et invitation envoyée par e-mail, avec un lien pour choisir son mot de passe. false : compte existant, rattaché à la société.

Erreurs

400
Saisie refusée

invalid_body
401
Non authentifié
403
Scope/rôle insuffisant ou hors société
409
Déjà membre de la société

already_member

POST /company/users

curl -X POST https://api.hub.akuasense.com/v1/company/users \
  -H "x-api-key: VOTRE_CLE_API" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "lucie.moreau@example.com",
    "name": "Lucie Moreau",
    "role": "VIEWER"
  }'

const response = await fetch(
  'https://api.hub.akuasense.com/v1/company/users',
  {
    method: 'POST',
    headers: {
      'x-api-key': 'VOTRE_CLE_API',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      "email": "lucie.moreau@example.com",
      "name": "Lucie Moreau",
      "role": "VIEWER"
    }),
  },
);
const data = await response.json();

import requests

response = requests.post(
    "https://api.hub.akuasense.com/v1/company/users",
    headers={"x-api-key": "VOTRE_CLE_API"},
    json={
        "email": "lucie.moreau@example.com",
        "name": "Lucie Moreau",
        "role": "VIEWER",
    },
)
data = response.json()

Réponse

{
  "userId": "cmf8x2k4q0003js08r6d1w5np",
  "email": "lucie.moreau@example.com",
  "role": "VIEWER",
  "invited": true
}

application/json

{
  "type": "string",
  "title": "string",
  "status": 400,
  "detail": "string",
  "code": "invalid_body"
}

application/problem+json · exemple généré depuis le schéma

{
  "type": "string",
  "title": "string",
  "status": 401,
  "detail": "string",
  "code": "string"
}

application/problem+json · exemple généré depuis le schéma

{
  "type": "string",
  "title": "string",
  "status": 403,
  "detail": "string",
  "code": "string"
}

application/problem+json · exemple généré depuis le schéma

{
  "type": "string",
  "title": "string",
  "status": 409,
  "detail": "string",
  "code": "already_member"
}

application/problem+json · exemple généré depuis le schéma