With the Sisense REST API your customers can manage users programmatically through your native application. This allows you to provide your customers with functionality such as adding, updating, or deleting users outside of the Sisense Web Application.

There are two versions of the REST API you can leverage to manage users, v.9 and v1.0. Version .9 was developed prior to Sisense 6.0 whereas Version 1.0 was designed afterwards and has improved endpoints.

Through the REST API, you can perform the following tasks:

Retrieving a List of Users
Adding New Users
Importing New Active Directory Users
Adding Bulk Amounts of Users
Updating User Credentials
Validating User Emails
Deleting Users
Resetting Passwords

Retrieving a List of Users

For version .9 and 1.0 of the REST API, you can retrieve a full list of all your users through the GET /users call. This call returns the following details:

PropertyTypeDescription
_idStringThe user's unique ID generated by Sisense.
usernameStringThe user's username.
roleIdStringA ID that represents the user’s role generated by Sisense.
roleNameStringThe user's role name.
emailStringThe user’s email address.
firstNameStringThe user’s first name.
lastNameStringThe user’s last name.
activeBooleanIndicates if the user’s account is activated.
changePasswordStateBooleanIndicates if the user can change their password.
groupsArrayLists any groups the user belongs to.
pendingExpirationDate/TimeThe date when the user’s license expires.
createdDate/TimeThe date on which the user was created.
lastUpdatedDate/TimeThe user's last update.
lastLoginDate/TimeThe last time the user logged in.
activeDirectoryBooleanIndicates if the user is listed in an Active Directory.
adgroupsArrayLists the Active Directory groups the user belongs to.
dnStringThis is an active directory field, Distinguish Name, which represents the unique name of an active directory object
principalNameStringThe login name for active directory.
uSNChangedStringAn active directory field that represents a timestamp of the last change to this object.

Adding New Users

For version .9 and 1.0 of the REST API, you can add new users through the POST /users call. To add new users, provide the following details where relevant:

PropertyTypeDescription
usernameStringThe user's username.
roleIdStringA ID that represents the user’s role generated by Sisense.
emailStringThe user’s email address.
firstNameStringThe user’s first name.
lastNameStringThe user’s last name.
groupsArrayLists any groups the user belongs to.
activeDirectoryBooleanIndicates if the user is listed in an Active Directory.
localeIdStringThis is an active directory field, Distinguish Name, which represents the unique name of an active directory object
notifyBooleanSend email notifications to the user.

Importing New Active Directory Users

For version .9 and 1.0 of the REST API, you can import new users of Active Directory through the POST /users/ad call. To add new users, provide the following details where relevant:

PropertyTypeDescription
usernameStringThe user's username.
roleIdStringA ID that represents the user’s role generated by Sisense.
emailStringThe user’s email address.
firstNameStringThe user’s first name.
lastNameStringThe user’s last name.
groupsArrayLists any groups the user belongs to.
activeDirectoryBooleanIndicates if the user is listed in an Active Directory.
localeIdStringThis is an active directory field, Distinguish Name, which represents the unique name of an active directory object
notifyBooleanSend email notifications to the user.

Adding Bulk Amounts of Users

For version 1.0 of the REST API, you can import new users of Active Directory through the POST /users/ad call. To add new users, provide the following details where relevant:

PropertyTypeDescription
usernameStringThe user's username.
roleIdStringA ID that represents the user’s role generated by Sisense.
emailStringThe user’s email address.
firstNameStringThe user’s first name.
lastNameStringThe user’s last name.
groupsArrayLists any groups the user belongs to.
passwordStringYour users’ passwords.

Updating User Credentials

For version 1.0 of the REST API, you can edit your users details through the Patch /users/{id} call. To add new users, provide the following details where relevant:

PropertyTypeDescription
_idStringThe user's unique ID generated by Sisense.
usernameStringThe user's username.
roleIdStringA ID that represents the user’s role generated by Sisense.
roleNameStringThe user's role name.
emailStringThe user’s email address.
firstNameStringThe user’s first name.
lastNameStringThe user’s last name.
activeBooleanIndicates if the user’s account is activated.
changePasswordStateBooleanIndicates if the user can change their password.
groupsArrayLists any groups the user belongs to.
objectSidStringA binary value that represents the security identifier (SID) of an active directory user.
createdDate/TimeThe date on which the user was created.
lastLoginDate/TimeThe last time the user logged in.
lastUpdatedDate/TimeThe user's last update.
pendingExpirationDate/TimeThe date when the user’s license expires.
activeDirectoryBooleanIndicates if the user is listed in an Active Directory.
adgroupsArrayLists the Active Directory groups the user belongs to.
dnStringThis is an active directory field, Distinguish Name, which represents the unique name of an active directory object
principalNameStringThe login name for active directory.
uSNChangedStringAn active directory field that represents a timestamp of the last change to this object.

Deleting Users

For version .9 and 1.0 of the REST API, you can delete users through the DELETE /users/{user} (.9) or the DELETE /users/{id} (1.0) calls. To delete a user, you must provide the user’s name or ID in the Deleter call.

Validating User Emails

For version .9 of the REST API, you can validate if your users’ email addresses are stored in Sisense and whether or not the user is still active through the POST /users/validate/ call.

To validate a user’s email, you must provide the user’s email address as a string within an array.

Resetting Passwords

For version .9 of the REST API, you can reset your users’ passwords through the POST /users/forgetpassword/ call.

To reset a user’s password, you must provide the user’s email address as a string within an array.