Payment ReconcilerDocumentation

QFind anything/

Create a user

Creates a new user in Keycloak and the database, optionally assigning them to a tenant with a role.

Parameters

email(string)required

User email address.

displayName(string)

Display name.

tenantId(string)

Tenant ID (required for admin/viewer roles).

environment(enum)

Environment (required for admin/viewer roles).

role(enum)required

Role: admin, viewer, or super_admin.

password(string)

Initial password (min 8 chars). User can also set password via invite accept flow.

sendInvite(boolean)

Send invite email (default true). When true, temporary passwords are not returned.

POST/users

curl -X POST "http://localhost:8000/api/v1/users" \
  -H "X-Api-Key: $API_KEY" \
  -H "X-Tenant-Id: $TENANT_ID" \
  -H "X-Environment: production" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "displayName": "Jane Doe",
    "tenantId": "089fafeb-bfb2-491a-9fb3-718118e808be",
    "environment": "production",
    "role": "admin",
    "password": "securepassword"
  }'

Response(201)

{
  "id": "089fafeb-bfb2-491a-9fb3-718118e808be",
  "email": "user@example.com",
  "displayName": "Jane Doe",
  "status": "ACTIVE",
  "createdAt": "2025-02-01T10:00:00.000Z",
  "updatedAt": "2025-02-01T10:00:00.000Z"
}