User Management

warp1

users/config

The user configuration. Can be updated with users/add, users/modify, users/remove and users/http_auth_update.

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Read

curl http://$HOST/users/config

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/users/config

{
  "users": [
{
  "next_user_id": 5,
  "http_auth_enabled": true,
  // Not returned
  "http_auth_username": null,
  // Not returned
  "digest_hash": null,
  "users": [
    // Example data
    {
      "id": 1,
      "roles": 15,
      "current": 32000,
      "display_name": "Anonymous User",
      "username": "anonymous",
      "digest_hash": ""
    }
  ]
}
  ],
  // Nutzer 2 und 4 wurden gelöscht.
  "next_user_id": 5,
  "http_auth_enabled": true
}

Name	Description
users object[17]	The users [0..16] - A user Name Description id int ID of the user (1-255) roles int Permissions of the user. Not yet used. current int (mA) Charging current allowed for this user 6000 (=6 Ampere) to 32000 (=32 Ampere) or 0 to prohibit charging for this user display_name string Display name of the user. Also used in the charge tracker. username string Username for logging into the web interface and HTTP API. digest_hash string HTTP Digest hash. Returned as empty string if login is disabled for this user. Returned as null if login is enabled for this user.
next_user_id int	ID of the next user to be created.
http_auth_enabled bool	Indicates whether credentials are required to use the web interface and HTTP API. true - If credentials should be required. false - If not.

users/add

Adds a new user.

http

mqtt

Triggers a one-time action. Messages retained via the broker are ignored.

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Write

curl http://$HOST/users/add -d '{
    "id": 5,
    "roles": 65535,
    "current": 32000,
    "display_name": "Neuer Benutzer",
    "username": "testuser",
    "digest_hash": "926011006c2686471698e86690b7e500"
  }'

id muss der next_user_id aus users/config entsprechen, damit der Nutzer angelegt wird. digest_hash = MD5("testuser:esp32-lib:testpass")

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/users/add -m '{
    "id": 5,
    "roles": 65535,
    "current": 32000,
    "display_name": "Neuer Benutzer",
    "username": "testuser",
    "digest_hash": "926011006c2686471698e86690b7e500"
  }'

id muss der next_user_id aus users/config entsprechen, damit der Nutzer angelegt wird. digest_hash = MD5("testuser:esp32-lib:testpass")

Name	Description
id int	ID of the user to be created. Must match the current value of next_user_id from users/config.
roles int	Permissions of the user. Not yet used.
current int (mA)	Charging current allowed for this user 6000 (=6 Ampere) to 32000 (=32 Ampere) or 0 to prohibit charging for this user
display_name string	Display name of the user. Also used in the charge tracker.
username string	Username for logging into the web interface and HTTP API.
digest_hash string	HTTP Digest hash of the user to be created. An empty string prohibits login to the web interface.

users/remove

Deletes a user.

http

mqtt

Triggers a one-time action. Messages retained via the broker are ignored.

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Write

curl http://$HOST/users/remove -d '{ "id": 4 }'

or abbreviated:

curl http://$HOST/users/remove -d '4'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/users/remove -m '{ "id": 4 }'

or abbreviated:

mosquitto_pub -h $BROKER -t $PREFIX/users/remove -m '4'

Name	Description
id int	ID of the user to be deleted

users/modify

Modifies a user.

http

mqtt

Triggers a one-time action. Messages retained via the broker are ignored.

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Write

curl http://$HOST/users/modify -d '{
    "id": 5,
    "roles": null,
    "current": null,
    "display_name": "Neuer Benutzer (ohne Login)",
    "username": null,
    "digest_hash": ""
  }'

Ändert beispielsweise nur den Anzeigenamen vom Benutzer mit der ID 5 und löscht dessen Passwort. Dieser Nutzer kann sich dann nicht mehr im Webinterface einloggen oder die HTTP-API verwenden.

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/users/modify -m '{
    "id": 5,
    "roles": null,
    "current": null,
    "display_name": "Neuer Benutzer (ohne Login)",
    "username": null,
    "digest_hash": ""
  }'

