HP OneView REST API Reference

users
users.html[10/17/2013 10:35:59 AM]
fields Optional
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
RoleNameListV2 List of the role names for the given user
Response Codes
REST API Response Codes
Examples
Example :
Gets all the roles for the specified local user from the appliance
GET https://{appl}/rest/users/role/{userName}
Response Body:
{
"type": "RoleNameDtoCollection",
"members": [
{
"roleName": "Infrastructure administrator"
}
],
"count": 1,
"total": 1,
"start": 0,
"prevPageUri": null,
"nextPageUri": null,
"uri": "/rest/users/role/administrator",
"category": "users",
"created": "2013-08-06T10:15:15.452Z",
"eTag": null,
"modified": "2013-08-06T10:15:15.452Z"
}
URI: /rest/users/roles
Method API
DELETE Removes a given set of roles from the user.
Parameter Attributes Description