Admin APIs
openbb-users

Create User

Create a new OpenBB user and assign to an entity.

The user will receive a temporary password that must be changed on first login.

post/api/v1/admin/openbb/users/{entity_uuid}

Request

  • Base URL: https://carbonarc.ai (the document declares no server; this is the origin it was published from)
  • URL: https://carbonarc.ai/api/v1/admin/openbb/users/{entity_uuid}
  • Auth: OAuth 2 (authorization code, authorization URL authorize, token URL token)

Path parameters

entity_uuidstring required

Request body

emailstring email required

User's email address

first_namestring required

User's first name

last_namestring required

User's last name

rolestring

Role assignment ('admin' or 'user')

Example request

{
  "email": "john.doe@acme.com",
  "first_name": "John",
  "last_name": "Doe",
  "role": "user"
}

Response

Successful Response

user_uuidstring nullable
emailstring required
temporary_passwordstring nullable
messagestring

Changes

No recorded changes to this operation across all 4 revisions of this API.