List Users

 

Applies To: Windows Azure Pack

Retrieves a set of users that match a query.

Replace <ServiceMgmt> with your Service Management API endpoint address.

Method

Request URI

HTTP version

GET

https://<ServiceMgmt>:30004/users

HTTP/1.1

The following table describes required and optional request headers.

Request Header

Description

Authorization: Bearer

Required. Authorization bearer token.

x-ms-principal-id

Required. The principal identifier.

x-ms-client-request-id:

Optional. The client request identifier.

x-ms-client-session-id:

Optional. The client session identifier.

x-ms-principal-liveid:

Optional. The principal Live identifier.

The response includes an HTTP status code, a set of response headers, and a response body.

A successful operation returns status code 200 (OK). Returns 404 if the URI parameters are incorrect.

For information about status codes, see Status and Error Codes (Windows Azure Pack Service Management).

The response for this operation includes standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

The following table describes the elements of the response body.

Element name

Description

items

The list of users.

filteredTotalCount

The total number of returned items, before paging is applied and after filtering is applied.

totalCount

The total number of returned items before paging and filtering is applied.

The following code is an example of a List Users request.

{
  "items": [
    {
      "Name": "bestuser@hotmail.com",
      "Email": "bestuser@hotmail.com",
      "State": 1,
      "CreatedTime": "2013-06-25T22:05:04.007",
      "SubscriptionCount": 1,
      "ActivationSyncState": 0,
      "LastErrorMessage": null
    }

  ],
  "filteredTotalCount": 1,
  "totalCount": 1
}
Show: