Skip to main content

Endpoint

Authentication

This endpoint requires authentication via API key. Include your API key in the X-API-Key header:

Request Body

The request body must be a JSON object with the following fields:

Required Fields

Optional Fields

Request Example

Response

Success Response

Status Code: 200 OK

Response Fields

Error Responses

400 Bad Request

Returned when the request is invalid - for example, a malformed email or a user that already exists. The detail reflects the underlying validation error.

401 Unauthorized

Returned when authentication fails. See the authentication errors section for details.

422 Unprocessable Entity

Returned when the request body fails validation.

500 Internal Server Error

Returned when the user could not be created due to a server error.

Notes

The new user is always created in the organization that owns the API key. The role defaults to viewer if omitted - set role explicitly to grant broader access.

Use Cases

This endpoint is useful for:
  • User provisioning - Programmatically onboard users from an external system
  • SSO onboarding - Pre-create SSO users so they can sign in via your identity provider
  • Role assignment - Create users with the appropriate organization role from the start