Creating a user group

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 group and assigns an appropriate role and resource groups.
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/user-groups

Request message

Object ID

None.

Query parameters

None.

Body
{
  "userGroupId":"devGroup",
  "roleNames":[
    "Storage Administrator (Provisioning)"
  ],
  "resourceGroupIds": [
    8,
    9
  ],
  "hasAllResourceGroup":false
}

Attribute

Type

Description

userGroupId

string

(Required) The user group ID

Specify an ID consisting of 1 to 64 characters.

roleNames

string[]

(Required) The role name

Specify one or more of the following role names. The role names are case sensitive. If you specify multiple role names, delimit the names by commas.

You must specify Storage Administrator (View Only).

  • Audit Log Administrator (View & Modify)#

  • Audit Log Administrator (View Only)#

  • Security Administrator (View & Modify)#

  • Security Administrator (View Only)#

  • Storage Administrator (Initial Configuration)

  • Storage Administrator (Local Copy)

  • Storage Administrator (Performance Management)

  • Storage Administrator (Provisioning)

  • Storage Administrator (Remote Copy)

  • Storage Administrator (System Resource Management)

  • Storage Administrator (View Only)

  • Support Personnel#

  • User Maintenance#

#: If you specify this role, be sure to specify true for hasAllResourceGroup.

resourceGroupIds

int[]

(Optional) The resource group IDs

Specify one or more decimal (base 10) numbers within the range of 0 to 1023. If you specify multiple IDs, delimit the IDs by commas. This cannot be specified if the hasAllResourceGroup attribute is true.

hasAllResourceGroup

boolean

(Required) Information about whether all the resource groups are assigned to the target.

If the roles specified for roleNames include any of the following roles, be sure to specify true for this attribute.

  • Audit Log Administrator (View & Modify)

  • Audit Log Administrator (View Only)

  • Security Administrator (View & Modify)

  • Security Administrator (View Only)

  • Support Personnel

  • User Maintenance

If the roles specified for roleNames does not include any of these roles, be sure to specify false for this attribute.

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 group

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/user-groups