Tenant Logon Session
Service providers can allow tenants to log on to Veeam Backup Enterprise Manager REST API and perform operations with resources available to a specific tenant. To create a new logon session for the tenant, you need to provide tenant credentials in the body of the POST HTTP request to the URL of the /sessionMngr/ resource.
The client can create logon sessions for the tenants of the following types:
For details on creating a new logon session, see Perform Logon.
Standalone Cloud Tenant Logon Session Creation
Credentials for the standalone tenant account must be provided in the TenantCredentials element.
The request body must contain the following elements:
Element | Type | Description | Modifiable | Min/Max Occurrence |
|---|---|---|---|---|
Username | String | User name of the tenant account. | Yes | 1/1 |
Password | String | Password for the tenant account. | Yes | 1/1 |
For example:
<?xml version="1.0" encoding="utf-8"?> |
In the response, Veeam Backup Enterprise Manager will return a representation of the /sessionMngr/ resource with a link to the Cloud Connect service resource. For example:
<LogonSession xmlns="http://www.veeam.com/ent/v1.0" Type="LogonSession" Href="https://localhost:9398/api/logonSessions/362da803-804d-4c32-ad35-0972e432460b"> |
In the Cloud Connect service resource representation, Veeam Backup Enterprise Manager will return a list of resources with which the specified tenant can work using Veeam Backup Enterprise Manager REST API. For example:
<CloudConnectService xmlns="http://www.veeam.com/ent/v1.0" Type="CloudConnectService" Href="https://localhost:9398/api/cloud"> |
With Veeam Backup Enterprise Manager REST API, a tenant can perform the following operations:
A tenant cannot edit a cloud failover plan with Veeam Backup Enterprise Manager REST API.
vCloud Tenant Logon Session Creation
Credentials for the VMware Cloud Director tenant account must be provided in the VCloudOrganizationCredentials element.
The request body must contain the following elements:
Element | Type | Description | Modifiable | Min/Max Occurrence |
|---|---|---|---|---|
OrganizationName | String | Name of the vCD organization. | Yes | 1/1 |
Login | String | Name of the vCD organization user. For details on VMware Cloud Director Tenant Account, see the Veeam Cloud Connect Guide. | Yes | 1/1 |
Password | String | Password for the vCD organization user account. | Yes | 1/1 |
For example:
<LoginSpec xmlns="http://www.veeam.com/ent/v1.0"> |
In the response, Veeam Backup Enterprise Manager will return a representation of the /sessionMngr/ resource with a link to the Cloud Connect service resource. For example:
<LogonSession xmlns="http://www.veeam.com/ent/v1.0" Type="LogonSession" Href="https://localhost:9398/api/logonSessions/362da803-804d-4c32-ad35-0972e432460b"> |
In the Cloud Connect service resource representation, Veeam Backup Enterprise Manager will return a list of resources with which the specified tenant can work using Veeam Backup Enterprise Manager REST API. For example:
<CloudConnectService xmlns="http://www.veeam.com/ent/v1.0" Type="CloudConnectService" Href="https://localhost:9398/api/cloud"> |
With Veeam Backup Enterprise Manager REST API, a tenant can perform the following operations:
A tenant cannot edit a cloud failover plan with Veeam Backup Enterprise Manager REST API.