Aller au contenu

Organisations

Lister, créer et modifier les réseaux de votre application, et gérer leurs clients jusqu'à la suppression, par l'API publique.

RéférenceDéveloppeurAdministrateur
Voir en Markdown

Une application distribue ses services par des réseaux, qui regroupent des clients. Chaque réseau a son propre realm Keycloak ; chaque client correspond à une organisation Keycloak dans ce realm. Le modèle est expliqué dans Organisation multi-tenant.

Accès commun : appelant de niveau Administrateur client (CUSTOMER_ADMIN) au minimum, avec le droit applicatif indiqué pour chaque endpoint. L'appelant ne voit et ne modifie que les réseaux et les clients de son périmètre.

L'objet Réseau

ChampTypeDescription
idUUIDIdentifiant technique
widchaîne (6)Identifiant court
appIdUUIDApplication du réseau. Non modifiable
namechaîne (100)Nom affiché
descriptionchaîne (250) ou nullDescription
subdomainchaîne (15) ou nullSous-domaine : minuscules, chiffres et tirets
defLangId, defThemeIdUUID ou nullLangue et thème par défaut des clients du réseau
statuschaîneACTIVE, INACTIVE, SUSPENDED, DELETED ou DRAFT
createdAt, updatedAtchaîne ISO 8601Dates de création et de modification

L'objet Client

ChampTypeDescription
idUUIDIdentifiant technique
widchaîne (6)Identifiant court
networkIdUUIDRéseau du client. Non modifiable
namechaîne (100)Nom affiché
descriptionchaîne (250) ou nullDescription
subdomainchaîne (15) ou nullSous-domaine : minuscules, chiffres et tirets
entityIdUUIDEntité juridique qui porte le client
defLangId, defThemeIdUUID ou nullLangue et thème par défaut de ses utilisateurs
allowAutoRegistrationbooléenRéservé, vaut false
statuschaîneACTIVE, INACTIVE, SUSPENDED, DELETED ou DRAFT
createdAt, updatedAtchaîne ISO 8601Dates de création et de modification

Lister les réseaux

GET/api/config/networks

Droit requis : networks.read.

Paramètre de requêteTypeDéfautDescription
pageentier ≥ 11Page
limitentier, 1 à 10020Taille de page
partnerWid, partnerIdWID ou UUID—Restreint à un propriétaire
Bash
curl -s "https://api.wakastart.app/api/config/networks?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Réponse 200

JSON
{
  "data": [
    {
      "id": "b2c4e6f8-1a3b-4c5d-8e9f-0a1b2c3d4e5f",
      "wid": "EXNET1",
      "appId": "a1b2c3d4-0000-4000-8000-000000000001",
      "name": "Réseau Exemple",
      "description": null,
      "subdomain": "reseau-exemple",
      "status": "ACTIVE",
      "createdAt": "2026-02-10T09:00:00.000Z",
      "updatedAt": "2026-09-01T14:30:00.000Z"
    }
  ],
  "meta": { "page": 1, "limit": 20, "total": 1, "totalPages": 1 }
}

Lire un réseau

GET/api/config/networks/{wid}

Droit requis : networks.read. wid : identifiant court du réseau. Réponse : l'objet Réseau.

Erreurs : 403 Network not found or not accessible, 403 Network not in caller scope, 404 Network with WID <wid> not found.

Créer un réseau

POST/api/config/networks

Droit requis : networks.create. Réservé aux administrateurs réseau et aux propriétaires de l'application.

ChampTypeObligatoireContraintes
appIdUUIDouiApplication du réseau
namechaîneoui100 caractères au plus
descriptionchaînenon250 caractères au plus
subdomainchaînenon15 caractères au plus, ^[a-z0-9-]+$
defLangId, defThemeIdUUIDnonLangue et thème par défaut
statuschaînenonDéfaut ACTIVE
Bash
curl -s -X POST https://api.wakastart.app/api/config/networks \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "appId": "a1b2c3d4-0000-4000-8000-000000000001",
    "name": "Réseau Sud",
    "subdomain": "reseau-sud"
  }'

