Help Center
Choose product document...
Veeam Backup for Microsoft Office 365 3.0
RESTful API Reference

(PUT) /Organizations/{id}

Edits settings of an organization with a specified ID.

Request

To edit organization settings, send the GET HTTPS request to the URL of the /Organizations/{id} resource:

HTTPS Request

PUT https://<Backup-Office365>:4443/v3/Organizations/{id}

Request Headers

The request header must contain the authorization token for the current logon session.

Request Body

To edit the settings of the organization, you need to enter in the request body the corresponding properties with new values.

The request body can contain different properties depending on the organization type:

Mind that the Username and Password properties are mandatory.

Microsoft Office 365

To modify the Microsoft Office 365 organization settings, specify the following properties:

Property

Type

Description

Type

string

Specifies the organization type:

  • Office365
  • OnPremises
  • Hybrid

For example, "type": "office365".

Region

string

Specifies Microsoft Azure region where Microsoft Office 365 organization datacenter is located:

  • Worldwide
  • USgovCommunity
  • Germany
  • China
  • USgovDefence

For example, "region": "worldwide".

IsExchangeOnline

bool

If set to True, indicates that this organization contains Microsoft Office 365 Exchange components.

For example, "isExchangeOnline": "true".

IsSharePointOnline

bool

If set to True, indicates that this organization contains Microsoft Office 365 SharePoint components.

For example, "isSharePointOnline": "true".

ExchangeOnlineSettings

OnlineSettings

Specifies Microsoft Office 365 Exchange organization connection settings.

SharePointOnlineSettings

OnlineSettings

Specifies Microsoft Office 365 SharePoint organization connection settings.

Id

string

Specifies the ID of the organization.

For example, "id": "7b2b1ae1-7bbb-4651-b479-bda7edc7838b".

Name

string

Specifies the name of the Office 365 organization.

For example, "name": "eastsupport.onmicrosoft.com".

OnlineSettings

Specifies the following settings for connecting to the Microsoft Office 365 organization components:

Property

Type

Description

Account

string

Specifies the user account for the Microsoft Office 365 organization.

For example, "account": "user@organization.onmicrosoft.com".

Password

string

Specifies the user password for the Microsoft Office 365 organization.

For example, "password": "password".

GrantAdminAccess

string

If set to True, indicates that the user will obtain Site Collection Admin rights in order to access site collections and sites.

For example, "grantAdminAccess": "true".

UseMfa

bool

If set to True, indicates that the Veeam Backup for Office 365 will use modern authentication to connect to the organization.

For example, "useMfa": "true".

ApplicationId

string

For modern authentication against the Microsoft Office 365 organization.

Specifies an application ID for connecting to the Microsoft Office 365 organization.

For example, "applicationId": "63baecf00-2624-45d0-9ece-de1db611dc98"

ApplicationSecret

string

For modern authentication against the Microsoft Office 365 organization.

Specifies an application secret for connecting to the Microsoft Office 365 organization.

For example, "applicationSecret": "fCblKbIf+kY10+uB+rROD+wZPT/WxcDNX+EU2O33Q1s="

ApplicationCertificate

string

For modern authentication against the Microsoft Office 365 organization.

Specifies a path to the application certificate for connecting to the Microsoft Office 365 organization.

For example, "applicationCertificate": "C:\ApplicationCertificate.pfx"

ApplicationCertificatePassword

string

For modern authentication against the Microsoft Office 365 organization.

Specifies an application certificate password for connecting to the Microsoft Office 365 organization.

For example, "applicationCertificatePassword": "fCblKbIf+kY10+uB+rROD+wZPT/WxcDNX+EU2O33Q1s="

ApplicationCertificateThumbprint

string

For modern authentication against the Microsoft Office 365 organization.

Specifies an application certificate thumbprint for connecting to the Microsoft Office 365 organization.

