Create Tenant

Creates or edits a tenant.

NAKIVO Backup & Replication must be running in multi-tenant mode. Refer to the Multi-Tenant Mode topic in the User Guide.

Endpoint

https://<Director_IP_address>:4443/c/router

Request Example

Request Fields

Field
Type
Value(s)
Description

action

string

MultitenancyManagement

The action that is invoked

method

string

save

The method that is invoked

data

array

Parameters. See the data table below

type

string

rpc

Type of communication protocol

tid

integer

1

Transaction ID. Used to identify the request by both the client and the server

data

Field
Type
Description

sessionUuid

string A pseudo-randomly generated value to identify one session from another. This unique value is used to set a tenant image creation session; the value can be null. Refer to Create Session for details

tenantInfoDto

array

Information about the tenant

tenant

array

Tenant to be saved. See the tenant table below

tenant

Field
Type
Description

id

integer

ID of the tenant. Must be null if a new tenant is created

name

string

Name of the tenant

allocatedPhysicalServers

int

Number of physical server licenses to be allocated to the tenant

allocatedPhysicalWorkstations

int

Number of physical workstation licenses to be allocated to the tenant

allocatedOffice365Users

int

Number of Microsoft Office 365 licenses to be allocated to the tenant

allocatedOracleDatabases

int

Number of Oracle Database  licenses to be allocated to the tenant

allocatedBackupStorage

int

Amount of backup storage space allocated to the tenant

usedBackupStorage

int

Amount of used backup storage space used by the tenant

email

string

Contact Email address of the tenant

phone

string

Contact phone number of the tenant

website

string

URL address of the tenant

address

string

Address of the tenant

allocated

int

Licenses—machines or sockets—to be allocated to the tenant

allocatedEc2Instances

int

Licenses—EC2 instances—to be allocated to the tenant

showName

boolean

true if the tenant name is displayed. false otherwise

labels

array

Labels of the tenant

tenantInventory

Field
Type
Description

itemObjectList



nodes



VMWARE



HYPERV



PHYSICAL



users

Field

Type

Description

id

integer

ID of user. Null is a new user.

username

string

Username of user

name

string

Name of user

userType

string

Type of user

Only accepts ‘NORMAL’

generatePassword

boolean

True will make password generated and send to user via email

password

string

Password to be set to a new user. Can be null if ‘generatePassword’ = true

email

string

Email of the tenant

Mandatory if generatePassword = true

description

string

Description of user.

roleId

string

ID of the role assigned to the tenant

action

string

Possible value: "ADD_LOCAL"

Response Sample

Note

The created tenant ID = 1.

Response Fields

Field
Value
Description

message

string Message if the request failed

where

string Reference to the method where the problem occurred

cause

string Cause of failure

data

integer The ID of the created or edited tenant