Class Tenant

The Tenant class represents the Tenant information that is assigned to data stored in Sentinel. All data (events, identities, assets, vulnerabilities) are flagged as belonging to one or more tenants. This is intended for use in multi-tenant environments where data from each tenant should be kept separate, but can also be used by single enterprises to keep different sections of the enterprise's data apart. Each tenant is identified by a name and an internal ID. In most cases you only need to know the name, which is usually set as the instance.CONFIG.params.TenantName parameter. Ordinarily you will just place this name in events sent to the ESM framework. In some cases, however, other data objects want the Tenant ID instead of the name; use this class for this situation. The class accepts these pre-defined attributes:

Name {String} : The name of the tenant
ID {String} : The ID of the tenant

Note that if the tenant has not yet been seen by the system, there will be no corresponding record in the database and the getId() method will fail. This will only happen the first time, however; after a single event or data object referencing the tenant has been sent, the Tenant object will be created and stored.
Defined in: tenant.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	Tenant(properties) Creates an instance of the Tenant class.

Field Summary
Field Attributes	Field Name and Description
<static>	Tenant.getId The getId method returns an ID for a given tenant name.

Class Detail

Tenant(properties)

Creates an instance of the Tenant class.
Author: Novell Engineering.

instance.CONFIG.tenant = new Tenant({"Name":instance.CONFIG.params.TenantName});
var asset = new Asset({IPv4:"10.0.0.24",Vendor:"Novell",Tenant:instance.CONFIG.tenant});

Parameters:
{Object} properties: Set of pre-defined properties used to initialize this object

Field Detail

<static> {ID} Tenant.getId

The getId method returns an ID for a given tenant name.

Example:

var id = Tenant.getId("Novell")

Classes

Class Tenant