HP OneView REST API Reference

users
users.html[10/17/2013 10:35:59 AM]
Updated: October 16, 2013 4:21
MDT
API Specifications Create Read Update Delete
/rest/users POST GET PUT DELETE
/rest/users/administrator/resetPassword PUT
/rest/users/changePassword POST
/rest/users/role/{userName} GET
/rest/users/roles DELETE
/rest/users/roles/users/{role} GET
/rest/users/validateLoginName/{userName} POST
/rest/users/validateUserName/{fullName} POST
/rest/users/{userName} GET DELETE
/rest/users/{userName}/roles POST PUT
Resource Model
ResetPassword
RoleAssign
RoleNameV2
RoleNameListV2
RoleUnAssign
UserAdd
UserV2
UserListV2
UserModify
UserNameList
UserPassword
UserRolesV2
VerifyPassword
UserAddV2
HP OneView REST API Reference
users
The users resource provides REST APIs to configure user settings in the appliance. Supports the following operations: 1)
User with administrative privileges modifying password and contact information of another existing user 2) User performing
self edit and modifying password or contact information 3) Add roles and bulk replace of roles 4) Assigning and un-assign
(deleting) roles to users 5) Removing local user(s) from appliance 6) Changing administrator password during first time
setup of appliance 7) Resetting administrator password 8) Retrieve role information of users. X-API-Version in the HTTP
header should be atleast 2.
URI: /rest/users
Method API
POST Adds a new user to the appliance. The caller of this operation requires {users, create}
permissions. The user name is validated to avoid creating duplicate names in the appliance. The
password is validated if it meets the requirements. Password should not contain any of < > ; , \" '
& \\/ | + : = and space.
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"
Request
Body
Attributes Description