Users Table

The "Users" table in our database is a special entity with specific rules and constraints to ensure system security and data integrity.

Characteristics of the "Users" Table:

  1. Reserved Columns:

    • uid (Type: UID): Unique identifier for each user.

    • roles (Type: Array<String>): Defines the user roles.

    • email (Type: String): Stores the user's email address.

    • createdAt (Type: String): Records the creation date and time of the user record.

    • updatedAt (Type: String): Indicates the last update date and time of the user record.

  2. Immutability:

    • This table cannot be altered or deleted to maintain the integrity of user data and system security.

  3. Data Import and Export:

    • Import Restriction: It's not possible to import data into the "Users" table, ensuring controlled and secure user management.

    • Export Capability: Data can be exported from the "Users" table for analysis or reporting purposes.

REST API Usage for the "Users" Table:

  • GET: Retrieve all users or a specific user by UID.

  • PATCH: Update a user's details by UID.

  • Restricted Methods: POST (create) and DELETE (remove) methods are not available for the "Users" table to prevent unauthorized alterations.

  • To create and delete users' data, you need to use AUTH APIs via REST or Javascript SDK

  • To create a user with additional custom properties, you first need to create it via the AUTH API and then use Database APIs to edit the user data

Last updated