Tenant Logon Session

In this article

    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"?>
    <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>P@ssw0rd</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="https://localhost:9398/api/logonSessions/362da803-804d-4c32-ad35-0972e432460b">
     <Links>
       <Link Rel="Up" Type="EnterpriseManager" Href="https://localhost:9398/api/" />
       <Link Rel="Down" Type="CloudConnectService" Href="https://localhost:9398/api/cloud" />
       <Link Rel="Delete" Type="LogonSession" Href="https://localhost:9398/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 REST API. For example:

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

    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 vCloud 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 vCloud 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">
       <VCloudOrganizationCredentials>
           <OrganizationName>vCDOrg1</OrganizationName>
           <Login>user01</Login>
           <Password>Qwe123</Password>
       </VCloudOrganizationCredentials>
    </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="https://localhost:9398/api/logonSessions/362da803-804d-4c32-ad35-0972e432460b">
     <Links>
       <Link Rel="Up" Type="EnterpriseManager" Href="https://localhost:9398/api/" />
       <Link Rel="Down" Type="CloudConnectService" Href="https://localhost:9398/api/cloud" />
       <Link Rel="Delete" Type="LogonSession" Href="https://localhost:9398/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 REST API. For example:

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

    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.

    I want to report a typo

    There is a misspelling right here:

     

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