Ändert beispielsweise nur den Anzeigenamen vom Benutzer mit der ID 5 und löscht dessen Passwort. Dieser Nutzer kann sich dann nicht mehr im Webinterface einloggen oder die HTTP-API verwenden.

Name	Description
id int	ID of the user to be modified.
roles int	Permissions of the user. Not yet used.
current int (mA)	Charging current allowed for this user 6000 (=6 Ampere) to 32000 (=32 Ampere) or 0 to prohibit charging for this user
display_name string	Display name of the user. Also used in the charge tracker.
username string	Username for logging into the web interface and HTTP API.
digest_hash string	HTTP Digest hash of the user. An empty string prohibits login to the web interface.

users/http_auth_update

Writes http_auth_enabled from users/config.

http

mqtt

Triggers a one-time action. Messages retained via the broker are ignored.

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Write

curl http://$HOST/users/http_auth_update -d '{ "enabled": false }'

or abbreviated:

curl http://$HOST/users/http_auth_update -d 'false'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/users/http_auth_update -m '{ "enabled": false }'

or abbreviated:

mosquitto_pub -h $BROKER -t $PREFIX/users/http_auth_update -m 'false'

Name	Description
enabled bool	Specifies whether credentials are required to use the web interface and HTTP API. true - If credentials should be required. false - If not.

users/all_usernames

HTTP (curl)

For charge tracking, the display names of deleted users are stored separately in flash. This function returns all display names that may appear in tracked charging sessions in a binary format.

MQTT (mosquitto)

Only supported by the HTTP API

warp2

users/config

The user configuration. Can be updated with users/add, users/modify, users/remove and users/http_auth_update.

Example

HTTP (curl)

# $HOST e.g. warp2-AbCd

Read

curl http://$HOST/users/config

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp2/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/users/config

{
  "users": [
{
  "next_user_id": 5,
  "http_auth_enabled": true,
  // Not returned
  "http_auth_username": null,
  // Not returned
  "digest_hash": null,
  "users": [
    // Example data
    {
      "id": 1,
      "roles": 15,
      "current": 32000,
      "display_name": "Anonymous User",
      "username": "anonymous",
      "digest_hash": ""
    }
  ]
}
  ],
  // Nutzer 2 und 4 wurden gelöscht.
  "next_user_id": 5,
  "http_auth_enabled": true
}

Name	Description
users object[33]	The users [0..32] - A user Name Description id int ID of the user (1-255) roles int Permissions of the user. Not yet used. current int (mA) Charging current allowed for this user 6000 (=6 Ampere) to 32000 (=32 Ampere) or 0 to prohibit charging for this user display_name string Display name of the user. Also used in the charge tracker. username string Username for logging into the web interface and HTTP API. digest_hash string HTTP Digest hash. Returned as empty string if login is disabled for this user. Returned as null if login is enabled for this user.
next_user_id int	ID of the next user to be created.
http_auth_enabled bool	Indicates whether credentials are required to use the web interface and HTTP API. true - If credentials should be required. false - If not.

users/add

Adds a new user.

http

mqtt

Triggers a one-time action. Messages retained via the broker are ignored.

Example

HTTP (curl)

# $HOST e.g. warp2-AbCd

Write

curl http://$HOST/users/add -d '{
    "id": 5,
    "roles": 65535,
    "current": 32000,
    "display_name": "Neuer Benutzer",
    "username": "testuser",
    "digest_hash": "926011006c2686471698e86690b7e500"
  }'

id muss der next_user_id aus users/config entsprechen, damit der Nutzer angelegt wird. digest_hash = MD5("testuser:esp32-lib:testpass")

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp2/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/users/add -m '{
    "id": 5,
    "roles": 65535,
    "current": 32000,
    "display_name": "Neuer Benutzer",
    "username": "testuser",
    "digest_hash": "926011006c2686471698e86690b7e500"
  }'

