Removing users from user groups

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
To remove a user from a user group, specify the user group that is associated with that user, and then release that user group from the user object. If only one user group is associated with a particular user, the user cannot be removed from that 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

POST base-URL/v1/objects/users/object-ID/actions/remove-user-group/invoke

Request message

Object ID

Specify the userObjectId value obtained by getting information about the user.

Attribute

Type

Description

userObjectId

string

(Required) Object ID of the user ID

The name is case sensitive.

Query parameters

None.

Body
{
  "parameters": {
    "userGroupNames": [
      "System User Group"
    ]
  }
}

Attribute

Type

Description

userGroupNames

string[]

(Required) User group name

Specify a name consisting of 1 to 64 characters.

One user can belong to a maximum of You can specify up to 8 user groups.

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 who was removed from the user group

Action template

GET base-URL/v1/objects/users/object-ID/actions/remove-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

To get an action template:

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/users/devUser/actions/remove-user-group

To run the request after getting an action template:

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