Represents a user to this API.

Methods

MethodAuthorizationUriDescription
listAccess JSON Web Token (ManageUser)GET /userGets list of users.
countAccess JSON Web Token (ManageUser)GET /user/countGets count of users.
getAccess JSON Web Token (GetCurrentUser)GET /user/{id}Gets information about user and its assigned networks.
Only administrators are allowed to get information about any user. User-level accounts can only retrieve information about themselves.
insertAccess JSON Web Token (ManageUser)POST /userCreates new user.
updateAccess JSON Web Token (UpdateCurrentUser)PUT /user/{id}Updates an existing user.
Only administrators are allowed to update any property of any user. User-level accounts can only change their own password in case:
They already have a password.
They provide a valid current password in the 'oldPassword' property.
deleteAccess JSON Web Token (ManageUser)DELETE /user/{id}Deletes an existing user.
getCurrentAccess JSON Web Token (ManageUser)GET /user/currentGets information about user/network association.
Only administrators are allowed to get information about any user. User-level accounts can only retrieve information about themselves.
updateCurrentAccess JSON Web Token (ManageUser)PUT /user/currentUpdates the current user.
Only administrators are allowed to update any property of any user. User-level accounts can only change their own password in case:
They already have a password.
They provide a valid current password in the 'oldPassword' property.
getNetworkAccess JSON Web Token (ManageUser)GET /user/{id}/network/{networkId}Gets information about user/network association.
assignNetworkAccess JSON Web Token (ManageUser)PUT /user/{id}/network/{networkId}Associates network with the user.
unassignNetworkAccess JSON Web Token (ManageUser)DELETE /user/{id}/network/{networkId}Removes association between network and user.
assignDeviceTypeAccess JSON Web Token (ManageUser)PUT /user/{id}/devicetype/{deviceTypeId}Associates device type with the user.
unassignDeviceTypeAccess JSON Web Token (ManageUser)DELETE /user/{id}/devicetype/{deviceTypeId}Removes association between device type and user.
getDeviceTypesAccess JSON Web Token (ManageUser)GET /user/{id}/devicetypeGets information about all user/device type associations.
allowAllDeviceTypesAccess JSON Web Token (ManageUser)PUT /user/{id}/devicetype/allAllows all device types for user.
disallowAllDeviceTypesAccess JSON Web Token (ManageUser)DELETE /user/{id}/devicetype/allDisallows all device types for user.

Resource Representation

{
    "id": {integer},
    "login": {string},
    "role": {integer},
    "status": {integer},
    "lastLogin": {datetime},
    "data": {object},
    "introReviewed": {boolean}
}
Property NameTypeDescription
idintegerUser identifier.
loginstringUser login using during authentication.
roleintegerUser role. Available values:
0: Administrator role
1: Client role
statusintegerUser status. Available values:
0: The user is active
1: The user has been locked out due to invalid login attempts
2: The user has been disabled
lastLogindatetimeUser last login timestamp (UTC).
dataobjectUser data, a JSON object with an arbitrary structure.
introReviewedbooleanIndicates if user reviewed an intro.