id muss der next_user_id aus users/config entsprechen, damit der Nutzer angelegt wird. digest_hash = MD5("testuser:esp32-lib:testpass")

Name	Description
id int	ID of the user to be created. Must match the current value of next_user_id from users/config.
roles int	Permissions of the user. Not yet used.
current int (mA)	Charging current allowed for this user 6000 (=6 Ampere) to 32000 (=32 Ampere) or 0 to prohibit charging for this user
display_name string	Display name of the user. Also used in the charge tracker.
username string	Username for logging into the web interface and HTTP API.
digest_hash string	HTTP Digest hash of the user to be created. An empty string prohibits login to the web interface.

users/remove

Deletes a user.

http

mqtt

Triggers a one-time action. Messages retained via the broker are ignored.

Example

HTTP (curl)

# $HOST e.g. warp2-AbCd

Write

curl http://$HOST/users/remove -d '{ "id": 4 }'

or abbreviated:

curl http://$HOST/users/remove -d '4'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp2/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/users/remove -m '{ "id": 4 }'

or abbreviated:

mosquitto_pub -h $BROKER -t $PREFIX/users/remove -m '4'

Name	Description
id int	ID of the user to be deleted

users/modify

Modifies a user.

http

mqtt

Triggers a one-time action. Messages retained via the broker are ignored.

Example

HTTP (curl)

# $HOST e.g. warp2-AbCd

Write

curl http://$HOST/users/modify -d '{
    "id": 5,
    "roles": null,
    "current": null,
    "display_name": "Neuer Benutzer (ohne Login)",
    "username": null,
    "digest_hash": ""
  }'

Ändert beispielsweise nur den Anzeigenamen vom Benutzer mit der ID 5 und löscht dessen Passwort. Dieser Nutzer kann sich dann nicht mehr im Webinterface einloggen oder die HTTP-API verwenden.

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp2/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/users/modify -m '{
    "id": 5,
    "roles": null,
    "current": null,
    "display_name": "Neuer Benutzer (ohne Login)",
    "username": null,
    "digest_hash": ""
  }'

Ändert beispielsweise nur den Anzeigenamen vom Benutzer mit der ID 5 und löscht dessen Passwort. Dieser Nutzer kann sich dann nicht mehr im Webinterface einloggen oder die HTTP-API verwenden.

Name	Description
id int	ID of the user to be modified.
roles int	Permissions of the user. Not yet used.
current int (mA)	Charging current allowed for this user 6000 (=6 Ampere) to 32000 (=32 Ampere) or 0 to prohibit charging for this user
display_name string	Display name of the user. Also used in the charge tracker.
username string	Username for logging into the web interface and HTTP API.
digest_hash string	HTTP Digest hash of the user. An empty string prohibits login to the web interface.

users/http_auth_update

Writes http_auth_enabled from users/config.

http

mqtt

Triggers a one-time action. Messages retained via the broker are ignored.

Example

HTTP (curl)

# $HOST e.g. warp2-AbCd

Write

curl http://$HOST/users/http_auth_update -d '{ "enabled": false }'

or abbreviated:

curl http://$HOST/users/http_auth_update -d 'false'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp2/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/users/http_auth_update -m '{ "enabled": false }'

or abbreviated:

mosquitto_pub -h $BROKER -t $PREFIX/users/http_auth_update -m 'false'

Name	Description
enabled bool	Specifies whether credentials are required to use the web interface and HTTP API. true - If credentials should be required. false - If not.

users/all_usernames

HTTP (curl)

For charge tracking, the display names of deleted users are stored separately in flash. This function returns all display names that may appear in tracked charging sessions in a binary format.

MQTT (mosquitto)

Only supported by the HTTP API

warp3

users/config

The user configuration. Can be updated with users/add, users/modify, users/remove and users/http_auth_update.

Example

HTTP (curl)

# $HOST e.g. warp3-AbCd

Read

curl http://$HOST/users/config

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp3/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/users/config

