HP OneView REST API Reference

users
users.html[10/17/2013 10:35:59 AM]
force Optional If set to true, the operation completes even if there are network
connectivity issues or resource errors. The default is false.
query Experimental This parameter is experimental for this release: While generally
functional when used in simple cases, restrictions might be noted in
the implementation description.
If the query is supported, the following is the way it works. A general
query string that narrows the list of resources returned by a multi-
resource GET (read) request and DELETE (delete) request. The
default is no query (all resources are returned). One advantage
query has over filter is that it can have embedded ORs. A
single query parameter can do what would take multiple
parameters or multiple GET requests using filter. Use query for
more complex queries.
filter Experimental This parameter is experimental for this release: While generally
functional when used in simple cases, restrictions might be noted in
the implementation description.
A general filter/query string that narrows the list of resources
returned by a multi-resource GET (read) request and DELETE
(delete) request. The default is no filter (all resources are returned).
Request
Header
Attributes Description
REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the
current release, this must be set to "X-API-Version:3"
Response Description
void
Response Codes
REST API Response Codes
Examples
DELETE https://{appl}/rest/users/roles
Example :
Deletes the roles for testUser
https://{appl}/rest/users/roles?
filter="userName='testUser'"&filter="roleName='Read only'"
URI: /rest/users/roles/users/{role}
Method API
GET Gets all the users with the specified role name from the appliance
Parameter Attributes Description
start Optional The 0-based index of the first resource to return (start=0 starts
with the first available resource). If the specified count does not
return all resources within the maximum allowed time (see count),
start