This section explains how to edit settings of an organization with the specified ID.
Request
PUT https://<hostname>:4443/v4/Organizations/{organizationId} |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following parameters must be posted as URL.
Parameter | Type | Description |
organizationId | string | An identification number of the organization. |
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.
To modify the Microsoft Office 365 organization settings, specify the following properties:
Property | Type | Description |
Type | string | Specifies the organization type:
|
Region | string | Specifies Microsoft Azure region where Microsoft Office 365 organization datacenter is located:
|
IsExchangeOnline | boolean | If set to True, indicates that this organization contains Microsoft Office 365 Exchange components. |
IsSharePointOnline | boolean | If set to True, indicates that this organization contains Microsoft Office 365 SharePoint components. |
ExchangeOnlineSettings | Specifies Microsoft Office 365 Exchange organization connection settings. | |
SharePointOnlineSettings | Specifies Microsoft Office 365 SharePoint organization connection settings. | |
Id | string | Specifies the ID of the organization. |
Name | string | Specifies the name of the Office 365 organization. |
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. |
Password | string | Specifies the user password for the Microsoft Office 365 organization. |
GrantAdminAccess | string | If set to True, indicates that the user will obtain Site Collection Admin rights in order to access site collections and sites. |
UseMfa | boolean | If set to True, indicates that the Veeam Backup for Office 365 will use modern authentication to connect to the organization. |
ApplicationId | string | For modern authentication against the Microsoft Office 365 organization. Specifies an application ID for connecting to the Microsoft Office 365 organization. |
ApplicationSecret | string | For modern authentication against the Microsoft Office 365 organization. Specifies an application secret for connecting to the Microsoft Office 365 organization. |
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. |
ApplicationCertificatePassword | string | For modern authentication against the Microsoft Office 365 organization. Specifies an application certificate password for connecting to the Microsoft Office 365 organization. |
ApplicationCertificateThumbprint | string | For modern authentication against the Microsoft Office 365 organization. Specifies an application certificate thumbprint for connecting to the Microsoft Office 365 organization. |
UseCustomVeeamAADApplication | boolean | 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:
{ "type": "Office365", "region": "Worldwide", "isExchangeOnline": false, "isSharePointOnline": true, "sharePointOnlineSettings": { "account": "user@organization.onmicrosoft.com", "grantAdminAccess": true, "useMfa": false, "useCustomVeeamAADApplication": true } |
To modify the on-premises organization settings, specify the following properties:
Property | Type | Description |
ExchangeSettings | Specifies on-premises Microsoft Exchange settings. | |
SharePointSettings | Specifies on-premises Microsoft SharePoint settings. |
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. |
Password | string | Specifies the user password for authenticating with the on-premises Microsoft Exchange organization. |
ServerName | string | Specifies Microsoft Exchange server EWS endpoint URL. |
GrantImpersonation | boolean | If set to True, indicates that backup jobs will be able to process all mailboxes within Exchange organization. |
UseSSL | boolean | If set to True, indicates that Veeam Backup for Microsoft Office 365 will use a secure connection with Microsoft Exchange organization server. |
SkipCAverification | boolean | If set to True, indicates that Certificate Authority verification check will not be performed. |
SkipCommonNameVerification | boolean | If set to True, indicates that Common Name verification check will not be performed. |
SkipRevocationCheck | boolean | If set to True, indicates that the check of certificate expiration against the certificate revocation list will not be performed. |
ConfigureThrottlingPolicy | boolean | If set to True, configures VeeamArchiverThrottlingPolicy for connecting with Microsoft Exchange organization server. VeeamArchiverThrottlingPolicy overrides existing Exchange throttling policies and provides unlimited network bandwidth. |
Specifies the following on-premises Microsoft SharePoint settings:
Property | Type | Description |
ServerName | string | Specifies Microsoft SharePoint server EWS endpoint URL. |
ServerPort | int | Specifies a port for connection to the Microsoft SharePoint server. Default server port is 5985. |
GrantImpersonation | boolean | If set to True, indicates that backup jobs will be able to process all items within SharePoint organization. |
GrantAccessToSiteCollections | boolean | If set to True, indicates that the user will obtain a Site Collection Admin rights in order to access site collections and sites. |
Username | string | Specifies the username for authenticating with the on-premises Microsoft SharePoint organization. |
UseSSL | boolean | If set to True, indicates that Veeam Backup for Microsoft Office 365 uses a secure connection with Microsoft SharePoint organization server. |
SkipCAverification | boolean | If set to True, indicates that Certificate Authority verification check will not be performed. |
SkipCommonNameVerification | boolean | If set to True, indicates that Common Name verification check will not be performed. |
SkipRevocationCheck | boolean | If set to True, indicates that the check of certificate expiration against the certificate revocation list will not be performed. |
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 } } |
To modify the Hybrid organization settings, specify the following properties:
Property | Type | Description |
exchangeOnlineSettings | Specifies Microsoft Office 365 settings for the Hybrid organization. | |
sharePointOnlineSettings | ||
ExchangeSettings | Specifies on-premises Microsoft Exchange settings for the Hybrid organization. | |
SharePointSettings | Specifies on-premises Microsoft SharePoint settings for the Hybrid organization. |
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:
|
IsExchangeOnline | boolean | If set to True, indicates that this organization contains Microsoft Office 365 Exchange components. |
IsSharePointOnline | boolean | If set to True, indicates that this organization contains Microsoft Office 365 SharePoint components. |
ExchangeOnlineSettings | Specifies Microsoft Office 365 Exchange organization connection settings. | |
SharePointOnlineSettings | Specifies Microsoft Office 365 SharePoint organization connection settings. |
For example:
"Type": "Hybrid", "region": "Worldwide", "isExchangeOnline": true, "isSharePointOnline": true, "exchangeOnlineSettings": { "account": "administrator@abc.onmicrosoft.com", "Password": "XXXXXXX", "grantAdminAccess": true, "useMfa": false, "useCustomVeeamAADApplication": true }, "sharePointOnlineSettings": { "account": "administrator@abc.onmicrosoft.com", "Password": "XXXXXXX", "grantAdminAccess": true, "useMfa": false, "useCustomVeeamAADApplication": true }, "IsExchange": true, "ExchangeSettings": { "ServerName": "split", "ServerPort": 5985, "Username": "domain\\administrator", "Password": "password", "UseSSL": false, "GrantImpersonation": true, "ConfigureThrottlingpolicy": true }, "IsSharepoint": true, "SharepointSettings": { "ServerName": "vodice", "ServerPort": 5985, "Username": "domain\\administrator", "Password": "password", "UseSSL": false, "GrantAccesstositecollections": true } } |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a 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 response 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://abc.tech.local:4443/v4/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 |
