Aller au contenu

Créer une organisation.

Méthode

POST https://papi.afi.ai/api/v1/orgs

Description

Crée une organisation enfant.

Paramètres de requête
parent_org_id string

Identifiant de l’organisation parente existante.
external_id string

Identifiant externe de la nouvelle organisation. Utilisez-le à des fins d’idempotence pour éviter les organisations en double et faire correspondre l’organisation à son homologue dans un système externe intégré à Afi.
name string

Nom de la nouvelle organisation.
admin_email string

Adresse e-mail du compte administrateur. Un e-mail contenant un lien d’invitation est envoyé à cette adresse.

 
curl -X POST \
    -H 'Authorization: {api-key}' \
    https://papi.afi.ai/api/v1/orgs

Schéma de la réponse réussie (200)
object

CreateOrgResult est le résultat d’une demande de création d’organisation.
org object

L’organisation nouvellement créée.

object

Org représente une organisation.
id string

Identifiant unique de l’organisation.
external_id string

Identifiant externe unique de l’organisation.
kind string

Type d’organisation (distributor, msp, basic).
name string

Nom de l’organisation.
invitation_url string

URL d’invitation que l’utilisateur peut suivre pour se connecter, accepter l’invitation et devenir administrateur de l’organisation.

Exemple de réponse
{
  "org": {
    "id": "string",
    "external_id": "string",
    "kind": "string",
    "name": "string"
  },
  "invitation_url": "string"
}