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 > Get all users

Get all users

Retrieves the IDs and names of all (or a specified count of) user groups and their containing users stored in your Cloud Cruiser system.

URL syntax

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

HTTP method

GET

Request

URL query parameters (optional)
?startFrom=<x
>&count=<y
>

Default: startFrom=0&count=-1

Request body

None

Response

Content-Type
application/xml
Response body

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

<xs:element name="users" xmlns:tns="http://www.cloudcruiser.com/webservices/v1/User">
  <xs:complexType>
    <xs:sequence>
      <xs:element maxOccurs="unbounded" minOccurs="0" name="userGroup">
        <xs:complexType>
          <xs:sequence>
            <xs:element maxOccurs="unbounded" minOccurs="0" name="user"    type="tns:UserItem"/>
          </xs:sequence>
          <xs:attribute name="name" type="xs:string"/>
          <xs:attribute name="id" type="xs:int"/>
          <xs:attribute name="totalUsers" type="xs:int"/>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
    <xs:attribute name="totalGroups" type="xs:int"/>
    <xs:attribute name="retrievedGroups" type="xs:int"/>
    <xs:attribute name="startFrom" 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.Users

Example

URL
http://localhost:8080/rest/v1/users?startFrom=5&count=2
Response body
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<users xmlns="http://www.cloudcruiser.com/webservices/v1/User" totalGroups="37" retrievedGroups="2" startFrom="5">
  <userGroup name="buCgroup" id="7" totalUsers="2">
    <user name="buCuser" id="6"/>
    <user name="buCanalyst" id="28"/>
  </userGroup>
  <userGroup name="buDgroup" id="8" totalUsers="1">
    <user name="buDuser" id="7"/>
  </userGroup>
</users>
Java
Users users = userServiceProxy.getAllUsers();
Last modified

Tags

This page has no custom tags.

Classifications

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