Crear una organización.¶

Método¶

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

Descripción¶

Crea una nueva organización secundaria.

Parámetros de consulta¶

parent_org_id string

ID de la organización principal existente.

external_id string

ID externo de la nueva organización. Úselo para garantizar la idempotencia, evitar organizaciones duplicadas y asignar la organización a la correspondiente en un sistema externo que se integre con Afi.

name string

Nombre de la nueva organización.

admin_email string

Dirección de correo electrónico de la cuenta de administrador. Se envía a esta dirección un correo electrónico con un enlace de invitación.

curl

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

Esquema de respuesta correcta (200)¶

object

CreateOrgResult es el resultado de una solicitud de creación de una organización.

org object

La organización recién creada.

object

Org representa una organización.

id string

ID único de la organización.

external_id string

ID externo único de la organización.

kind string

Tipo de organización (distributor, msp, basic).

name string

Nombre de la organización.

invitation_url string

URL de invitación que el usuario puede seguir para iniciar sesión, aceptar la invitación y convertirse en administrador de la organización.

Ejemplo de respuesta¶

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