Skip to content

Users#

Provisioning of the admin password and user.

Defaults#

Commented File-structure#

users.xml
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
<?xml version="1.0" encoding="utf-8"?>
<!-- A list of all users
     type: list -->
<users version="1.34.0">
  <!-- A single user
       parameters:
         name: The name of the user used for login.
               It is at the same time the unique id.
               type: string
               matched against: '^[^:]*$' -->
  <user name="">
    <!-- The name of the user used for display.
         If it is empty, the name will be used.
         This setting is DEPRECATED, will not be shown anywhere
         type: string -->
    <displayName></displayName>
    <!-- The password for the user.
         If the password is provisioned, you have to
         supply a hashed password.
         You can create a compatible hash using the
         tool provided in the web interface
         at the following url:
         `https://<Your-IP>/#/generateHash`.
         Over the api, you send the password over HTTPS
         in clear text, where it gets hashed in the
         webserver.
         type: string -->
    <password></password>
    <!-- The role for the user.
         an admin is allowed to do everything.
         A user is not allowed to configure anything by default,
         additional rights for the user have to be explicitly granted
         type: enum
         accepted values:
           user
           admin -->
    <role>user</role>
    <!-- The image for the user, base64 encoded or as http(s) uri.
         The image should not exceed 300x300px.
         This setting is DEPRECATED, will not be shown anywhere
         type: string -->
    <image></image>
    <!-- Indicates whether a user has to change his password.
         This flag will only be evaluated by client side logins
         and any tool handling the login should honour it.
         type: boolean -->
    <changePassword>false</changePassword>
  </user>
</users>