Skip to Content
🎉 New release with new features and improvements! V0.0.2 Release →

Register

Users can create new accounts by using the register endpoint.

POST /api/auth/register

Request Body

{ "email": "user@example.com", "password": "password123", "profile": { "firstName": "first", "lastName": "last" }, "roles": ["DEV_USER"] }
PropertyTypeRequiredDescription
emailstringyesThe email address of the user.
passwordstringyesThe password of the user.
profileobjectyesThe profile of the user.
rolesarrayyesThe roles of the user.

The profile object is customizable; define any fields you want to include in a user’s profile. This allows you to tailor user data storage to your application’s specific requirements.

The roles are allowed only to use public roles, all non-public roles will be ignored.

Response

{ "data": [ { "email": "user@example.com", "profile": { "firstName": "first", "lastName": "last" }, "roles": ["DEV_USER"] } ], "status": "CREATED", "code": 201, "timestamp": 1234567890, "meta": {} ... }