Get all users
path Parameters
orgIdstring · requiredThe id of the organization.
query Parameters
IsActivebooleanSet to true to filter only active users, false for inactive and do not set to see all users
SearchstringSearch text to filter the users by name and email
SortOptionsstring · enumHow to sort the list
Enum values:FirstNameASCFirstNameDESCLastActivityASCLastActivityDESClimitinteger · int32The number of records to return. Max 30.
pageinteger · int32The page offset when fetching the records
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Success
dataobjectsuccessbooleanerrorsarray | null
Register a user
path Parameters
orgIdstring · requiredThe id of the organization.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
emailstring | nullThe user's email
userRolestring · enumEnum values:OperatorDeviceManagerConfigManagerAdmin
Responses
Success
databooleansuccessbooleanerrorsarray | null
Get a user by id
path Parameters
idstring · uuid · requiredThe user's id
The user id
orgIdstring · requiredThe id of the organization.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Success
dataobjectsuccessbooleanerrorsarray | null
Delete a user
path Parameters
idstring · uuid · requiredThe user id to delete
The user id
orgIdstring · requiredThe id of the organization.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Success
databooleansuccessbooleanerrorsarray | null
Update role for a user
path Parameters
idstring · uuid · requiredThe user id
The user id
orgIdstring · requiredThe id of the organization.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Success
databooleansuccessbooleanerrorsarray | null