ZeroKey

User Management

Global system user management.

Get all current users info

SecurityOAuth2 or ApiKey
Responses
200

Response success

400

Malformed request.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden. Current token does not have the necessary authority for the operation.

422

Invalid data was sent.

get/system/users
Request samples 
Response samples 
application/json
[
  • {
    }
]
Add a new users
SecurityOAuth2 or ApiKey 
Request 
Request Body schema: applicajon/json
Set quality of service


FullName
string
The full name of the user


 
Username
string
The username of the user


 
Authority
string
The access level granted to the user


 Enum: "observer" "user" "admin"  
Password
string
The current password of the user


 
Responses 
200
Response success


400
Malformed request.


401
Unauthorized access, invalid credentials were used.


403
Access forbidden. Current token does not have the necessary authority for the operation.


422
Invalid data was sent.


post/system/user
Request samples 
applicajon/json
{
  • "FullName": "Zero Key",
  • "Username": "Zerokey",
  • "Authority": "observer",
  • "Password": "string"
}
Response samples 
application/json
[
  • {
    }
]
Update info of target user
SecurityOAuth2 or ApiKey 
Request 
path Parameters
UserID
required
string
The UserID of the target user


 
Request Body schema: applicajon/json
Set updated info of the target user


FullName
string
The full name of the user


 
Username
string
The username of the user


 
Authority
string
The access level granted to the user


 Enum: "observer" "user" "admin"  
Password
string
The current password of the user


 
NewPassword
string
The new password of the user


 
Responses 
200
Response success


400
Malformed request.


401
Unauthorized access, invalid credentials were used.


403
Access forbidden. Current token does not have the necessary authority for the operation.


422
Invalid data was sent.


put/system/user/{UserID}
Request samples 
applicajon/json
{
  • "FullName": "Zero Key",
  • "Username": "Zerokey",
  • "Authority": "observer",
  • "Password": "string",
  • "NewPassword": "string"
}
Response samples 
application/json
{
  • "UserID": "1800ac5a-f146-45f3-aedc-d62845570b86",
  • "FullName": "Zero Key",
  • "Username": "Zerokey",
  • "Authority": "observer",
  • "CreatedTimestamp": "2016-05-16T00:00:00.0000Z",
  • "ModifiedTimestamp": "2016-05-16T00:00:00.0000Z"
}
Delete target user
SecurityOAuth2 or ApiKey 
Request 
path Parameters
UserID
required
string
The UserID of the target user


 
Responses 
200
Response success


401
Unauthorized access, invalid credentials were used.


403
Access forbidden. Current token does not have the necessary authority for the operation.


404
Resource was not found.


delete/system/user/{UserID}
Request samples 
Response samples 
application/json
{
  • "status": 200,
  • "success": true
}
➔ Next to Connection Management