WHERE DO I START?
You are here:... (Miscellaneous) > API > Users
  • Top ↑

Users

The users API allows you to access and manage your users.

Tip   To explore Netuitive's REST API and test some requests, go here.

Get a list of users

This method will return a list of users associated with a tenant.

Method GET URL https://api.app.netuitive.com/users
Parameters Required/Optional Description
N/A N/A N/A

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Create a user

This method creates a user for a tenant.

Method POST URL https://api.app.netuitive.com/users
Parameters Required/Optional Description
wrapper Optional Body parameter; see below.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Input JSON Format for Request Body

Attribute Required/Optional Description
active Optional Whether the user is active or not.
administrator Optional

Whether the user is an administrator for the tenant or not.

Important   Only one of either administrator or readOnly may be passed in as true, but if neither the administrator or readOnly attributes are specified, the user will default to being an administrator.
email Optional The email of the user used for logging in.
id Optional The ID of the user.
password Optional The password of the user.
properties Optional

A list of the user's stored preferences, sorts, selected theme and nav, daily report settings, and modal settings.

readOnly Optional Whether the user is a read only user.

Get the current user

This method will return information about the user currently signed in.

Method GET URL https://api.app.netuitive.com/users/current
Parameters Required/Optional Description
N/A N/A N/A

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Delete a user

This method will delete a given user.

Method DELETE URL https://api.app.netuitive.com/users/{id}
Important   Replace {id} in the above URL with the user ID from any of your users.
Parameters Required/Optional Description
id Required URL (path) parameter. The ID of the user.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Get a user by ID

This method will return a user for the given id.

Method GET URL https://api.app.netuitive.com/users/{id}
Important   Replace {id} in the above URL with the user ID from any of your users.
Parameters Required/Optional Description
id Required URL (path) parameter. The ID of the user.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Update a user

This method will allow you to update a given user's information.

Method PUT URL https://api.app.netuitive.com/users/{id}
Important   Replace {id} in the above URL with the user ID from any of your users.
Parameters Required/Optional Description
id Required URL (path) parameter. The ID of the user.
wrapper Optional Body parameter; see below.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Input JSON Format for Request Body

Attribute Required/Optional Description
active Optional Whether the user is active or not.
administrator Optional

Whether the user is an administrator for the tenant or not.

Important   Only one of either administrator or readOnly may be passed in as true, but if neither the administrator or readOnly attributes are specified, the user will default to being an administrator.
email Optional The email of the user used for logging in.
id Optional The ID of the user.
password Optional The password of the user.
properties Optional

A list of the user's stored preferences, sorts, selected theme and nav, daily report settings, and modal settings.

readOnly Optional Whether the user is a read only user.

Update a user's password

This method will update the password for a given user.

Method POST URL https://api.app.netuitive.com/users/{id}/password
Important   Replace {id} in the above URL with the user ID from any of your users.
Parameters Required/Optional Description
id Required URL (path) parameter. The ID of the user.
oldPassword Required Query parameter. The user's current password.
newPassword Required Query parameter. The user's desired new password.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)