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/v2/Organizations/{ID} |
Request Headers
The request contains the following headers:
Header | Required | Description |
|---|---|---|
Content-Type: application/json | true | Specifies the type of the content for your request. |
Authorization: Bearer <Access-Token> | true | 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.
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:
For example, "region": "worldwide". |
Grant | bool | If set to True, indicates that backup jobs will be able to process all mailboxes within Office 365 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". |
UseVeeamAADApplication | bool | If set to True, indicates that this organization will use Veeam AAD Application. For example, "useVeeamAADApplication":"true". |
For example:
{ "Username": "userAlpha@organization.onmicrosoft.com", "Password": "password", "Type": "Office365", "Region": "Worldwide", "GrantImpersonation": true, "GrantAccessToSiteCollections": true "UseVeeamAADApplication": 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. |
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 |
Office365Settings | Specifies Microsoft Office 365 settings for the Hybrid organization. | |
ExchangeSettings | Specifies On-Premises Microsoft Exchange settings for the Hybrid organization. | |
SharePointSettings | Specifies On-Premises Microsoft SharePoint settings for the Hybrid organization. |
For example:
{ "Type": "Hybrid", "Office365Settings": { "Username": "userAlpha@organization.onmicrosoft.com", "Password": "password", "Region": "Worldwide", "GrantImpersonation": true, "GrantAccessToSiteCollections": 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 } } |
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:
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". |
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". |
UseVeeamAADApplication | bool | If set to True, indicates that this organization will use Veeam AAD Application. For example, "useVeeamAADApplication":"true". |
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 | 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 | 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". |
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 | 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 | 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". |
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/v2/Organizations/7b2b1ae1-7bbb-4651-b479-bda7edc7838b
Request Header: Content-Type: application/json Authorization: Bearer <Access-Token>
Request Body:
{ "Username": "userAlpha@organization.onmicrosoft.com", "Password": "password", "Type": "Office365", "Region": "Worldwide", "GrantImpersonation": true, "GrantAccessToSiteCollections": true }
Response: 200 OK |