For example, "applicationCertificateThumbprint": "56B0DF39470953D9D4C0CFA6F97112615D4FD0E1"

UseCustomVeeamAADApplication

bool

For native authentication against the Microsoft Office 365 organization.

If set to True, indicates that the Veeam Backup for Microsoft Office 365 will use Veeam AAD Application for a connection to the Microsoft Office 365 organization.

For example, "useCustomVeeamAADApplication":"true".

For example:

{

   "type": "Office365",

   "region": "Worldwide",

   "isExchangeOnline": false,

   "isSharePointOnline": true,

   "sharePointOnlineSettings": {

     "account": "user@organization.onmicrosoft.com",

     "grantAdminAccess": true,

     "useMfa": false,

     "useCustomVeeamAADApplication": true

   }

On-Premises

To modify the On-Premises organization settings, specify the following properties:

Property

Type

Description

ExchangeSettings

ExchangeSettings

Specifies On-Premises Microsoft Exchange settings.

SharePointSettings

SharePointSettings

Specifies On-Premises Microsoft SharePoint settings.

ExchangeSettings

Specify the following On-Premises Microsoft Exchange settings:

Property

Type

Description

Username

string

Specifies the username for authenticating with the On-Premises Microsoft Exchange organization.

For example, "username": "qa\\rstones".

Password

string

Specifies the user password for authenticating with the On-Premises Microsoft Exchange organization.

For example, "password": "Passw0rd".

ServerName

string

Specifies Microsoft Exchange server EWS endpoint URL.

For example, "serverName": "newmail.migrationendpoint.com".

GrantImpersonation

bool

If set to True, indicates that backup jobs will be able to process all mailboxes within Exchange organization.

For example, "grantImpersonation": "true".

UseSSL

bool

If set to True, indicates that Veeam Backup for Microsoft Office 365 will use a secure connection with Microsoft Exchange organization server.

For example, "useSSL": "true".

SkipCAverification

bool

If set to True, indicates that Certificate Authority verification check will not be performed.

For example, "skipCAverification": "true".

SkipCommon
NameVerification

bool

If set to True, indicates that Common Name verification check will not be performed.

For example, "skipCommonnameverification": "true".

SkipRevocationCheck

bool

If set to True, indicates that the check of certificate expiration against the certificate revocation list will not be performed.

For example, "skipRevocationcheck": "true".

Configure
ThrottlingPolicy

bool

If set to True, configures VeeamArchiverThrottlingPolicy for connecting with Microsoft Exchange organization server. VeeamArchiverThrottlingPolicy overrides existing Exchange throttling policies and provides unlimited network bandwidth.

For example, "configureThrottlingpolicy": "true".

SharePointSettings

Specifies the following On-Premises Microsoft SharePoint settings:

Property

Type

Description

ServerName

string

Specifies Microsoft SharePoint server EWS endpoint URL.

For example, "serverName": "yourmail.migrationendpointqa.com".

ServerPort

int

Specifies a port for connection to the Microsoft SharePoint server. Default server port is 5985.

For example, "serverPort": "5985".

Grant
Impersonation

bool

If set to True, indicates that backup jobs will be able to process all items within SharePoint organization.

For example, "grantImpersonation": "true".

GrantAccessToSiteCollections

bool

If set to True, indicates that the user will obtain a Site Collection Admin rights in order to access site collections and sites.

For example, "grantAccesstositecollections": "true".

Username

string

Specifies the username for authenticating with the On-Premises Microsoft SharePoint organization.

For example, "username": "qa\\rstones".

UseSSL

bool

If set to True, indicates that Veeam Backup for Microsoft Office 365 uses a secure connection with Microsoft SharePoint organization server.

For example, "useSSL": "true".

SkipCAverification

bool

If set to True, indicates that Certificate Authority verification check will not be performed.

For example, "skipCAverification": "true".

SkipCommon
NameVerification

bool

If set to True, indicates that Common Name verification check will not be performed.

For example, "skipCommonnameverification": "true".

SkipRevocationCheck

bool

If set to True, indicates that the check of certificate expiration against the certificate revocation list will not be performed.

For example, "skipRevocationcheck": "true".

For example:

{

 "Type": "OnPremises",

 "IsExchange": true,

 "ExchangeSettings":

 {

  "ServerName": "server",

  "Username": "Domain\\Administrator",

  "Password": "password",

  "UseSSL": false,

  "GrantImpersonation": true,

  "ConfigureThrottlingpolicy": true

 },

 "IsSharepoint": true,

 "SharepointSettings":

 {

  "ServerName": "server",

  "ServerPort": 5985,

  "Username": "Domain\\Administrator",

  "Password": "pass",

  "UseSSL": false,

  "GrantAccesstositecollections": true

 }

}

Hybrid

To modify the Hybrid organization settings, specify the following properties:

Property

Type

Description

Office365Settings

Office365Settings

Specifies Microsoft Office 365 settings for the Hybrid organization.

ExchangeSettings

ExchangeSettings

Specifies On-Premises Microsoft Exchange settings for the Hybrid organization.

SharePointSettings

SharePointSettings

Specifies On-Premises Microsoft SharePoint settings for the Hybrid organization.

Office365Settings

Specify the following Microsoft Office 365 settings for the Hybrid organization:

Property

Type

Description

Region

string

Specifies Microsoft Azure region where Microsoft Office 365 organization datacenter is located:

  • Worldwide
  • USgovCommunity
  • Germany
  • China
  • USgovDefence

For example, "region": "worldwide".

IsExchangeOnline

bool

If set to True, indicates that this organization contains Microsoft Office 365 Exchange components.

For example, "isExchangeOnline": "true".

IsSharePointOnline

bool

If set to True, indicates that this organization contains Microsoft Office 365 SharePoint components.

For example, "isSharePointOnline": "true".

ExchangeOnlineSettings

OnlineSettings

Specifies Microsoft Office 365 Exchange organization connection settings.

SharePointOnlineSettings

OnlineSettings

Specifies Microsoft Office 365 SharePoint organization connection settings.

For example:

{

 "Type": "Hybrid",

 "Office365Settings":

 {

  "region": "Worldwide",

  "isExchangeOnline": false,

  "isSharePointOnline": true,

  "sharePointOnlineSettings": {

  "account": "user@organization.onmicrosoft.com",

  "grantAdminAccess": true,

  "useMfa": false,

  "useCustomVeeamAADApplication": true

 },

 "IsExchange": true,

 "ExchangeSettings":

 {

  "ServerName": "server",

  "Username": "Domain\\Administrator",

  "Password": "password",

  "UseSSL": false,

  "GrantImpersonation": true,

  "ConfigureThrottlingpolicy": true

 },

 "IsSharepoint": true,

 "SharepointSettings":

 {

  "ServerName": "server",

  "ServerPort": 5985,

  "Username": "Domain\\Administrator",

  "Password": "pass",

  "UseSSL": false,

  "GrantAccesstositecollections": true

 }

}

Response

The server returns the following response to the client.

Response Codes

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 HTTPS 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

None.

Example

The example below shows how to update the settings of the Microsoft Office 365 organization with ID 7b2b1ae1-7bbb-4651-b479-bda7edc7838b.

Request:

PUT https://support.east.local:4443/v3/Organizations/7b2b1ae1-7bbb-4651-b479-bda7edc7838b

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

 

{

   "type": "Office365",

   "region": "Worldwide",

   "isExchangeOnline": false,

   "isSharePointOnline": true,

   "sharePointOnlineSettings": {

     "account": "user@organization.onmicrosoft.com",

     "grantAdminAccess": true,

     "useMfa": false,

     "useCustomVeeamAADApplication": true

   }

 

Response:

200 OK

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference