User (Management):Modify Local User Info

Search (SHIFT+S)

ECS Management API

ECS Object Service API

ECS API Changes

Modified since last release

Modify Local User Info

PUT /vdc/users/{userid}

Updates user details for the specified local management user.

userid	User identifier for which local user information needs to be updated.

Required Roles

SECURITY_ADMIN

Prerequisites

The following conditions must be met in order to call this operation.

User should exist

Request Payload

<mgmt_user_info_update>
   <password></password>
   <isSystemAdmin></isSystemAdmin>
   <isSystemMonitor></isSystemMonitor>
   <isSecurityAdmin></isSecurityAdmin>
</mgmt_user_info_update>

{
  "password": "",
  "isSystemAdmin": "",
  "isSystemMonitor": "",
  "isSecurityAdmin": ""
}

All parameters are required unless otherwise stated.

Field	Description	Type	Notes
mgmt_user_info_update
password	Password for the management user	String
isSystemAdmin	Assigns or removes management user to /from System Admin role.	Boolean
isSystemMonitor	Assigns or removes management user to /from System Monitor role.	Boolean
isSecurityAdmin	Assigns or removes management user to/from Security Admin role.	Boolean

Response Body

Response indicating Success or Failure to update local user information

Examples

Request

PUT https://192.168.0.0:4443/vdc/users/SampleUser:

Content-Type: application/xml
X-SDS-AUTH-TOKEN=BAAcRGtUUmNOZHNpbitMaEVhZUhhdWtad1J3WDRRPQMAUAQADTEzNzk1NDIwMjQ4MzACAAEABQA5dXJuOnN0b3JhZ2VvczpUb2tlbjoxYmVhNGJiMy04M2MwLTRlOGItODc4Ni1iYWYxYmM4NTZkNTY6AgAC0A8=

<mgmt_user_info_update>
   <password>password</password>
   <isSystemAdmin>true</isSystemAdmin>
   <isSystemMonitor>false</isSystemMonitor>
   <isSecurityAdmin>false</isSecurityAdmin>
</mgmt_user_info_update>

Response

HTTP/1.1 200 OK
Content-Type: application/xml

Request

PUT  https://192.168.0.0:4443/vdc/users/SampleUser.json HTTP/1.1

Content-Type: application/json
X-SDS-AUTH-TOKEN=BAAcRGtUUmNOZHNpbitMaEVhZUhhdWtad1J3WDRRPQMAUAQADTEzNzk1NDIwMjQ4MzACAAEABQA5dXJuOnN0b3JhZ2VvczpUb2tlbjoxYmVhNGJiMy04M2MwLTRlOGItODc4Ni1iYWYxYmM4NTZkNTY6AgAC0A8=

{
  "mgmt_user_info_update": {
    "password": "password",
    "isSystemAdmin": "true",
    "isSystemMonitor": "false",
    "isSecurityAdmin": "false"
  }
}

Response

HTTP/1.1 200 OK
Content-Type: application/json