Organizations with Basic Authentication

This section explains how to add Microsoft Office 365 organizations using basic authentication.

Request

POST https://<hostname>:4443/v4/Organizations

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

None.

Request Body

The following table lists available request parameters.

Property

Type

Description

Type

string

Sets the type of the organization that you add. Can be:

  • Office365
  • OnPremises
  • Hybrid

Region

string

Sets Microsoft Azure region. Can be:

  • Worldwide
  • USgovCommunity
  • Germany
  • China
  • USgovDefence

IsExchangeOnline

boolean

Defines whether to add an Exchange Online organization.

IsSharePointOnline

boolean

Defines whether to add a SharePoint Online organization.

ExchangeOnlineSettings

exchangeOnlineSettings Object

Sets the ExchangeOnlineSettings object.

SharePointOnlineSettings

SharePointOnlineSettings Objects

Sets the SharePointOnlineSettings object.

exchangeOnlineSettings Object

Property

Type

Description

account

string

Sets the user account with enabled MFA.

Password

string

Sets the password for the specified user.

grantAdminAccess

boolean

Defines whether to grant administrative permissions.

useMfa

boolean

Defines whether to use multi-factor authentication.

useCustomVeeamAADApplication

booleanesn

Defines whether to use a custom AD application that is automatically configured by Veeam Backup for Microsoft Office 365.

SharePointOnlineSettings Objects

Property

Type

Description

account

string

Sets the user account with enabled MFA.

Password

string

Sets the password for the specified user.

grantAdminAccess

boolean

Defines whether to grant administrative permissions.

useMfa

boolean

Defines whether to use multi-factor authentication.

useCustomVeeamAADApplication

booleanesn

Defines whether to use a custom AD application that is automatically configured by Veeam Backup for Microsoft Office 365.

Request Example

POST https://<hostname>:4443/v4/Organizations

 

Request Header:

Authorization: Bearer <Access-Token>

Request Body:

{

   "type": "Office365",

   "region": "Worldwide",

   "isExchangeOnline": true,

   "isSharePointOnline": true,

   "sharePointOnlineSettings": {

     "account": "administrator@abc.onmicrosoft.com",

     "Password": "XXXXXXXX",

     "grantAdminAccess": true,

     "useMfa": false,

     "useCustomVeeamAADApplication": true

   },

    "exchangeOnlineSettings": {

     "account": "administrator@abc.onmicrosoft.com",

     "Password": "XXXXXXXX",

     "grantAdminAccess": true,

     "useMfa": false,

     "useCustomVeeamAADApplication": true

   }

}

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 201 (Created).

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

Property

Type

Description

exchangeOnlineSettings

object

Shows the configuration of the Exchange Online organization.

sharePointOnlineSettings

object

Shows the configuration of the SharePoint Online organization.

type

string

Shows the type of the organization. Can be:

  • Office365
  • OnPremises
  • Hybrid

region

string

Shows the Microsoft Azure region.

isExchangeOnline

boolean

Shows if the Exchange Online organization is added.

isSharePointOnline

boolean

Shows if the SharePoint Online organization is added.

id

string

Shows the identification number of the Office 365 organization.

name

string

Shows the name of the organization in Veeam Backup for Microsoft Office 365.

officeName

string

Shows the Office 365 Online name.

isBackedup

string

Shows if the organizations has backups.

firstBackuptime

string

Shows when the first backup was created for the organization.

lastBackuptime

string

Shows when the last backup was created for the organization.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Response Example

Response Body:

{

  "exchangeOnlineSettings":    {

     "useApplicationOnlyAuth": false,

     "officeOrganizationName": "veeambackupdiv3.onmicrosoft.com",

     "sharePointSaveAllWebParts": false,

     "account": "testuser3@veeambackupdiv3.onmicrosoft.com",

     "grantAdminAccess": true,

     "useMfa": true,

     "applicationId": "63caebf0-2624-48d0-9ece-de1db611dc98"

  },

  "sharePointOnlineSettings":    {

     "useApplicationOnlyAuth": false,

     "officeOrganizationName": "abc.onmicrosoft.com",

     "sharePointSaveAllWebParts": false,

     "account": "administrator@abc.onmicrosoft.com",

     "grantAdminAccess": true,

     "useMfa": true,

     "applicationId": "63caebf0-2624-48d0-9ece-de1db611dc98"

  },

  "type": "Office365",

  "region": "Worldwide",

  "isExchangeOnline": true,

  "isSharePointOnline": true,

  "id": "7f9a9b85-50e7-4f61-8f76-6a9517b8677d",

  "name": "abc.onmicrosoft.com",

  "officeName": "abc.onmicrosoft.com",

  "isBackedup": false,

  "_links":    {

     "self": {"href": "https://epsilon.tech.local:4443/v4/organizations/7f9a9b85-50e7-4f61-8f76-6a9517b8677d"},

     "jobs": {"href": "https://epsilon.tech.local:4443/v4/organizations/7f9a9b85-50e7-4f61-8f76-6a9517b8677d/jobs"},

     "groups": {"href": "https://epsilon.tech.local:4443/v4/organizations/7f9a9b85-50e7-4f61-8f76-6a9517b8677d/groups"},

     "users": {"href": "https://epsilon.tech.local:4443/v4/organizations/7f9a9b85-50e7-4f61-8f76-6a9517b8677d/users"},

     "sites": {"href": "https://epsilon.tech.local:4443/v4/organizations/7f9a9b85-50e7-4f61-8f76-6a9517b8677d/sites"},

     "usedRepositories": {"href": "https://epsilon.tech.local:4443/v4/organizations/7f9a9b85-50e7-4f61-8f76-6a9517b8677d/usedRepositories"}

  },

  "_actions": {}

}

I want to report a typo

There is a misspelling right here:

 

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