{
  "users": [
{
  "next_user_id": 5,
  "http_auth_enabled": true,
  // Not returned
  "http_auth_username": null,
  // Not returned
  "digest_hash": null,
  "users": [
    // Example data
    {
      "id": 1,
      "roles": 15,
      "current": 32000,
      "display_name": "Anonymous User",
      "username": "anonymous",
      "digest_hash": ""
    }
  ]
}
  ],
  // Nutzer 2 und 4 wurden gelöscht.
  "next_user_id": 5,
  "http_auth_enabled": true
}

Name	Description
users object[33]	The users [0..32] - A user Name Description id int ID of the user (1-255) roles int Permissions of the user. Not yet used. current int (mA) Charging current allowed for this user 6000 (=6 Ampere) to 32000 (=32 Ampere) or 0 to prohibit charging for this user display_name string Display name of the user. Also used in the charge tracker. username string Username for logging into the web interface and HTTP API. digest_hash string HTTP Digest hash. Returned as empty string if login is disabled for this user. Returned as null if login is enabled for this user.
next_user_id int	ID of the next user to be created.
http_auth_enabled bool	Indicates whether credentials are required to use the web interface and HTTP API. true - If credentials should be required. false - If not.

users/add

Adds a new user.

http

mqtt

Triggers a one-time action. Messages retained via the broker are ignored.

Example

HTTP (curl)

# $HOST e.g. warp3-AbCd

Write

curl http://$HOST/users/add -d '{
    "id": 5,
    "roles": 65535,
    "current": 32000,
    "display_name": "Neuer Benutzer",
    "username": "testuser",
    "digest_hash": "926011006c2686471698e86690b7e500"
  }'

id muss der next_user_id aus users/config entsprechen, damit der Nutzer angelegt wird. digest_hash = MD5("testuser:esp32-lib:testpass")

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp3/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/users/add -m '{
    "id": 5,
    "roles": 65535,
    "current": 32000,
    "display_name": "Neuer Benutzer",
    "username": "testuser",
    "digest_hash": "926011006c2686471698e86690b7e500"
  }'

id muss der next_user_id aus users/config entsprechen, damit der Nutzer angelegt wird. digest_hash = MD5("testuser:esp32-lib:testpass")

Name	Description
id int	ID of the user to be created. Must match the current value of next_user_id from users/config.
roles int	Permissions of the user. Not yet used.
current int (mA)	Charging current allowed for this user 6000 (=6 Ampere) to 32000 (=32 Ampere) or 0 to prohibit charging for this user
display_name string	Display name of the user. Also used in the charge tracker.
username string	Username for logging into the web interface and HTTP API.
digest_hash string	HTTP Digest hash of the user to be created. An empty string prohibits login to the web interface.

users/remove

Deletes a user.

http

mqtt

Triggers a one-time action. Messages retained via the broker are ignored.

Example

HTTP (curl)

# $HOST e.g. warp3-AbCd

Write

curl http://$HOST/users/remove -d '{ "id": 4 }'

or abbreviated:

curl http://$HOST/users/remove -d '4'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp3/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/users/remove -m '{ "id": 4 }'

or abbreviated:

mosquitto_pub -h $BROKER -t $PREFIX/users/remove -m '4'

Name	Description
id int	ID of the user to be deleted

users/modify

Modifies a user.

http

mqtt

Triggers a one-time action. Messages retained via the broker are ignored.

Example

HTTP (curl)

# $HOST e.g. warp3-AbCd

Write

curl http://$HOST/users/modify -d '{
    "id": 5,
    "roles": null,
    "current": null,
    "display_name": "Neuer Benutzer (ohne Login)",
    "username": null,
    "digest_hash": ""
  }'

Ändert beispielsweise nur den Anzeigenamen vom Benutzer mit der ID 5 und löscht dessen Passwort. Dieser Nutzer kann sich dann nicht mehr im Webinterface einloggen oder die HTTP-API verwenden.

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp3/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/users/modify -m '{
    "id": 5,
    "roles": null,
    "current": null,
    "display_name": "Neuer Benutzer (ohne Login)",
    "username": null,
    "digest_hash": ""
  }'

