Getting Organization Parameters

This section explains how to get a resource representation of the organization with the specified ID.

Request

GET 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

None.

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

Properties

The /Organizations/{id} resource can contain different properties depending on the organization type:

Microsoft Office 365

The /Organizations/{id} resource for the Microsoft Office 365 organization has the following properties:

Property

Type

Description

Type

string

Specifies the organization type:

  • Office365
  • OnPremises
  • Hybrid

Region

string

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

  • Worldwide
  • USgovCommunity
  • Germany
  • China
  • USgovDefence

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

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 added to Veeam Backup for Microsoft Office 365.

Name

string

Specifies the name of the Office 365 organization.

IsBackedup

boolean

If set to True, indicates that this organization had already been processed by a backup job.

FirstBackuptime

UTC

Specifies the time when this organization was processed by a backup job for the first time.

LastBackuptime

UTC

Specifies the time when this organization was processed by a backup job for the last time.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

On-Premises Organizations

The /Organizations/{id} resource for the on-premises organization has the following properties:

Property

Type

Description

Type

string

Specifies the organization type:

  • Office365
  • OnPremises
  • Hybrid

IsExchange

boolean

If set to True, indicates that this organization contains on-premises Microsoft Exchange components.

IsSharePoint

boolean

If set to True, indicates that this organization contains on-premises Microsoft SharePoint components.

ExchangeSettings

ExchangeSettings

Specifies on-premises Microsoft Exchange organization connection settings.

SharePointSettings

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.

Name

string

Specifies the name of the on-premises organization.

IsBackedup

boolean

If set to True, indicates that this organization had already been processed by a backup job.

FirstBackuptime

UTC

Specifies the time when this organization was processed by a backup job for the first time.

LastBackuptime

UTC

Specifies the time when this organization was processed by a backup job for the last time.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Hybrid Organizations

The /Organizations/{id} resource for the Hybrid organization has the following properties:

Property

Type

Description

Type

string

Specifies the organization type:

  • Office365
  • OnPremises
  • Hybrid

IsExchange

boolean

If set to True, indicates that this organization contains on-premises Microsoft Exchange components.

IsSharePoint

boolean

If set to True, indicates that this organization contains on-premises Microsoft SharePoint components.

Office365Settings

Office365Settings

Specifies Microsoft Office 365 settings for the Hybrid organization.

exchangeOnlineSettings

OnlineSettings

Specifies Microsoft Office 365 settings for the Hybrid organization.

sharePointOnlineSettings

ExchangeSettings

ExchangeSettings

Specifies on-premises Microsoft Exchange settings.

SharePointSettings

SharePointSettings

Specifies on-premises Microsoft SharePoint settings.

Id

string

Specifies the ID of the organization added to Veeam Backup for Microsoft Office 365.

Name

string

Specifies the name of the Hybrid organization.

IsBackedup

boolean

If set to True, indicates that this organization has already been processed by a backup job.

FirstBackuptime

UTC

Specifies the time when this organization was processed by a backup job for the first time.

LastBackuptime

UTC

Specifies the time when this organization was processed by a backup job for the last time.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Office365Settings

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

Property

Type

Description

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

OnlineSettings

Specifies Microsoft Office 365 Exchange organization connection settings.

SharePointOnlineSettings

OnlineSettings

Specifies Microsoft Office 365 SharePoint organization connection settings.

Region

string

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

  • Worldwide
  • USgovCommunity
  • Germany
  • China
  • USgovDefence

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.

Password

string

Specifies the user password for the Microsoft Office 365 organization.

GrantAdminAccess

string

Specifies that the user will be granted rights for accessing 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.

Sets the Base64 string of an SSL certificate that you want to use to access the AD application.

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.

ExchangeSettings

Specifies the following on-premises Microsoft Exchange settings:

Property

Type

Description

ServerName

string

Specifies Microsoft Exchange server EWS endpoint URL.

Grant
Impersonation

boolean

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

Username

string

Specifies the username for authenticating with the on-premises Microsoft Exchange organization.

UseSSL

boolean

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

SkipCAverification

boolean

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

SkipCommon
NameVerification

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, indicates that VeeamArchiverThrottlingPolicy will be configured for connecting with Microsoft Exchange organization server.

VeeamArchiverThrottlingPolicy overrides existing Exchange throttling policies and provides unlimited network bandwidth.

SharePointSettings

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.

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.

Example

The following request returns an entity representation of the organization with ID 7b2b1ae1-7bbb-4651-b479-bda7edc7838b.

Request:

GET https://abc.tech.local:4443/v4/Organizations/7b2b1ae1-7bbb-4651-b479-bda7edc7838b

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

   "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": "7b2b1ae1-7bbb-4651-b479-bda7edc7838b",

   "name": "organization.onmicrosoft.com",

   "isBackedup": false,

   "_links": {

   "self": {

     "href": "https://abc.tech.local:4443/v4/Organizations/7b2b1ae1-7bbb-4651-b479-bda7edc7838b"

   },

   "jobs": {

     "href": "https://abc.tech.local:4443/v4/Organizations/7b2b1ae1-7bbb-4651-b479-bda7edc7838b/Jobs"

   },

   "mailboxes": {

     "href": "https://abc.tech.local:4443/v4/Organizations/7b2b1ae1-7bbb-4651-b479-bda7edc7838b/mailboxes"

   }

 }

}

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.