Zum Inhalt

Eine Organisation erstellen.

Methode

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

Beschreibung

Erstellt eine neue untergeordnete Organisation.

Abfrageparameter
parent_org_id string

ID der vorhandenen übergeordneten Organisation.
external_id string

Externe ID der neuen Organisation. Verwenden Sie sie für idempotente Aufrufe, um doppelte Organisationen zu vermeiden und die Organisation der entsprechenden Organisation in einem externen, mit Afi integrierten System zuzuordnen.
name string

Name der neuen Organisation.
admin_email string

E-Mail-Adresse des Administratorkontos. An diese Adresse wird eine E-Mail mit einem Einladungslink gesendet.

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

Schema der erfolgreichen Antwort (200)
object

CreateOrgResult enthält das Ergebnis einer Anforderung zum Erstellen einer Organisation.
org object

Die neu erstellte Organisation.

object

Org stellt eine Organisation dar.
id string

Eindeutige ID der Organisation.
external_id string

Eindeutige externe ID der Organisation.
kind string

Organisationstyp (distributor, msp, basic).
name string

Name der Organisation.
invitation_url string

Einladungs-URL, über die sich der Benutzer anmelden, die Einladung annehmen und Administrator der Organisation werden kann.

Antwortbeispiel
{
  "org": {
    "id": "string",
    "external_id": "string",
    "kind": "string",
    "name": "string"
  },
  "invitation_url": "string"
}