Ändert beispielsweise nur den Anzeigenamen vom Benutzer mit der ID 5 und löscht dessen Passwort. Dieser Nutzer kann sich dann nicht mehr im Webinterface einloggen oder die HTTP-API verwenden.

Name	Description
id int	ID of the user to be modified.
roles int	Permissions of the user. Not yet used.
current int (mA)	Charging current allowed for this user 6000 (=6 Ampere) to 32000 (=32 Ampere) or 0 to prohibit charging for this user
display_name string	Display name of the user. Also used in the charge tracker.
username string	Username for logging into the web interface and HTTP API.
digest_hash string	HTTP Digest hash of the user. An empty string prohibits login to the web interface.

users/http_auth_update

Writes http_auth_enabled from users/config.

http

mqtt

Triggers a one-time action. Messages retained via the broker are ignored.

Example

HTTP (curl)

# $HOST e.g. warp3-AbCd

Write

curl http://$HOST/users/http_auth_update -d '{ "enabled": false }'

or abbreviated:

curl http://$HOST/users/http_auth_update -d 'false'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp3/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/users/http_auth_update -m '{ "enabled": false }'

or abbreviated:

mosquitto_pub -h $BROKER -t $PREFIX/users/http_auth_update -m 'false'

Name	Description
enabled bool	Specifies whether credentials are required to use the web interface and HTTP API. true - If credentials should be required. false - If not.

users/all_usernames

HTTP (curl)

For charge tracking, the display names of deleted users are stored separately in flash. This function returns all display names that may appear in tracked charging sessions in a binary format.

MQTT (mosquitto)

Only supported by the HTTP API

wem

Not supported on this hardware!

wem2

Not supported on this hardware!

any

users/config

The user configuration. Can be updated with users/add, users/modify, users/remove and users/http_auth_update.

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Read

curl http://$HOST/users/config

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/users/config

{
  "users": [
{
  "next_user_id": 5,
  "http_auth_enabled": true,
  // Not returned
  "http_auth_username": null,
  // Not returned
  "digest_hash": null,
  "users": [
    // Example data
    {
      "id": 1,
      "roles": 15,
      "current": 32000,
      "display_name": "Anonymous User",
      "username": "anonymous",
      "digest_hash": ""
    }
  ]
}
  ],
  // Nutzer 2 und 4 wurden gelöscht.
  "next_user_id": 5,
  "http_auth_enabled": true
}

Name	Description
users object[..]	The users (Only WARP 1) [0..16] - A user Name Description id int ID of the user (1-255) roles int Permissions of the user. Not yet used. current int (mA) Charging current allowed for this user 6000 (=6 Ampere) to 32000 (=32 Ampere) or 0 to prohibit charging for this user display_name string Display name of the user. Also used in the charge tracker. username string Username for logging into the web interface and HTTP API. digest_hash string HTTP Digest hash. Returned as empty string if login is disabled for this user. Returned as null if login is enabled for this user. (Only WARP 2 and WARP 3) [0..32] - A user Name Description id int ID of the user (1-255) roles int Permissions of the user. Not yet used. current int (mA) Charging current allowed for this user 6000 (=6 Ampere) to 32000 (=32 Ampere) or 0 to prohibit charging for this user display_name string Display name of the user. Also used in the charge tracker. username string Username for logging into the web interface and HTTP API. digest_hash string HTTP Digest hash. Returned as empty string if login is disabled for this user. Returned as null if login is enabled for this user.
next_user_id int	ID of the next user to be created.
http_auth_enabled bool	Indicates whether credentials are required to use the web interface and HTTP API. true - If credentials should be required. false - If not.

users/add

Adds a new user.

http

mqtt

Triggers a one-time action. Messages retained via the broker are ignored.

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Write

