Database Information

Database Name	Database Type	Collection Name
%tenant_code%_multitenant	MongoDB	tenants

Record Explanation

Field Name

Type

Mandatory

Unique

Indexed

Description

_id

Mongo ID

YES

YES

YES

Mongo Record ID

code

String

YES

YES

YES

Tenant Code

name

String

YES

NO

NO

Tenant Name

description

String

NO

NO

NO

Tenant Description

type

String

NO

NO

NO

Tenant Type

console

Boolean

NO

NO

NO

Tenant is Console or not

tag

String

NO

NO

NO

Tenant Tag

profile

Object

NO

NO

NO

Tenant Profile

tenant

Object

NO

NO

NO

Main Tenant - If a tenant was client → It needs to have main tenant

	Field Name	Type	Mandatory	Unique	Indexed	Description
id		String	YES	NO	NO	Main Tenant ID
code		String	YES	NO	NO	Main Tenant Code

oauth

Object

YES

NO

NO

Open Authentication

	Type	Mandatory	Unique	Indexed	Description
secret	String	YES	NO	NO	String for secret of oauth
redirectURI	String	YES	NO	NO	URI for redirection
grants	Array	YES	NO	NO
disabled	Integer	YES	NO	NO
type	Integer	YES	NO	NO
loginMode	Integer	YES	NO	NO	Login Technology & Method
pin	Object	NO	YES	NO	Pin Code Object

application

Array

NO

NO

NO

Tenant Application

Field Name

Type

Mandatory

Unique

Indexed

Description

description

String

NO

NO

NO

Application Description

product

String

YES

NO

NO

Product Code

package

String

YES

NO

NO

Package Code

acl

Object

NO

NO

NO

Exactly like product scope ACL to overwrite the product ACL for this tenant this product

_TTL

String

YES

NO

NO

Time to Live - ['6', '12', '24', '48', '72', '96', '120', '144', '168']

keys

Array

YES

NO

NO

Application Keys

Field Name

Type

Mandatory

Unique

Indexed

Description

key

String

NO

NO

NO

extKeys

Array

NO

NO

NO

External Keys

	Type	Mandatory	Unique	Indexed	Description
label	String	NO	NO	NO	Key label
extKey	String	YES	YES	NO	External Key
device	Object	NO	NO	NO	Device Information
geo	Object	NO	NO	NO	Geo Location
env	String	NO	NO	NO	Environment Name
dashboardAccess	Boolean	NO	NO	NO	Have Access to dashboard or not
expDate	String	NO	NO	NO	Expiry Date

config

Object

NO

NO

NO

Configuration Object

Field Name

Type

Mandatory

Unique

Indexed

Description

%environment_name%

Object

NO

NO

NO

Environment Name

	Field Name	Type	Mandatory	Unique	Indexed	Description
%service_name%		Object	NO	NO	NO

commonFields

Object

NO

NO

NO

Sample

Record Sample

{
	_id: '5c0e74ba9acc3c5a84a51259',
	type: "product",
	code: "DBTN",
	name: "Console Tenant",
	description: "This is the tenant that holds the access rights and configuration for the console users with DSBRD_GUEST as Guest default package",
	oauth: {
		secret: %SECRET%,
		redirectURI: "http://domain.com",
		grants: [
			"password",
			"refresh_token"
		],
		pin: {
			DSBRD: {
				enabled: false
			}
		},
		disabled: 0,
		type: 2,
		loginMode: "urac"
	},
	applications: [
		{
			product: "DSBRD",
			package: "DSBRD_GUEST",
			description: "Dashboard application for DSBRD_GUEST package",
			appId: "5c0e74ba9acc3c5a84a5125a",
			_TTL: 604800000,
			keys: [
				{
					key: %KEY%,
					extKeys: [
						{
							label: %label%,
							extKey: %EXTERNAL_KEY%,
							device: null,
							geo: null,
							env: "DASHBOARD",
							dashboardAccess: true,
							expDate: null
						}
					],
					config: {
						dashboard: {
							oauth: {
								loginMode: "urac"
							},
							commonFields: {
								mail: {
									from: "me@localhost.com",
									transport: {
										type: "sendmail",
										options: {

										}
									}
								}
							},
							urac: {
								hashIterations: 1024,
								seedLength: 32,
								link: {
									addUser: "http://dashboard.soajs.org:80/#/setNewPassword",
									changeEmail: "http://dashboard.soajs.org:80/#/changeEmail/validate",
									forgotPassword: "http://dashboard.soajs.org:80/#/resetPassword",
									join: "http://dashboard.soajs.org:80/#/join/validate"
								},
								tokenExpiryTTL: 172800000,
								validateJoin: true,
								mail: {
									join: {
										subject: "Welcome to SOAJS",
										path: "undefined/soajs/node_modules/soajs.urac/mail/urac/join.tmpl"
									},
									forgotPassword: {
										subject: "Reset Your Password at SOAJS",
										path: "undefined/soajs/node_modules/soajs.urac/mail/urac/forgotPassword.tmpl"
									},
									addUser: {
										subject: "Account Created at SOAJS",
										path: "undefined/soajs/node_modules/soajs.urac/mail/urac/addUser.tmpl"
									},
									changeUserStatus: {
										subject: "Account Status changed at SOAJS",
										path: "undefined/soajs/node_modules/soajs.urac/mail/urac/changeUserStatus.tmpl"
									},
									changeEmail: {
										subject: "Change Account Email at SOAJS",
										path: "undefined/soajs/node_modules/soajs.urac/mail/urac/changeEmail.tmpl"
									}
								}
							}
						}
					}
				}
			]
		}
	],
	tag: "Console",
	console: true
}

Browser not supported