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

Get Current User Data

You can get data on a current Veeam Backup for Microsoft Azure user.

Request

To retrieve information on a specific user, send the HTTP GET request to the /userProfile/currentUser endpoint.

HTTP Request

GET https://<hostname>/api/v3/userProfile/currentUser

Request Headers

The request contains the following headers.

Header

Required

Value

Description

Authorization

Required

Bearer <Access-Token>

Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.

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 HTTP headers.

Header

Value

Description

Content-length

integer

Identifies the length of the response body message, in bytes.

Content-type

  • application/json
  • application/problem+json

Identifies the media type of the response body message.

Response Body

In the response body, Veeam Backup for Microsoft Azure returns a representation of the current user.

Property

Type

Description

id

string

System ID assigned to a user in the Veeam Backup for Microsoft Azure REST API.

name

string

User name.

description

string

Description of the user.

mfaEnabled

boolean

Defines whether MFA is enabled for the user.

role

string

Role assigned to a user.

type

array[string]

Type of the user: Internal, External.

_links

array

A list of methods and operations available for the user in the Veeam Backup for Microsoft Azure REST API, and request URLs used to perform the operations.

Get Current User DataExample

The following request returns information on a current Veeam Backup for Microsoft Azure user.

Request:

GET https://51.11.247.127/api/v3/userProfile/currentUser

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "id": "18c25b33-117c-4f67-8926-d8737480733e",

 "name": "tomas.anders",

 "description": "Dept-03",

 "mfaEnabled": false,

 "role": "PortalAdmin",

 "type": "Internal"

}