Format of the User Configuration File

The Xentara user configuration file has the following format:

{
  "$schema": "https://docs.xentara.io/xentara/schema-xentara-users.json",
  "users": [
    {
      "userName": "Jane Doe",
      "UUID": "dbce20f6-5938-48ec-8637-9905ade006bc",
      "roles": [ "Administrator" ]
    },
    {
      "userName": "john-smith",
      "UUID": "24820e67-85df-4b00-8fae-86201fc7d638",
      "roles": [ "Maintenance", "Electrical" ]
    },
    {
      "userName": "t.johnson",
      "UUID": "29eb450e-ff29-4afc-883b-37676be5e8a8",
      "roles": [ "Auditor" ]
    }
  ]
}

Object Members

$schema

An optional string value containing the URI of the JSON schema for Xentara user configuration files. Xentara itself ignores this member, but some editors may use it to associate the model file with the correct JSON schema. The schema schould always point to https://docs.xentara.io/xentara/schema-xentara-users.json.

users

An optional JSON array containing the configuration of the individual users. The configuration for each user is contained in a JSON object within the array. The format of the individual objects is described below. The array can contain as many or as few entries as desired. If the array is empty, or if you do not specify this parameter, no users will be defined, and authentication of remote clients via username/password authentication will not be possible.

User Object Members

userName	A string containing the user’s user name. The string must not be empty, but can otherwise contain any legal unicode character. Note User names that include a colon character (:) are incompatible with the “Basic” HTTP authentication scheme, so users with a colon in their user name will not be able to log on using HTTP-based protocols. The same goes for control characters.
UUID	A string value containing the UUID of the user. The UUID must be unique. The UUID is used, for example, to find the user’s password in the Xentara password file.
roles	An optional JSON array containing the names of additional roles assigned to the user. The role “Everyone” is assigned automatically to all users, and should not appear in this array. If this array is empty, or if you do not specify this parameter, then the user will only have the role “Everyone”.

A JSON schema file to validate user configuration files is available here.