💡Introduction

Every user consuming the platform must be a part of an organisation

The Users module is a foundational component of the ByteRaven platform, designed to manage end-users who are part of an organization. This module plays a critical role in ensuring secure and efficient access to the platform's services by assigning unique identifiers and managing authentication tokens for each user.

user.json

// Some code

{
  "userId": "66932yd9839343",
  "orgId": "67483723d3d34",
  "orgAlias": "techCompanyXYZ",

  "firstName": "Jane",
  "lastName": "Doe",
  "profession": "Software Engineer",
  "email": "[email protected]",
  "phone": "[phone]",

  "deleted": false,

  "firebaseDeviceTokens": [
    "token123abc",
    "token456def"
  ],

  "userCreditsBalance": 150,

  "platform": "web", // android / ios / web

  "createdAt": "2023-01-01T10:00:00Z",
  "lastUsedAt": "2024-08-16T15:30:00Z"
}

Unique User Identification:

• Every end-user within an organization is assigned a unique user ID upon creation. This unique identifier ensures that each user can be distinctly recognized and managed within the platform, enabling precise tracking of user activities and permissions.

Secure Authentication with JWT Tokens:

• To maintain a secure and seamless user experience, the Users module issues a JSON Web Token (JWT) to each user. This token serves as an authentication mechanism, allowing users to securely access the platform's resources.

• Token Validity: The JWT token is valid for 30 days from the time of issuance. This means that users can remain authenticated and continue using the platform without needing to log in repeatedly within this period.

Integration with Organizational Structure:

• Users are integrated into the organization’s structure, meaning their roles, permissions, and access levels are defined and managed within the context of the organization they belong to. This ensures that users only have access to the resources and features that are relevant to their role.

The Users module is designed to provide a secure, scalable, and efficient way to manage end-users within an organization. By assigning unique IDs and managing JWT tokens, it ensures that users have the appropriate access to the platform's features while maintaining high security standards.