EMC ViPR REST API

Search (SHIFT+S)

API Reference


Update User Group

PUT /vdc/admin/user-groups/{id}

Updates user group. The submitted user group element values will be validated.

The minimal set of parameters include: name, domain, attributes (key and values pair).

id

Required Roles

  • SECURITY_ADMIN

Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<update_user_group>
<add_attributes>
<attribute>     0-* Elements
<key> String
<values>
<value> String 0-* Elements
</values>
</attribute>      
</add_attributes>
<remove_attributes>
<key> String 0-* Elements
</remove_attributes>
<domain> String
<label> String
</update_user_group>

Response Body

The updated User Group details as UserGroupRestRep

Field Description Type Notes
<user_group>
<domain> String
<attributes>
<attribute>     0-* Elements
<key> String
<values>
<value> String 0-* Elements
</values>
</attribute>      
</attributes>
<name> The name assigned to this resource in ViPR. The resource name is set by a user and can be changed at any time. It is not a unique identifier. String
<id> An identifier that is generated by ViPR when the resource is created. The resource ID is guaranteed to be unique and immutable across all virtual data centers for all time. URI
<link> A hyperlink to the details for this resource
<creation_time> A timestamp that shows when this resource was created in ViPR DateTime
<tags> Keywords and labels that can be added by a user to a resource to make it easy to find when doing a search.
<tag> String 0-* Elements
</tags>
<inactive> Whether or not the resource is inactive. When a user removes a resource, the resource is put in this state before it is removed from the ViPR database. Boolean
<global> Boolean
<remote> Boolean
<vdc>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</vdc>      
<internal> Whether or not the resource is an internal resource. Boolean
</user_group>