Storiq One API  v1.0
API for Storiq One

User deletion

To delete a user, use DELETE method 

path : /storiqone-backend/api/v1/user/
Parameters
id: user id
Returns
HTTP status codes :
  • 200 Deletion successful
  • 400 User id is required
  • 401 Not logged in
  • 403 Permission denied
  • 404 User not found
  • 500 Query failure

User information

To get user information, use GET method 

path : /storiqone-backend/api/v1/user/
Parameters
id: user id
Returns
HTTP status codes :
  • 200 Query successful 
    User information is returned
  • 401 Not logged in
  • 403 Permission denied
  • 404 User not found
  • 500 Query failure

Users ids

To get users ids list, use GET method : without reference to specific id or ids 

path : /storiqone-backend/api/v1/user/

Optional parameters

Name Type Description Constraint
order_by enum order by column single value from : 'id', 'login', 'fullname', 'email', 'homedirectory'
order_ascboolean TRUE will perform an ascending order and FALSE will perform an descending order.
order_asc is ignored if order_by is missing
limit integer specifies the maximum number of rows to return limit > 0
offset integer specifies the number of rows to skip before starting to return rows offset >= 0
Warning
To get users ids list do not pass an id or ids as parameter
Returns
HTTP status codes :
  • 200 Query successful 
    Users ids list is returned
  • 400 Incorrect input
  • 401 Not logged in
  • 403 Permission denied
  • 500 Query failure

User creation

To create a user, use POST method 

path : /storiqone-backend/api/v1/user/
Parameters
user: JSON encoded object
  • login (string) : user login
  • password (string) : user password
  • fullname (string) : user fullname
  • email (string) : user email
  • homedirectory (string) : user homedirectory
  • isadmin (boolean) : administration rights
  • canarchive (boolean) : archive rights
  • canrestore (boolean) : restoration rights
  • meta (JSON) : user metadata
  • poolgroup (integer) : user poolgroup
  • disabled (boolean) : login rights
Returns
HTTP status codes :
  • 201 User created successfully 
    New user id is returned
  • 400 Bad request - Either ; user information is required or incorrect input
  • 401 Not logged in
  • 403 Permission denied
  • 500 Query failure

User update

To update a user, use PUT method 

path : /storiqone-backend/api/v1/user/
Parameters
user: JSON encoded object
  • id (integer) : user id
  • login (string) : user login
  • password (string) : user password
  • fullname (string) : user fullname
  • email (string) : user email
  • homedirectory (string) : user homedirectory
  • isadmin (boolean) : administration rights
  • canarchive (boolean) : archive rights
  • canrestore (boolean) : restoration rights
  • meta (JSON) : user metadata
  • poolgroup (integer) : user poolgroup
  • disabled (boolean) : login rights
Returns
HTTP status codes :
  • 200 User updated successfully
  • 400 Bad request - Either ; user information is required or incorrect input
  • 401 Not logged in
  • 403 Permission denied
  • 500 Query failure