Home > Cloud Cruiser 3 > REST API reference > Users and user groups > Get a user group by name

Get a user group by name

Retrieves the detailed information of the user group specified by its name.

URL syntax

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

HTTP method

GET

Request

URL path parameters (required)

groupName (type: string )

Request body

None

Response

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

Example

URL
http://localhost:8080/rest/v1/users/group/name/admin
Java

UserGroup userGroup = userServiceProxy.getUserGroupByName("admin");
Last modified

Tags

This page has no custom tags.

Classifications

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