curl http://$HOST/users/add -d '{
    "id": 5,
    "roles": 65535,
    "current": 32000,
    "display_name": "Neuer Benutzer",
    "username": "testuser",
    "digest_hash": "926011006c2686471698e86690b7e500"
  }'

id muss der next_user_id aus users/config entsprechen, damit der Nutzer angelegt wird. digest_hash = MD5("testuser:esp32-lib:testpass")

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/users/add -m '{
    "id": 5,
    "roles": 65535,
    "current": 32000,
    "display_name": "Neuer Benutzer",
    "username": "testuser",
    "digest_hash": "926011006c2686471698e86690b7e500"
  }'

id muss der next_user_id aus users/config entsprechen, damit der Nutzer angelegt wird. digest_hash = MD5("testuser:esp32-lib:testpass")

Name	Description
id int	ID of the user to be created. Must match the current value of next_user_id from users/config.
roles int	Permissions of the user. Not yet used.
current int (mA)	Charging current allowed for this user 6000 (=6 Ampere) to 32000 (=32 Ampere) or 0 to prohibit charging for this user
display_name string	Display name of the user. Also used in the charge tracker.
username string	Username for logging into the web interface and HTTP API.
digest_hash string	HTTP Digest hash of the user to be created. An empty string prohibits login to the web interface.

users/remove

Deletes a user.

http

mqtt

Triggers a one-time action. Messages retained via the broker are ignored.

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Write

curl http://$HOST/users/remove -d '{ "id": 4 }'

or abbreviated:

curl http://$HOST/users/remove -d '4'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/users/remove -m '{ "id": 4 }'

or abbreviated:

mosquitto_pub -h $BROKER -t $PREFIX/users/remove -m '4'

Name	Description
id int	ID of the user to be deleted

users/modify

Modifies a user.

http

mqtt

Triggers a one-time action. Messages retained via the broker are ignored.

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Write

curl http://$HOST/users/modify -d '{
    "id": 5,
    "roles": null,
    "current": null,
    "display_name": "Neuer Benutzer (ohne Login)",
    "username": null,
    "digest_hash": ""
  }'

Ändert beispielsweise nur den Anzeigenamen vom Benutzer mit der ID 5 und löscht dessen Passwort. Dieser Nutzer kann sich dann nicht mehr im Webinterface einloggen oder die HTTP-API verwenden.

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/users/modify -m '{
    "id": 5,
    "roles": null,
    "current": null,
    "display_name": "Neuer Benutzer (ohne Login)",
    "username": null,
    "digest_hash": ""
  }'

Ändert beispielsweise nur den Anzeigenamen vom Benutzer mit der ID 5 und löscht dessen Passwort. Dieser Nutzer kann sich dann nicht mehr im Webinterface einloggen oder die HTTP-API verwenden.

Name	Description
id int	ID of the user to be modified.
roles int	Permissions of the user. Not yet used.
current int (mA)	Charging current allowed for this user 6000 (=6 Ampere) to 32000 (=32 Ampere) or 0 to prohibit charging for this user
display_name string	Display name of the user. Also used in the charge tracker.
username string	Username for logging into the web interface and HTTP API.
digest_hash string	HTTP Digest hash of the user. An empty string prohibits login to the web interface.

users/http_auth_update

Writes http_auth_enabled from users/config.

http

mqtt

Triggers a one-time action. Messages retained via the broker are ignored.

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Write

curl http://$HOST/users/http_auth_update -d '{ "enabled": false }'

or abbreviated:

curl http://$HOST/users/http_auth_update -d 'false'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/users/http_auth_update -m '{ "enabled": false }'

or abbreviated:

mosquitto_pub -h $BROKER -t $PREFIX/users/http_auth_update -m 'false'

Name	Description
enabled bool	Specifies whether credentials are required to use the web interface and HTTP API. true - If credentials should be required. false - If not.

users/all_usernames

HTTP (curl)

For charge tracking, the display names of deleted users are stored separately in flash. This function returns all display names that may appear in tracked charging sessions in a binary format.

MQTT (mosquitto)

Only supported by the HTTP API