Get a user group by ID

URL path parameters (required)

groupId (type: int )

Request body

None

Content-Type

application/xml

Response body

XML text with root element userGroup and the following XML schema:

<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>

JAXB type

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

URL

http://localhost:8080/rest/v1/users/group/2

Response body

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<userGroup xmlns="http://www.cloudcruiser.com/webservices/v1/User" id="2">

  <groupName>admin</groupName>

  <title>Administration Group</title>

  <accountStructure name="Default" groupDefault="true" id="0"/>

  <accountStructure name="Business Unit View" groupDefault="false" id="1"/>

  <accountStructure name="Division View" groupDefault="false" id="2"/>

  <accountStructure name="Department View" groupDefault="false" id="3"/>

  <allowAllAccounts>true</allowAllAccounts>

  <user name="admin" id="2" enabled="true"/>

  <user name="manager" id="25" enabled="true"/>

</userGroup>

Java

UserGroup userGroup = userServiceProxy.getUserGroupById(2);