Creating a user account

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
The following request creates a user account and assigns the user to user groups where appropriate permissions are specified. User accounts created by using the REST API can be used in Hitachi Device Manager - Storage Navigator.
Note:

If you locked any resources of the target storage system by using the REST API, you will not be able to use this API function. In such cases, unlock the resources before running the API function.

Execution permission

Security Administrator (View & Modify)

Request line

POST base-URL/v1/objects/users

Request message

Object ID

None.

Query parameters

None.

Body
{
  "userId": "devUser",
  "authentication": "local",
  "userPassword":"devPassword",
  "userGroupNames": [
    "Audit Log Administrator (View Only) User Group",
    "Storage Administrator (View & Modify) User Group"
  ]
}

Attribute

Type

Description

userId

string

(Required) User ID

For details about the number of characters that can be specified for user IDs and the characters that can be used, see the description about input rules for user IDs and passwords.

userPassword

string

(Optional) Password

The password cannot be specified if the authentication attribute is external.

For details about the number of characters that can be specified for passwords and the characters that can be used, see the description about input rules for user IDs and passwords.

userGroupNames

string[]

(Required) User group name

Specify a name consisting of 1 to 64 characters. You can specify up to 8 group names.

authentication

string

(Required) Set authentication

  • local: Authorized by the storage system

  • external: Authorized by the external authentication server

Response message

Body

A job object is returned. For details on attributes other than affectedResources, see the section explaining job objects.

Attribute

Description

affectedResources

URL of the created user

Status codes

For details on the status codes of the request for this operation, see the description on HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/users/