3.13.5.1.1 GET

Retrieves a list of users that have been created on the AD DS server.

This operation is transported by an HTTP GET.

The operation can be invoked through the following URI:

 https://<ServerName>/services/builtin/UserManagement.svc/users/index/{startingindex}/count/{amount}

The request message for this operation contains the following HTTP headers.

Request header

Usage

Value

Canary

Optional

The user token. Client MUST either pass this header to the server or pass all of the following headers to the server.  For more details, refer to section 2.2.2.5.

Authorization

Optional

The caller's credential is encoded text that is based on user name and password. For more details, refer to section 2.2.2.4.

AppName

Optional

The client application name. For more details, refer to section 2.2.2.1.

AppVersion

Optional

The client application version. For more details, refer to section 2.2.2.3.

AppPublisherName

Optional

The client application publisher name. For more details, refer to section 2.2.2.2.

The response message for this operation can result in the following status codes.

Status code

Description

200

Operation successfully completed.

400

One or more parameters are not valid.

401

Access to the requested resource is denied. This API only supports Administrator calls.

For more detail on the UserInfo type, please see section 2.2.4.71.