Create user
const url = 'http://localhost:3000/api/v1/users';const options = { method: 'POST', headers: {'X-API-Key': '<X-API-Key>', 'Content-Type': 'application/json'}, body: '{"email":"john.doe@example.com","name":"John Doe","password":"securePassword123!","isSuperAdmin":false,"organizationId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","roleId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url http://localhost:3000/api/v1/users \ --header 'Content-Type: application/json' \ --header 'X-API-Key: <X-API-Key>' \ --data '{ "email": "john.doe@example.com", "name": "John Doe", "password": "securePassword123!", "isSuperAdmin": false, "organizationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "roleId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'Creates a new user. Requires Super Admin privileges.
Authorizations
Section titled “Authorizations ”Request Body required
Section titled “Request Body required ”object
User email address
Example
john.doe@example.comUser display name
Example
John DoeUser password (min 8 characters)
Example
securePassword123!Whether the user is a super admin with platform-wide privileges
Example
falseOrganization ID to assign the user to upon creation
Role ID to assign to the user in the organization (defaults to viewer)
Responses
Section titled “ Responses ”User created successfully
object
Unique user identifier
User email address
User display name
Whether the user account is active
Whether the user email has been verified
Whether the user is a super admin with platform-wide privileges
When the user was created
When the user was last updated
When the user last logged in
FM-1069: the Keycloak identity-provider alias the user last authenticated through (e.g. the Entra broker alias), or null for a local realm login.
FM-1069: whether the user authenticates through an external identity provider (federated). The UI hides the password-reset action when true, since federated users have no local password to reset.
Example
{ "id": "550e8400-e29b-41d4-a716-446655440000", "email": "john.doe@example.com", "name": "John Doe", "active": true, "emailVerified": true, "isSuperAdmin": false, "createdAt": "2024-01-15T10:30:00Z", "updatedAt": "2024-06-20T14:45:00Z", "lastLoginAt": "2024-12-20T09:15:00Z", "identityProvider": "entra", "isFederated": false}Invalid input data
Unauthorized
Forbidden - Super Admin required
User with this email already exists