This is an archive version of the document. To get the most up-to-date information, see the current version./Organizations/{id}
Represents an organization with a specified ID.
Resource URL
The URL of the reference resource representation:
https://<Backup-Office365>:4443/v3/Organizations/{id} |
Related Resources
- /Organizations/{organizationId}/Jobs
- /Organizations/{id}/UsedRepositories
- /Organizations/{organizationId}/Groups
- /Organizations/{organizationId}/Sites
- /Organizations/{organizationId}/Users
- /Organizations/{id}/LicensingInformation
Methods
The following methods are supported for the /Organizations/{id} resource:
- (GET) /Organizations/{id}
- (PUT) /Organizations/{id}
- (DELETE) /Organizations/{id}
- (POST) /Organizations/{organizationId}/Action
Properties
The /Organizations/{id} resource can contain different properties depending on the organization type:
The /Organizations/{id} resource for the Microsoft Office 365 organization has the following properties:
Property | Type | Description |
Type | string | Specifies the organization type:
For example, "type": "office365". |
Region | string | Specifies Microsoft Azure region where Microsoft Office 365 organization datacenter is located:
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 | 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 added to Veeam Backup for Microsoft Office 365. For example, "id": "7b2b1ae1-7bbb-4651-b479-bda7edc7838b". |
Name | string | Specifies the name of the Office 365 organization. For example, "name": "eastsupport.onmicrosoft.com". |
IsBackedup | bool | If set to True, indicates that this organization had already been processed by a backup job. For example, "isBackedup": "true". |
First | UTC | Specifies the time when this organization was processed by a backup job for the first time. For example, "firstBackuptime": "2017-04-05T08:04:55". |
Last | UTC | Specifies the time when this organization was processed by a backup job for the last time. For example, "lastBackuptime": "2017-11-05T17:50:35". |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
The /Organizations/{id} resource for the On-Premises organization has the following properties:
Property | Type | Description |
Type | string | Specifies the organization type:
For example, "type": "office365". |
IsExchange | bool | If set to True, indicates that this organization contains On-Premises Microsoft Exchange components. For example, "isExchange": "true". |
IsSharePoint | bool | If set to True, indicates that this organization contains On-Premises Microsoft SharePoint components. For example, "isSharePoint": "true". |
ExchangeSettings | Specifies On-Premises Microsoft Exchange organization connection settings. | |
SharePointSettings | Specifies On-Premises Microsoft SharePoint organization connection settings. | |
Id | string | Specifies the ID of the organization added to Veeam Backup for Microsoft Office 365. For example, "id": "9lk44df4-79vb-0486-r239-edg7eyu5467b". |
Name | string | Specifies the name of the On-Premises organization. For example, "name": "yourmail.migrationendpoint.com". |
IsBackedup | bool | If set to True, indicates that this organization had already been processed by a backup job. For example, "isBackedup": "true". |
First | UTC | Specifies the time when this organization was processed by a backup job for the first time. For example, "firstBackuptime": "2017-04-05T08:04:55". |
Last | UTC | Specifies the time when this organization was processed by a backup job for the last time. For example, "lastBackuptime": "2017-11-05T17:50:35". |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
The /Organizations/{id} resource for the Hybrid organization has the following properties:
Property | Type | Description |
Type | string | Specifies the organization type:
For example, "type": "hybrid". |
IsExchange | bool | If set to True, indicates that this organization contains On-Premises Microsoft Exchange components. For example, "isExchange": "true". |
IsSharePoint | bool | If set to True, indicates that this organization contains On-Premises Microsoft SharePoint components. For example, "isSharePoint": "true". |
Office365Settings | Specifies Microsoft Office 365 settings for the Hybrid organization. | |
ExchangeSettings | Specifies On-Premises Microsoft Exchange settings. | |
SharePointSettings | Specifies On-Premises Microsoft SharePoint settings. | |
Id | string | Specifies the ID of the organization added to Veeam Backup for Microsoft Office 365. For example, "id": "b2d9414d-c417-4a94-be3b-b38a3c2e8a7b". |
Name | string | Specifies the name of the Hybrid organization. For example, "name": "yourmail.migrationendpointqa.com". |
IsBackedup | bool | If set to True, indicates that this organization has already been processed by a backup job. For example, "isBackedup": "true". |
First | UTC | Specifies the time when this organization was processed by a backup job for the first time. For example, "firstBackuptime": "2017-04-05T08:04:55". |
Last | UTC | Specifies the time when this organization was processed by a backup job for the last time. For example, "lastBackuptime": "2017-11-05T17:50:35". |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Specifies the following Microsoft Office 365 settings for the Hybrid organization:
Property | Type | Description |
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 | Specifies Microsoft Office 365 Exchange organization connection settings. | |
SharePointOnlineSettings | Specifies Microsoft Office 365 SharePoint organization connection settings. | |
Region | string | Specifies Microsoft Azure region where Microsoft Office 365 organization datacenter is located:
For example, "region": "worldwide". |
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 | Specifies that the user will be granted rights for accessing 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". |
Specifies the following On-Premises Microsoft Exchange settings:
Property | Type | Description |
ServerName | string | Specifies Microsoft Exchange server EWS endpoint URL. For example, "serverName": "yourmail.migrationendpointqa.com". |
Grant | bool | If set to True, indicates that backup jobs will be able to process all mailboxes within Exchange organization. For example, "grantImpersonation": "true". |
Username | string | Specifies the username for authenticating with the On-Premises Microsoft Exchange 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 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". |
ConfigureThrottlingPolicy | bool | If set to True, indicates that VeeamArchiverThrottlingPolicy will be configured for connecting with Microsoft Exchange organization server. VeeamArchiverThrottlingPolicy overrides 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". |
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". |
Resource Representation
The /Organizations/{id} resource for the Microsoft Office 365 organization has the following representation:
{ "type": "Office365", "region": "Worldwide", "isExchangeOnline": true, "isSharePointOnline": true, "exchangeOnlineSettings": { "account": "user@organization.onmicrosoft.com", "grantAdminAccess": true, "useMfa": false, "useCustomVeeamAADApplication": true }, "sharePointOnlineSettings": { "account": "user@organization.onmicrosoft.com", "grantAdminAccess": true, "useMfa": false, "useCustomVeeamAADApplication": true }, "id": "34a1d22d-2073-43a6-8c22-f2b86e6c3a07", "name": "organization.onmicrosoft.com", "isBackedup": false, "_links": { "self": { "href": "https://support.east.local:4443/v3/Organizations/7b2b1ae1-7bbb-4651-b479-bda7edc7838b" }, "jobs": { "href": "https://support.east.local:4443/v3/Organizations/7b2b1ae1-7bbb-4651-b479-bda7edc7838b/Jobs" }, "mailboxes": { "href": "https://support.east.local:4443/v3/Organizations/7b2b1ae1-7bbb-4651-b479-bda7edc7838b/mailboxes" } }, "_actions": {} } |