Create Organization User

As an Organization Admin, create a new user in your organization.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Authenticate with an Organization Admin User API key, sent in the
skyfire-api-key header. Keys belonging to callers whose organization role is
ADMIN are accepted; a MEMBER key, or any Agent API
key, is rejected with 401.

The new user is always created in your organization. It is derived from
the API key, and there is no orgId field in the request body.

The role you assign

roleResult
MEMBERStandard organization user.
ADMINOrganization Admin. Additionally receives a user API key, returned once as userApiKey.

What this call creates

A single request creates:

  1. The organization user.
  2. A buyer agent named Buyer 1, with a wallet.
  3. An API key for that buyer agent, returned as buyerAgent.apiKey.
  4. If role is ADMIN, an Organization Admin User API key, returned as
    userApiKey.

If any step fails, the whole transaction is rolled back and no user is created.

buyerAgent.apiKey and userApiKey are returned only in this response

and cannot be retrieved again. Store them securely before discarding the
response.

For role: "MEMBER", userApiKey is omitted from the response body
entirely. It is not returned as null.

Body Params
string
required

Email address of the new organization user. Must be unique within your organization. e.g. [email protected]

string
enum
required

Organization role for the new user. MEMBER creates a standard organization user. ADMIN creates an Organization Admin, which additionally returns userApiKey in the response.

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json