Cloud Enterprise Object Storage REST API

Search (SHIFT+S)




Modified since last release

Create Local User Info

POST /vdc/users

Creates local users for the VDC. These users can be assigned to VDC-wide management roles and are not associated with a namespace. User account can be assigned to the System Admin role by setting the isSystemAdmin flag in the request payload.


Required Roles

  • SECURITY_ADMIN


Prerequisites

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

  • User should exist


Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
mgmt_user_info_create
userId Management user id String
password Password for the management user String
isSystemAdmin If set to true, assigns the management user to the System Admin role Boolean
isSystemMonitor If set to true, assigns the management user to the System Monitor role Boolean
isSecurityAdmin If set to true, assigns the management user to the Security Admin role Boolean
is_external_group If set to true, its a domain. Boolean

Response Body

Newly created management user information.

Field Description Type Notes
mgmt_user_info
userId User Id String
isSystemAdmin Flag indicating whether management user is System Admin Boolean
isSystemMonitor Flag indicating whether management user is System Monitor Boolean
isSecurityAdmin Flag indicating whether management user is Security Admin Boolean
is_external_group If set to true, its a domain. Boolean
is_locked If set to true, the user is locked. Boolean
last_time_password_changed Value of last time password changed String

Examples

Request
POST https://192.168.0.0:4443/vdc/users HTTP/1.1

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

<mgmt_user_info_create>
   <userId>sampleuser</userId>
   <password>password</password>
   <isSystemAdmin>true</isSystemAdmin>
   <isSystemMonitor>false</isSystemMonitor>
   <isSecurityAdmin>false</isSecurityAdmin>
</mgmt_user_info_create>
Response
HTTP/1.1 200 OK 
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<mgmt_user_info>
    <isSystemAdmin>true</isSystemAdmin>
    <isSystemMonitor>false</isSystemMonitor>
    <isSecurityAdmin>false</isSecurityAdmin>
    <userId>sampleuser</userId>
</mgmt_user_info>