API: Managing users

You can use Haiilo's API to manage your users. If you want to automate user management, you can write scripts in your preferred programming language and automate, for example, creating, activating, deactivating, and deleting users.

To make calls to the Haiilo API, you need to authenticate first. You can find detailed information about authenticating and using the API here. Also, to perform the following API steps, please make sure to sign in as a superadmin.

Create a user

  1. Start a new request
  2. Enter the request body containing the user information you'd like to update for the user. Example request text:
    {
      "email": "email@example.com",
      "loginName": null,
      "loginNameAlt": null,
      "firstname": "First Name",
      "lastname": "Last Name",
      "active": false,
      "superadmin": false,
      "groupIds": [ "89e32c67-e8ea-4f7a-b8ad-61d99fc051f9" ],
      "roleIds": [ "02e43ba4-e45b-4000-9a85-74d44e2ef2d1" ],
      "remoteLogonName": null,
      "persistedDisplayName": null,
      "password": "SomePassword_123!",
      "welcomeMail": false,
      "generatePassword": false,
      "language": null,
      "temporaryPassword": true,
      "initialUser": false
    }
    
  3. Make a POST request to the endpoint /api/users

Activate a user

  1. Make a PUT request to the endpoint /api/users/<user_id>/activate where <user_id> is the id of the user you want to activate

Deactivate a user

  1. Make a PUT request to the endpoint /api/users/<user_id>/deactivate where <user_id> is the id of the user you want to deactivate

Delete a user

  1. Make a DELETE request to the endpoint /api/users/<user_id> where <user_id> is the id of the user you want to delete

Was this article helpful?