Create User

You can create a new user with specific properties.

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 create a user, send the POST HTTP request to the URL of the /users resource.

HTTP Request

POST https://<hostname>:1280/api/v3/users

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.

Content-Type

Required

application/json

Identifies a media type that is used in the body of the request.

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

Description

Body

Body

UserInput

Yes

User properties

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 the None value if a resource is created successfully.

Example Create User

The following request creates a new user

Request:

POST https://localhost:1280/api/v3/users

 

Request Headers:

Content-type: application/json

Authorization: Bearer <Access-Token>

 

Request Body:

{

 "organizationUid": "79817d6d-4b00-4e22-b673-8758f02fa0ef",

 "role": "PortalOperator",

 "profile": {

   "firstName": "Stan",

   "lastName": "Smith",

   "title": "Mr",

   "status": "Enabled",

   "email": "s.smith@alpha.com",

   "address": null,

   "phone": null

 },

 "credentials": {

   "userName": "s.smith",

   "password": "Password1"

 },

 "backupResource": null

}

 

Response Code:

200 OK

 

Response Body:

{

 "meta": {

   "pagingInfo": {

     "total": 0,

     "count": 0,

     "offset": 0

   }

 },

 "data": "None",

 "errors": [

   {

     "message": "string",

     "type": "unspecified",

     "code": 0

   }

 ]

}

 

I want to report a typo

There is a misspelling right here:

 

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