(PUT) /Organizations/{ID}

Edits settings of an Exchange organization with the 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>:<Port>/v1/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 Exchange organization type: Microsoft Office 365, On-Premises Microsoft Exchange or Hybrid.

Mind that the Username and Password properties are mandatory.

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

Property	Type	Description
Username	string	Specifies the username for authenticating with Office 365 organization. Type the organization username in one of the formats: "username"@domain.com" or "user@domain.onmicrosoft.com". For example, "username": "Admin@eastsupport.onmicrosoft.com".
Password	string	Specifies the user password for authenticating with the Office 365 organization. For example, "password": "Passw0rd".
Region	string	Specifies Microsoft Azure region where Microsoft Office 365 organization datacenter is located: Worldwide USgovCommunity Germany China USgovDefence For example, "region": "worldwide".
Grant Impersonation	bool	If set to True, indicates that backup jobs will be able to process all mailboxes within Office 365 organization. For example, "grantImpersonation": "true".

For example:

{

"username": "Admin@eastsupport.onmicrosoft.com",

"password": "Passw0rd",

"region": "germany",

"grantImpersonation": "true"

}

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

Property	Type	Description
Username	string	Specifies the username for authenticating with the On-Premises Microsoft Exchange organization. For example, "username": "support\\jsmith".
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".
SkipCommonNameVerification	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 substitutes existing Exchange throttling policies and provides unlimited network bandwidth. For example, "configureThrottlingpolicy": "true".

For example:

{

"username": "support\\jsmith",

"password": "Passw0rd",

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

"grantImpersonation": "true",

"useSSL": "true",

"skipCAverification": "true",

"skipCommonNameVerification": "true",

"skipRevocationCheck": "true",

"configureThrottlingPolicy": "true"

}

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

Property	Type	Description
Office365Settings	Office365Settings	Specifies Microsoft Office 365 settings for the Hybrid organization.
OnPremisesSettings	OnPremisesSettings	Specifies On-Premises Microsoft Exchange settings for the Hybrid organization.

Office365Settings

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

Property	Type	Description
Username	string	Specifies the username for authenticating with Office 365 organization. Type the organization username in one of the formats: "username"@domain.com" or "user@domain.onmicrosoft.com". For example, "username": "Admin@eastsupport.onmicrosoft.com".
Password	string	Specifies the user password for authenticating with the Office 365 organization. For example, "password": "Passw0rd".
Region	string	Specifies Microsoft Azure region where Microsoft Office 365 organization datacenter is located: Worldwide USgovCommunity Germany China USgovDefence For example, "region": "worldwide".
GrantImpersonation	bool	If set to True, indicates that backup jobs will be able to process all mailboxes within Office 365 organization. For example, "grantImpersonation": "true".

OnPremisesSettings

Specify the following On-Premises Microsoft Exchange settings for the Hybrid organization:

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 substitutes existing Exchange throttling policies and provides unlimited network bandwidth. For example, "configureThrottlingpolicy": "true".

For example:

{

"office365Settings":

{

"username": "qa\\rstones",

"password": "Passw0rd",

"region": "worldwide",

"GrantImpersonation": "true"

"onPremisesSettings":

{

"username": "Admin@eastqa.onmicrosoft.com",

"password": "Passw0rd",

"servername": "newmail.migrationendpoint.com",

"useSSL": "true",

"skipCAverification": "false",

"skipCommonnameverification": "false",

"skipRevocationcheck": "true",

"grantImpersonation": "true",

"configureThrottlingpolicy": "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/v1/Organizations/7b2b1ae1-7bbb-4651-b479-bda7edc7838b

Request Header:

Authorization: Bearer <Access-Token>

Request Body:

{

"username": "Admin@eastsupport.onmicrosoft.com",

"password": "Passw0rd",

"region": "germany",

"grantImpersonation": "true"

}

Response:

200 OK