Réponse 201 : l'objet Réseau créé. Wakastart provisionne ensuite le realm Keycloak du réseau dans chaque environnement.

Erreurs : 400 Application avec ID <id> non trouvée ; 409 La valeur du champ "subdomain" existe déjà. Veuillez en choisir une autre.

Modifier un réseau

PUT/api/config/networks/{wid}

Droit requis : networks.update. Tous les champs de la création sont facultatifs, sauf appId, qui ne peut pas être modifié. Réponse : l'objet Réseau modifié.

Lister les clients

GET/api/config/customers

Droit requis : customers.read.

Paramètre de requêteTypeDéfautDescription
pageentier ≥ 11Page
limitentier, 1 à 10020Taille de page
networkWid, networkIdWID ou UUID—Restreint à un réseau
Bash
curl -s "https://api.wakastart.app/api/config/customers?networkWid=EXNET1" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Réponse 200

JSON
{
  "data": [
    {
      "id": "c3d5e7f9-2b4c-4d6e-9f0a-1b2c3d4e5f60",
      "wid": "EXCLI1",
      "networkId": "b2c4e6f8-1a3b-4c5d-8e9f-0a1b2c3d4e5f",
      "name": "Clinique Exemple",
      "description": null,
      "subdomain": null,
      "entityId": "d4e6f8a0-3c5d-4e7f-8a1b-2c3d4e5f6a70",
      "allowAutoRegistration": false,
      "status": "ACTIVE",
      "createdAt": "2026-03-01T08:00:00.000Z",
      "updatedAt": "2026-03-01T08:00:00.000Z"
    }
  ],
  "meta": { "page": 1, "limit": 20, "total": 1, "totalPages": 1 }
}

Lire un client

GET/api/config/customers/{wid}

Droit requis : customers.read. Réponse : l'objet Client.

Erreurs : 403 Accès refusé à ce customer ; 404 Customer with WID <wid> not found.

Créer un client

POST/api/config/customers

Droit requis : customers.create. Réservé aux administrateurs réseau et aux propriétaires de l'application.

ChampTypeObligatoireContraintes
networkIdUUIDouiRéseau du client
namechaîneoui100 caractères au plus
entityIdUUIDouiEntité juridique du client, créée au préalable dans la console
descriptionchaînenon250 caractères au plus
subdomainchaînenon15 caractères au plus, ^[a-z0-9-]+$
defLangId, defThemeIdUUIDnonLangue et thème par défaut
statuschaînenonDéfaut ACTIVE. Sa modification dépend du niveau de l'appelant
Bash
curl -s -X POST https://api.wakastart.app/api/config/customers \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "networkId": "b2c4e6f8-1a3b-4c5d-8e9f-0a1b2c3d4e5f",
    "name": "Cabinet Exemple",
    "entityId": "d4e6f8a0-3c5d-4e7f-8a1b-2c3d4e5f6a70"
  }'

Réponse 201 : l'objet Client créé. Wakastart crée en même temps l'organisation Keycloak du client dans le realm du réseau.

Erreurs

StatutMessage
403Niveau d'administration insuffisant pour créer un customer
404Network with ID <id> not found
404Network <nom> has no realm configured
409La valeur du champ "<champ>" existe déjà. Veuillez en choisir une autre.
500Échec de la création de l'organisation dans Keycloak: <détail>

Modifier un client

PUT/api/config/customers/{wid}

Droit requis : customers.update. Tous les champs de la création sont facultatifs, sauf networkId, qui ne peut pas être modifié.

Bash
curl -s -X PUT https://api.wakastart.app/api/config/customers/EXCLI1 \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Clinique Exemple Nord" }'

Réponse : l'objet Client modifié.

Supprimer un client

DELETE/api/config/customers/{wid}

Droit requis : customers.delete. Réservé aux administrateurs réseau et aux propriétaires de l'application. Retirez d'abord les utilisateurs, les équipes et les fournisseurs d'identité du client.

Erreurs : 409 Impossible de supprimer ce client car il possède encore des utilisateurs…, ou des équipes, ou des fournisseurs d'identité.