latestOpenAPI 3.1.02026-08-218667571.2 MB

a8ca30023371

Admin APIs
openbb-entities

Provision Entity With Users

Provision a complete OpenBB entity with admins and users.

This is a convenience endpoint that:

  1. Creates the entity
  2. Sets up default entitlements
  3. Creates admin users
  4. Creates regular users

All users receive temporary passwords that should be changed on first login.

post/api/v1/admin/openbb/entities/provision

Request body

Example request

{
  "admins": [
    {
      "email": "admin@acme.com",
      "first_name": "Admin",
      "last_name": "User"
    }
  ],
  "entity": {
    "admin_email": "admin@acme.com",
    "aum": 10000000,
    "company_type": "Investment Firm",
    "country": "USA",
    "email": "billing@acme.com",
    "entity_type_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "expiration_date": "2026-12-31T00:00:00Z",
    "name": "Acme Corp",
    "organization_size": "10-50",
    "seats": 50
  },
  "users": [
    {
      "email": "analyst@acme.com",
      "first_name": "Analyst",
      "last_name": "One"
    }
  ]
}

Response

Successful Response

entityobject required
messagestring