Every user of an iHub volume has an account on that volume. The REST API can manage user accounts on a volume using the /users resource to create, modify, and delete accounts. Only members of the Administrators user group can use this resource.
The following sections provide an example of using each users resource as a curl command.
GET users
This example requests the list of users whose names begin with the letter m:
GET /ihub/v1/users?search=m* HTTP/1.1
host: myserver.mycompanyname.com:5000
AuthId: <authId>
This curl example requests the list of users whose names begin with the letter m in the default volume:
This curl example sends a POST request to iHub to create the user user1 in the default volume:
curl -i http://%RESTHost%:5000/ihub/v1/users ‑H "AuthId:%RESTAuthId%" ‑d name="user1" ‑d email="test@mycompanynamehere.com" ‑d description="A user account for testing user requests"
PUT users/{userId}
This example changes the description of the user with user ID 200000000100:
PUT /ihub/v1/users/200000000100 HTTP/1.1
Host: myserver.mycompanyname.com:5000
Content-Type: application/x-www-form-urlencoded
AuthId: <authId>
description=Senior%20VP%20of%20Worldwide%20Sales
This curl example sends a PUT request to iHub to modify the home folder and description of the user with the user ID 100100000100 in the default volume:
curl -i http://%RESTHost%:5000/ihub/v1/users/100100000100 ‑X PUT ‑H "AuthId:%RESTAuthId%" ‑d description="Senior VP of Worldwide Sales"
DELETE users/{userId}
This example deletes the user with user ID 200000000100:
DELETE /ihub/v1/users/200000000100 HTTP/1.1
Host: myserver.mycompanyname.com:5000
Content-Type: application/json; charset=utf-8
AuthId: <authId>
This curl example sends a DELETE request to iHub to delete the user with user ID 200100000100 in the default volume: