Changing the user group settings

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 sets a user group ID and a role of the specified user group.
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

PATCH base-URL/v1/objects/user-groups/object-ID

Request message

Object ID

Set the userGroupObjectId value obtained by getting the information about the user group.

Attribute

Type

Description

userGroupObjectId

string

(Required) The object ID for a user group ID

The object ID is case sensitive.

Query parameters

None.

Body

The following coding example shows how to change the user group ID:

{
  "userGroupId":"adminGroup"
}

The following coding example shows how to change a role:

{
  "roleNames":[
    "Storage Administrator (Provisioning)",
    "Storage Administrator (Local Copy)"  
  ]
}

Only one attribute can be specified in one request.

Attribute

Type

Description

userGroupId

string

(Optional) The user group ID

Specify an ID consisting of 1 to 64 characters.

hasAllResourceGroup

boolean

(Optional) 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.

roleNames

string[]

(Optional) 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.

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 user group on which settings are changed

Action template

None.

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 PATCH https://192.0.2.100/ConfigurationManager/v1/objects/user-groups/devGroup