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

Invite User

Invite a new user with email and roles.

POST /api/users/invite

This endpoint is for admins to invite new users to the system.
This will generate a random password and send an email to notify the user.

Request Body

{ "email": "user@example.com", "roles": ["DEV_USER"] }
PropertyTypeRequiredDescription
emailstringyesThe email address of the user.
rolesarraynoThe roles of the user.

Response

{ "data": [ { "userId": "user-123", "email": "user@example.com", "roles": ["DEV_USER"] } ], "status": "OK", "code": 200, "timestamp": 1234567890, "meta": {} }

User invitation sends an Invitation Email to notify the user.