This is an archive version of the document. To get the most up-to-date information, see the current version.

Tenant Logon Session

In this article

    Service providers can allow tenants to log on to Veeam Backup Enterprise Manager RESTful API and perform operations with resources available to a specific tenant. To create a new logon session for a tenant, you need to provide tenant credentials in the body of the POST HTTP request to the URL of the /sessionMngr/ resource. To learn more about creating a new logon session, see Perform Logon.

    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"?>
    <LoginSpec xmlns="http://www.veeam.com/ent/v1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <TenantCredentials>
    <Username>ABC Company</Username>
    <Password>12345678</Password>
    </TenantCredentials>
    </LoginSpec>

    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="http://localhost:9399/api/logonSessions/362da803-804d-4c32-ad35-0972e432460b">
     <Links>
       <Link Rel="Up" Type="EnterpriseManager" Href="http://localhost:9399/api/" />
       <Link Rel="Down" Type="CloudConnectService" Href="http://localhost:9399/api/cloud" />
       <Link Rel="Delete" Type="LogonSession" Href="http://localhost:9399/api/logonSessions/362da803-804d-4c32-ad35-0972e432460b" />
     </Links>
     <UserName>SRV36\Administrator</UserName>
     <SessionId>362da803-804d-4c32-ad35-0972e432460b</SessionId>
    </LogonSession>

    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 RESTful API. For example:

    <CloudConnectService xmlns="http://www.veeam.com/ent/v1.0" Type="CloudConnectService" Href="http://localhost:9399/api/cloud">
     <Links>
       <Link Rel="Up" Type="LogonSession" Href="http://localhost:9399/api/logonSessions/362da803-804d-4c32-ad35-0972e432460b" />
       <Link Rel="Down" Type="CloudFailoverPlanReferenceList" Href="http://localhost:9399/api/cloud/cloudFailoverPlans" />
       <Link Rel="Down" Type="CloudVmReplicaPointReferenceList" Href="http://localhost:9399/api/cloud/vmReplicaPoints" />
       <Link Rel="Down" Type="CloudReplicaReferenceList" Href="http://localhost:9399/api/cloud/replicas" />
       <Link Rel="Down" Type="CloudFailoverPlanList" Href="http://localhost:9399/api/cloud/cloudFailoverPlans?format=Entity" />
       <Link Rel="Down" Type="CloudVmReplicaPointList" Href="http://localhost:9399/api/cloud/vmReplicaPoints?format=Entity" />
       <Link Rel="Down" Type="CloudReplicaList" Href="http://localhost:9399/api/cloud/replicas?format=Entity" />
     </Links>
    </CloudConnectService>

    With Veeam Backup Enterprise Manager RESTful API, a tenant can perform the following operations:

    A tenant cannot edit a cloud failover plan via Veeam Backup Enterprise Manager RESTful API.