HP OneView REST API Reference

users
users.html[10/17/2013 10:35:59 AM]
REST API Response Codes
Examples
Example :
Gets all the users with the specified role name from the appliance
GET https://{appl}/rest/users/roles/users/{role}
Response Body:
{
"type": "UserNameDtoCollection",
"members": [
{
"userName": "administrator"
},
{
"userName": "paul"
},
{
"userName": "ralph"
},
{
"userName": "april"
}
],
"count": 4,
"total": 4,
"start": 0,
"prevPageUri": null,
"nextPageUri": null,
"uri": "/rest/users/roles/users/Infrastructure administrator",
"category": "users",
"created": "2013-08-06T10:18:52.485Z",
"eTag": null,
"modified": "2013-08-06T10:18:52.486Z"
}
URI: /rest/users/validateLoginName/{userName}
Method API
POST Validates if a user with the given full name exists in the appliance
Parameter Attributes Description
view Optional Return a specific subset of the attributes of the resource or collection
by specifying the name of a predefined view. The default view is
expand (show all attributes of the resource, and all elements of
collections or resources).
fields Optional
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