User Sign Up

1️⃣ Overview

Purpose: Registers a new user account. Supports two sign-up flows:

• Self Registration — User registers independently. No hash required. An OTP is sent to the email for verification.

• Workspace Invitation — User was invited to a workspace via email. The invitation hash (received in the invitation email) must be provided along with name and password.

---

2️⃣ Endpoint

POST /idp/api/v1/user/sign-up

---

3️⃣ Authentication

No authentication required. This is a public endpoint.

---

4️⃣ Request Headers

Header	Required
Content-Type: application/json	✅ Yes

---

5️⃣ Request Body Schema

{
  "email": "string",
  "password": "string",
  "firstname": "string",
  "lastname": "string",
  "hash": "string"
}

---

6️⃣ Field Descriptions

Field	Type	Required	Description
email	string	✅ Yes	User’s email address
password	string	✅ Yes	Min 8 chars, must include uppercase, lowercase, number, and special character
firstname	string	✅ Yes	User’s first name
lastname	string	✅ Yes	User’s last name
hash	string	⚠️ Conditional	Required only for workspace invitation flow. UUID received in the invitation email. Must be omitted for self-registration.

---

7️⃣ Sign-Up Flows

🔵 Self Registration

{
  "email": "user@example.com",
  "password": "Demo12#$",
  "firstname": "John",
  "lastname": "Doe"
}

• No hash required
• OTP is sent to the provided email
• User must verify email via /idp/api/v1/user/signUp/verifyEmailOtp

🟢 Workspace Invitation

{
  "email": "user@example.com",
  "password": "Demo12#$",
  "firstname": "John",
  "lastname": "Doe",
  "hash": "e0754cfc-f7d1-4cc3-8690-e34a2f17291d"
}

• hash is mandatory and must match the one received in the invitation email
• User is directly linked to the inviting workspace upon successful registration

---

8️⃣ Behavior Summary

• Self Registration — OTP is dispatched to the email. Account is pending until OTP is verified.
• Workspace Invitation — Hash is validated against the invitation. Account is activated and linked to the workspace.
• Password Policy — Enforced for both flows.

---

📌 Additional Notes

• For self-registration, the OTP verification step is mandatory to activate the account.
• For workspace invitation, the hash is single-use and time-limited.
• firstname and lastname are required for both flows.