Getting Organization Parameters
You can get a resource representation of the organization with the specified ID.
Request
GET 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 | 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/{organizationId} resource can contain different properties depending on the organization type:
Microsoft Office 365 Organizations
The /Organizations/{organizationId} resource for the Microsoft Office 365 organization has the following properties:
Property | Type | Description |
|---|---|---|
type | string | Specifies the organization type:
|
region | string | Specifies Microsoft Azure region where Microsoft Office 365 organization datacenter is located:
|
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 | 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. |
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). |
The /Organizations/{organizationId} resource for the on-premises organization has the following properties:
Property | Type | Description |
|---|---|---|
type | string | Specifies the organization type:
|
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 | 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. |
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). |
The /Organizations/{organizationId} resource for the Hybrid organization has the following properties:
Property | Type | Description |
|---|---|---|
type | string | Specifies the organization type:
|
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 | Specifies Microsoft Office 365 settings for the Hybrid organization. | |
exchangeOnlineSettings | Specifies Microsoft Office 365 settings for the Hybrid organization. | |
sharePointOnlineSettings | ||
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. |
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). |
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 | 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:
|
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 | 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 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. |
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. |
Specifies the following on-premises Microsoft Exchange settings:
Property | Type | Description |
|---|---|---|
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. |
userName | string | Specifies the user name 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. |
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, indicates that VeeamArchiverThrottlingPolicy will be configured for connecting with Microsoft Exchange organization server. VeeamArchiverThrottlingPolicy overrides existing Exchange throttling policies and provides unlimited network bandwidth. |
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. |
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. |
Examples
Example 1
The following request returns a resource representation of the organization with the ID 40dfa255-2762-43e5-8320-dff7a9201f90.
Request: GET https://abc.tech.local:4443/v5/Organizations/40dfa255-2762-43e5-8320-dff7a9201f90
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "isTeamsOnline": true, "exchangeOnlineSettings": { "useApplicationOnlyAuth": true, "officeOrganizationName": "abc.onmicrosoft.com", "account": "admin@abc.onmicrosoft.com", "grantAdminAccess": true, "useMfa": true, "applicationId": "a1cc0b32-c468-49a7-b4da-945927135cf2", "applicationCertificateThumbprint": "4827CDE8F66C1E34A51B50644C67012BA5B07BE9" }, "sharePointOnlineSettings": { "useApplicationOnlyAuth": true, "officeOrganizationName": "abc.onmicrosoft.com", "sharePointSaveAllWebParts": false, "account": "admin@abc.onmicrosoft.com", "grantAdminAccess": true, "useMfa": true, "applicationId": "a1cc0b32-c468-49a7-b4da-945927135cf2", "applicationCertificateThumbprint": "4827CDE8F66C1E34A51B50644C67012BA5B07BE9" }, "isExchangeOnline": true, "isSharePointOnline": true, "type": "Office365", "region": "Worldwide", "id": "40dfa255-2762-43e5-8320-dff7a9201f90", "name": "abc.onmicrosoft.com", "officeName": "abc.onmicrosoft.com", "isBackedup": true, "firstBackuptime": "2020-10-14T14:14:15.8178322Z", "lastBackuptime": "2020-12-13T22:02:17.6204765Z", "_links": { "self": { "href": "https://abc.tech.local:4443/v5/organizations/40dfa255-2762-43e5-8320-dff7a9201f90" }, "jobs": { "href": "https://abc.tech.local:4443/v5/organizations/40dfa255-2762-43e5-8320-dff7a9201f90/jobs" }, "groups": { "href": "https://abc.tech.local:4443/v5/organizations/40dfa255-2762-43e5-8320-dff7a9201f90/groups" }, "users": { "href": "https://abc.tech.local:4443/v5/organizations/40dfa255-2762-43e5-8320-dff7a9201f90/users" }, "sites": { "href": "https://abc.tech.local:4443/v5/organizations/40dfa255-2762-43e5-8320-dff7a9201f90/sites" }, "teams": { "href": "https://abc.tech.local:4443/v5/organizations/40dfa255-2762-43e5-8320-dff7a9201f90/teams" }, "usedRepositories": { "href": "https://abc.tech.local:4443/v5/organizations/40dfa255-2762-43e5-8320-dff7a9201f90/usedRepositories" } }, "_actions": {} } |