Modify Reseller Permissions

You can modify set of the Veeam Service Provider Console components that a reseller with the specified UID can access.

Required Privileges

To perform this task, a user must have the Portal Administrator role assigned.

Request

To modify reseller permissions, send the PATCH HTTP request to the URL of the /organizations/resellers/{resellerUid}/permissions collection.

HTTP Request

PATCH https://<hostname>:1280/api/v3/organizations/resellers/{resellerUid}/permissions

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

resellerUid

Path

String (uuid)

Yes

Reseller UID

Body

Body

Array (JSON Patch)

Yes

Array of JSON Patch operations according to RFC 6902

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 modified resource representation based on the ResellerPermissions schema.

Example Modify Reseller Permissions

The following request allows a reseller with UID debcdb55-afbd-4772-bf99-5ea6a3249f43 to access Veeam Service Provider Console RESTful API.

Request:

PATCH https://localhost:1280/api/v3/organizations/resellers/debcdb55-afbd-4772-bf99-5ea6a3249f43/permissions

 

Request Header:

Content-type: application/json

Authorization: Bearer <Access-Token>

 

Request Body:

[

 {

   "op": "add",

   "value": "rest",

   "path": "-"

 }

]

 

Response Code:

200 OK

Response Body:

{

 "data": [

   "rest"

 ]

}

I want to report a typo

There is a misspelling right here:

 

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