UserResource

The following resources are applicable:

/users

Mount Point: /api/rest/users

POST

Creates a new user.
This method requires admin privileges.

Status codes:

Request Body

element: users
media types: application/xml
application/json

the user to be created

Response Body

element: (custom)
media types: */*
application/xml

(no documentation provided)

GET

Returns all users.
This method requires admin privileges.

Status codes:

Parameters

name description type default
start the start value for paging query 0
limit the limit value for paging query -1
sortby sort parameter query
desc sort direction desc or aesc query false

Response Body

element: (custom)
media types: application/xml
application/json

(no documentation provided)

/users/{id}

Mount Point: /api/rest/users/{id}

The following operations are supported on this resource:

DELETE

Deletes a user.
This method requires admin privileges.

Status codes:

Parameters

name description type default
id the name of the user to delete. path

Response Body

element: (custom)
media types: */*
application/xml

(no documentation provided)

PUT

Modifies the given user.
This method requires admin privileges.

Status codes:

Parameters

name description type default
id name of the user to be modified path

Request Body

element: users
media types: application/xml
application/json

user object to modify

Response Body

element: (custom)
media types: */*
application/xml

(no documentation provided)

GET

Returns a user.
This method requires admin privileges.

Status codes:

Parameters

name description type default
id the id/name of the user path

Response Body

element: users
media types: application/xml
application/json

the User with the specified id