UserResource
The following resources are part of this group:
/users/{user}
The following operations are supported on this resource:
GET
Return a specific user.
Successful Response Content
HTTP Status code: OK - 200
Failure Response Content
HTTP Status code: error status code
Parameters
name | description | type | default |
---|---|---|---|
user | user to retrieve | path |
Response Body
element: | (custom) |
Return a specific user or a fault document.
DELETE
Deletes a specific user.
Successful Response Content: No Content
HTTP Status code: No Content - 204
Failure Response Content
HTTP Status code: error status code
Parameters
name | description | type | default |
---|---|---|---|
user | user to delete | path | |
backup | flag to indicate if the files should be backed up | query | true |
Response Body
element: | (custom) |
Return no content or a fault document.
POST
Update an existing user.
Successful Response Content
HTTP Status code: OK - 200
Failure Response Content
HTTP Status code: error status code
Parameters
name | description | type | default |
---|---|---|---|
user | user to update | path |
Request Body
element: | user |
Exiting user to update
Response Body
element: | (custom) |
Updated user or a fault document.