Sign in
latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Organization

Create an organization

Set up a new organization in the Amigo system. Specifically, it

  • creates a new organization within the Amigo Mongo database with the given details.
    • Along with the new organization, 4 default roles are created:
      • DefaultUserRole.
      • DefaultAdministratorRole.
      • DefaultAmigoAdministratorRole.
      • DefaultSuperAdministratorRole.
    • A super user, admin@amigo.ai, is created and granted the DefaultSuperAdministratorRole.
  • creates a new tenant in Google Identity Platform for users in this organization.
  • creates a new Route53 record, {org_id}.amigo.ai, that hosts the Amigo frontend for this organization.
  • creates a new domain, {org_id}.amigo.ai, on Vercel.

The x-mongo-cluster-name header is mandatory for this endpoint.

Permissions

This endpoint requires the following permissions:

  • Organization:CreateOrganization. for the organization to create.
put/v1/{organization}/organization/

Path parameters

organizationstring required

Headers

x-mongo-cluster-namestring required

The Mongo cluster name to perform this request in.

The Mongo cluster name to perform this request in.

Sec-WebSocket-Protocolstring[]

Request body

org_namestring required
logostring base64 required

A logo for the organization that will be displayed on the Amigo frontend for this organization, as well as all Amigo communications to users on behalf of the organization. Must be provided as base64 encoded bytes of a PNG image of aspect ratio 5:2 with minimum size 400 * 160 pixels.

square_logostring base64 required

A square logo of the organization. Must be provided as base64 encoded bytes of a square PNG image of size at least 40 * 40 pixels.

faviconstring base64 required

Favicon for the Amigo frontend for this organization. Must be provided as base64 encoded bytes of a square ICO image that's of size at least 40 * 40 pixels.

azure_devops_team_namestring required

Response

Succeeded.

org_idstring required

ID of the newly created organization. This is used to identify the organization that a resource belongs to in all Amigo endpoints.