Editing Organization Parameters

In this article

    You can edit settings of an organization with the specified ID.

    Request

    PUT https://<hostname>:4443/v5/Organizations/{organizationId}

    Request Headers

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

    Request Parameters

    The following parameter must be specified in the URL of the request:

    Parameter

    Type

    Description

    organizationId

    string

    Specifies the identification number of the Office 365 organization. For more information on how to get this parameter, see Getting Organizations.

    Request Body

    To edit the settings of the organization, you need to enter in the request body the required 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.

    Microsoft Office 365 Organizations

    To modify the Microsoft Office 365 organization settings, specify 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.

    isTeamsOnline

    boolean

    If set to true, indicates that this organization contains Microsoft Teams 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.

    name

    string

    Specifies the name of the Office 365 organization.

    OnlineSettings

    Specifies the following settings for connecting to the Microsoft Office 365 organization components:

    Property

    Type

    Description

    account

    string

    Specifies the user account for authenticating with the Microsoft Office 365 organization.

    password

    string

    Specifies the password for authenticating with the Microsoft Office 365 organization.

    grantAdminAccess

    string

    If set to true, indicates that the user will obtain Site Collection Admin rights to access site collections and sites.

    useMfa

    boolean

    If set to true, indicates that the Veeam Backup for Microsoft 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 Azure AD application.

    For more information on how to obtain a Base64 string, see Converting Certificate to Base64 String.

    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 Azure AD Application for a connection to the Microsoft Office 365 organization.

    For example:

    Request Body:

    {

       "type": "Office365",

       "region": "Worldwide",

       "isExchangeOnline": false,

       "isSharePointOnline": true,

       "sharePointOnlineSettings": {

         "account": "user@organization.onmicrosoft.com",

         "grantAdminAccess": true,

         "useMfa": false,

         "useCustomVeeamAADApplication": true

       }

    Converting Certificate to Base64 String

    If you want to use a certificate to access an Azure AD application, you must provide the certificate as a Base64 string. To obtain a Base64 string, perform the following steps:

    1. Get the certificate content from a PFX file.
    2. Convert the certificate to a Base64 string.

    To do this, you can use the following PowerShell cmdlets:

    $pfx_cert = get-content '<path_to_cert>' -Encoding Byte

    [System.Convert]::ToBase64String($pfx_cert) | Out-File '<path_to_file>'

    where:

    For example:

    $pfx_cert = get-content 'C:\cert.pfx' -Encoding Byte

    [System.Convert]::ToBase64String($pfx_cert) | Out-File 'C:\base64.txt'

    On-Premises Organizations

    To modify the on-premises organization settings, specify the following properties:

    Property

    Type

    Description

    exchangeSettings

    exchangeSettings

    Specifies on-premises Microsoft Exchange settings.

    sharePointSettings

    sharePointSettings

    Specifies on-premises Microsoft SharePoint settings.

    exchangeSettings

    Specify the following on-premises Microsoft Exchange settings:

    Property

    Type

    Description

    username

    string

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

    password

    string

    Specifies the 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.

    sharePointSettings

    Specifies the following on-premises Microsoft SharePoint settings:

    Property

    Type

    Description

    serverName

    string

    Specifies Microsoft SharePoint server EWS endpoint URL.

    serverPort

    integer

    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 to access site collections and sites.

    username

    string

    Specifies the user name 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:

    Request Body:

    {

     "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

     }

    }

    Hybrid Organizations

    To modify the Hybrid organization settings, specify the following properties:

    Property

    Type

    Description

    exchangeOnlineSettings

    OnlineSettings

    Specifies Microsoft Office 365 settings for the Hybrid organization.

    sharePointOnlineSettings

    exchangeSettings

    exchangeSettings

    Specifies on-premises Microsoft Exchange settings for the Hybrid organization.

    sharePointSettings

    sharePointSettings

    Specifies on-premises Microsoft SharePoint settings for the Hybrid organization.

    Office365Settings

    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:

    • 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.

    isTeamsOnline

    boolean

    If set to true, indicates that this organization contains Microsoft Teams components.

    exchangeOnlineSettings

    OnlineSettings

    Specifies Microsoft Office 365 Exchange organization connection settings.

    sharePointOnlineSettings

    OnlineSettings

    Specifies Microsoft Office 365 SharePoint organization connection settings.

    For example:

    Request Body:

    { 

     "type": "Hybrid",

     "region": "Worldwide",

     "isExchangeOnline": true,

        "isSharePointOnline": true,
        "isTeamsOnline": 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.

    Examples

    Example 1

    The example shows how to update the settings of the Microsoft Office 365 organization with the ID 7b2b1ae1-7bbb-4651-b479-bda7edc7838b.

    Request:

    PUT https://abc.tech.local:4443/v5/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