Cloud Cruiser became HPE Consumption Analytics on Nov. 1st. You'll still see the old name in places while we update this site.

 

 

Consumption Analytics Documentation

Home > Cloud Cruiser 3 > REST API reference > Users and user groups > Update a user group

Update a user group

Updates information of an existing user group.

URL syntax

http://<ccServerURL
>/rest/v1/users/group/<groupId
>

HTTP method

PUT

Request

URL path parameters (required)

groupId (type: int )

Content-Type
application/xml
Request body

The user group detailed information with any modification, expressed as XML text with root element userGroup and the following XML schema. The value of the userGroup ’s id attribute must match the groupId in the URL path.

<xs:element name="userGroup" xmlns:tns="http://www.cloudcruiser.com/webservices/v1/User">
  <xs:complexType>
    <xs:sequence>
      <xs:element name="groupName" type="xs:string"/>
      <xs:element minOccurs="0" name="title" type="xs:string"/>
      <xs:element maxOccurs="unbounded" name="accountStructure" type="tns:AccountStructure"/>
      <xs:element default="true" name="allowAllAccounts" type="xs:boolean"/>
      <xs:element maxOccurs="unbounded" minOccurs="0" name="allowedAccountId" type="xs:string"/>
      <xs:element maxOccurs="unbounded" minOccurs="0" name="user" type="tns:UserItem"/>
    </xs:sequence>
    <xs:attribute name="id" type="xs:int"/>
  </xs:complexType>
</xs:element>
 
<xs:complexType name="UserItem">
  <xs:sequence/>
  <xs:attribute name="name" type="xs:string"/>
  <xs:attribute name="id" type="xs:int"/>
  <xs:attribute name="enabled" type="xs:boolean"/>
</xs:complexType>

Response

Content-Type
application/xml
Response body

The updated user group information, expressed as XML text with root element userGroup and the same XML schema as the request body.

JAXB type
com.cloudcruiser.server.webservices.v1.dto.user.UserGroup

Example

URL
http://localhost:8080/rest/v1/users/group/10600
Request body
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<userGroup xmlns="http://www.cloudcruiser.com/webservices/v1/User" id="10600">
  <groupName>testGroup-2</groupName>
  <accountStructure name="Default" groupDefault="true" id="0"/>
  <allowAllAccounts>false</allowAllAccounts>
  <allowedAccountId>B-AA-LLLL</allowedAccountId>
</userGroup>
Response body
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<userGroup xmlns="http://www.cloudcruiser.com/webservices/v1/User" id="10600">
  <groupName>testGroup-2</groupName>
  <accountStructure name="Default" groupDefault="true" id="0"/>
  <allowAllAccounts>false</allowAllAccounts>
  <allowedAccountId>B-AA-LLLL</allowedAccountId>
  <user name="test-user-1" id="10000" enabled="true"/>
  <user name="t-admin-1" id="10300" enabled="true"/>
</userGroup>
Java
UserGroup updatedUserGroup = userServiceProxy.updateUserGroup(10600, userGroup);
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
© Copyright 2018 Hewlett Packard Enterprise Development LP