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

Get User Data

You can get data on a Veeam Backup for AWS user with the specified ID.

Request

To retrieve information on a specific user, send the HTTP GET request to the /users/{userId} endpoint. {userId} is a user name of the Veeam Backup for AWS user.

HTTP Request

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

Request Headers

The request contains the following headers.

Header

Required/Optional

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.

x-api-version

Required

1.0-rev0

Specifies the current revision of the Veeam Backup for AWS REST API.

Accept

Optional

  • application/json
  • application/problem+json

Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type.

Response

The server returns the following response to the client.

Response Code

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 AWS returns a representation of the user with the specified ID. The User schema is used for the resource representation.

Get User DataExample

The following request returns information on a Veeam Backup for AWS user with the user ID sara_baker.

Request:

GET https://135.169.170.192:11005/api/v1/users/sara_baker

 

Request Header:

Authorization: Bearer <Access-Token>

x-api-version: 1.0-rev0

 

Response:

200

 

Response Body:

{

"name": "sara_baker",

"description": "Dept-01 user",

"mfaEnabled": true,

"isDefault": false,

"_links": [

    {

      "method": "GET",

      "rel": "self",

      "href": "https://135.169.170.192:11005/api/v1/users/sara_baker"

    },

    {

      "method": "PUT",

      "rel": "update",

      "href": "https://135.169.170.192:11005/api/v1/users/sara_baker"

    },

    {

      "method": "DELETE",

      "rel": "delete",

      "href": "https://135.169.170.192:11005/api/v1/users/sara_baker"

    },

    {

      "method": "POST",

      "rel": "DisableMfa",

      "href": "https://135.169.170.192:11005/api/v1/users/sara_baker/disableMfa"

    }

  ]

}