Flussonic Watcher documentation

User import API

You can import users and settings from third-party systems, databases or spreadsheets using API. It requires API authorization. To do that, include the APIKEY that can be found in the Watcher settings in the x-vsaas-api-key HTTP header.

To import a list of users, create a CSV file and send it to:

http(s)://YOUR_WATCHER_URL/vsaas/api/import/users

CSV file fields:

  • email — the main user ID for authentication that is also used for password recovery.
  • password — plain text password.
  • is_active — 1: active user; 0: blocked user.
  • is_admin — 1: administrator user; 0: regular user.
  • groups — a list of groups to which the user belongs. Delimiter is a semicolon ';'.
  • note — a comment to this user.
  • Command-line import:

    curl --data-binary @mydata.csv -H 'Content-type:text/plain; charset=utf-8' -H 'x-vsaas-api-key: API_KEY_ВАШЕГО ВОТЧЕРА' http://WATCHER-HOSTNAME/vsaas/api/import/users
    

    mydata.csv example:

    email,password,is_active,is_admin,note,groups
    ivanov@domain.tld,CergitMig,1,0,user1,grp1;grp2
    petrov@domain.tld,LajQuolOy,0,1,user2,grp2
    

    One string example:

    echo -e "email,password,is_active,is_admin,note,groups\nivanov@domain.tld,CergitMig,1,0,user1,grp1;grp2\npetrov@domain.tld,LajQuolOy,0,1,user2,grp2" | curl http://127.0.0.1:8080/vsaas/api/import/users?type=csv --data-binary @-  -H 'Content-type:text/plain; charset=utf-8' -H 'x-vsaas-api-key: 3a7d9386-6c3a-440d-a75d-e6b3fdc3368e'
    

    Response:

    {"success": true}