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

Getting Account Properties by Account ID

This section explains how to get a list with properties for the specified user.

Request

GET https://<hostname>/api/v1/users/{id}

Request Headers

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

Request Parameters

The following parameters must be posted as URL.

Parameter

Description

id

The identification number of the user. Can be obtained as described in Getting Users.

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

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/1000

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

  "id": 1000,

  "name": "cpm",

  "description": "Ubuntu",

  "mfaEnabled": false,

  "isDefault": true,

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

}

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.