Skip to main content

Users

Where it lives
JSON Pointer: /users
JSONPath: $.users
Parent: Root of the metadata file

Overview​

We can populate some initial users in the system using the users metadata. These users will be created with the default role that is specified in the environment variable IAM_DEFAULT_ROLE or Public role if the environment variable is not set.

Example: Fee Portal Module Users Metadata​

Below is an example of how to initialize users using the metadata configuration. The below example creates two users, "John Doe" and "Jane Smith", with their respective details. Since no passwords are provided, the system will auto-generate secure passwords for these users and mail them to the specified email addresses.

Users Schema 
{
  ..., // Other metadata
  "users": [ // Array of user metadata
    {
      "fullName": "John Doe",
      "username": "johndoe",
      "email": "john.doe@example.com",
      "mobile": "919999999999",
    },
    {
      "fullName": "Jane Smith",
      "username": "janesmith",
      "email": "jane.smith@example.com",
      "mobile": "918888888888",
      "roles": ["Admin", "Editor"] // Ensure these roles exist in the system or are provided in the roles metadata
    }  
  ]
}

Users Metadata Attributes​

fullName (string, required)​

Full name of the user.

username (string, required, unique)​

Unique username for the user.

email (string, required, unique)​

Unique email address of the user.

mobile (string, optional)​

Includes country code (e.g. 919876543210 for India)

Mobile number of the user.

roles (array of strings, optional)​

List of roles to be assigned to the user. If not provided, the user will be assigned the default role specified in the environment variable IAM_DEFAULT_ROLE or Public role if the environment variable is not set. Also note, if roles are provided and the IAM_DEFAULT_ROLE is present, it will be added to the list of roles assigned to the user.

Further Reference​