---
title: "Registers a new user"
method: POST
path: "/api/auth/register"
tags: ["Authentication"]
deprecated: true
---

# Registers a new user

`POST /api/auth/register`

## Request

- Base URL: `https://passivelogic.com` (the document declares no server; this is the origin it was published from)
- URL: `https://passivelogic.com/api/auth/register`
- Auth: none declared
- TypeScript: <https://skmtc.dev/passivelogic/apis/passivelogic-http-api/docs/api/auth/register/post.ts> (a function with typed inputs; its response is checked against the schema)

> **Deprecated.**

DEPRECATED: This endpoint is not available when Keycloak authentication is turned on and will be removed in the future.

Creates a new user based on the provided information. Requires jwt obtained via email from
`/api/auth/register/initiate`. The user status is set to `Active` and immediately logged in.



Registration token is required when email verification is enforced, as indicated by a failed response to this endpoint

## Request body

- RegisterUserData: Data required for user registration
  - `password` string, required: User's password
  - `token` string, nullable
  - `username` string, nullable
  - `lastName` string, required: User's last name
  - `email` string, required: User's email
  - `firstName` string, required: User's first name
  - `acceptMailingList` boolean, required: Flag to mark if the user wants marketing emails
  - `acceptedEULA` boolean, required: Flag to mark if the user has accepted the EULA

## Response `200`

OK

- RegisterUserResponse: Sent when a new user is successfully registered.
  - `userStatus` 'Active' | 'Blocked' | 'Deleted' | 'Locked' | 'Pending' | 'Reset'
  - `token` string, nullable: New authentication JWT containing changed information
  - `message` string, required: Additional information about the response
  - `newUserID` Identifier
    - `type` 'Adjacency' | 'AllowedQuanta' | 'Analysis' | 'Animation' | 'ApiKey' | 'Artifact' | 'Asset' | 'AuthGroup' | 'Behavior' | 'Binding' | 'Building' | 'Campus' | 'CampusDirectory' | 'CompatibleQuanta' | 'ConnectionNet' | 'ConnectionNode' | 'ConstructionCategory' | 'ControlKnot' | 'Device' | 'DisplayRule' | 'EmailVerification' | 'Equation' | 'Equipment' | 'EquipmentComponent' | 'EquipmentComponentPropertyRouter' | 'EscalationGroup' | 'Event' | 'EventClass' | 'EventHistory' | 'EventRelation' | 'EventType' | 'Floor' | 'GraphVersion' | 'History' | 'Image' | 'ImportedModel' | 'InterfaceAlternate' | 'Invite' | 'Layer' | 'LayerSet' | 'LayerSetJoin' | 'Library' | 'Location' | 'LocationProperty' | 'Manufacturer' | 'Media' | 'MediaComponent' | 'Model' | 'MultifactorAuthentication' | 'NodeSet' | 'NodeSetConnectionNodeJoin' | 'Organization' | 'OrganizationAuthGroupPermission' | 'Prediction' | 'PredictionGroup' | 'Preference' | 'PreferenceGroup' | 'PrivilegeJoin' | 'Procedure' | 'Property' | 'PropertyTagRouter' | 'Quanta' | 'RefreshToken' | 'Relationship' | 'SelectedModel' | 'SessionBinding' | 'SessionEvent' | 'Shape' | 'Site' | 'Subsystem' | 'SubsystemCapability' | 'SubsystemSet' | 'Surface' | 'System' | 'Tag' | 'TagFamily' | 'TypicalConstruction' | 'UnitLookup' | 'UnitPreference' | 'User' | 'UserSession' | 'UserSessionHistory' | 'Vertex' | 'View' | 'WeatherSource' | 'Zone' | 'ZoneGroup' | 'ZoneSubsystem' | 'ZoneSubsystemSet', required
    - `id` string, required
  - `refresh` string, nullable: New refresh JWT

---

[API](https://skmtc.dev/passivelogic/apis/passivelogic-http-api.md) - [All operations](https://skmtc.dev/passivelogic/apis/passivelogic-http-api/llms.txt) - [OpenAPI document](https://skmtc.dev/passivelogic/apis/passivelogic-http-api/revisions/28fce63bcdbb?raw)