This is an archive version of the document. To get the most up-to-date information, see the current version.

Getting Accounts

This section explains how to get a list of users configured.

Request

GET https://<hostname>/api/v1/users

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

None.

Request Body

None.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 (OK).

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

Header	Description
Content-length	The length of the response body.
Content-type	The media type and syntax of the response body message: application/json; charset=utf-8

Response Body

Property	Type	Description
offset	integer	Shows the offset value.
limit	integer	Shows the offset limit.
totalCount	integer	Shows the number of records in the results array.
results	Results Object	Contains the result object.
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property).

Results Object

Property	Type	Description
id	string	Shows the identification number of the user record.
name	string	Shows the name of the user.
description	string	Shows the description.
mfaEnabled	boolean	Shows if MFA is enabled for the user.
isDefault	boolean	Shows if the user is the default one.
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property).

Example

Request:

GET https://abc.ukwest.cloudapp.azure.com/api/v1/users

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"offset": 0,

"limit": 30,

"totalCount": 2,

"results": [

{

"id": 1000,

"name": "cpm",

"description": "Ubuntu",

"mfaEnabled": false,

"isDefault": true,

"_links": {"self": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/users/1000"}}

{

"id": 1001,

"name": "Authentication",

"description": "",

"mfaEnabled": false,

"isDefault": false,

"_links": {"self": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/users/1001"}}

}

"_links": {"self": {"href": "https://abc.ukwest.cloudapp.azure.com:443/api/v1/users?offset=0&limit=30"}}

}