Get User

You can get a resource representation of a user with the specified ID.

Required Privileges

To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator, Company Owner, Company Administrator.

Request

To get a user with the specified UID, send the GET HTTP request to the URL of the /users/{userUid} resource.

HTTP Request

GET https://<hostname>:1280/api/v3/users/{userUid}

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.

Accept

Optional

application/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.

Request parameters

A list of parameters that are applicable for this operation:

Name

In

Type

Required

Default

Constraints

Description

userUid

Path

String (uuid)

Yes

User UID

Response

The server returns the following response to the client.

Response Code

A successfully completed operation returns 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

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the request body message: application/json; charset=utf-8

Response Body

In the response body, Veeam Service Provider Console returns a resource representation based on the User schema.

Example Get User

The following request returns a representation of a user with UID c33e4f5b-82f7-4e1a-b36b-68c7d135c8eb.

Request:

GET https://localhost:1280/api/v3/users/c33e4f5b-82f7-4e1a-b36b-68c7d135c8eb

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response Code:

200 OK

 

Response Body:

{

 "data": {

   "instanceUid": "c3728f5b-82f7-4e1a-b36b-68c7d135c8eb",

   "organizationUid": "e554ad57-2297-4597-8fe8-12382be853ff",

   "userName": "Alpha",

   "status": "enabled",

   "role": "companyOwner",

   "profile": {

     "firstName": null,

     "lastName": null,

     "title": "mr",

     "email": null,

     "address": null,

     "phone": null

   },

   "credentials": {

     "userName": "Alpha",

     "password": null

   }

 }

}

I want to report a typo

There is a misspelling right here:

 

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