4.1.x Adding a Tenant via the CLI

Overview

CLI command	add-tenant
Description	Add a new tenant.
Command format	add-tenant -u <USERNAME> -f <FIRST_NAME> -l <LAST_NAME> -p <PASSWORD> -d <DOMAIN_NAME> -e <EMAIL>

Parameter definitions

Short option	Long option	Description	Required	Example value
-u	`--username`	Username given to the Tenant	Yes	admin
-f	`--first-name`	Tenant's first name	Yes	frank
-l	`--last-name`	Tenant's last name	Yes	Myers
-p	`--password`	Tenant's password	Yes	admin123
-d	`--domain-name`	Tenant's domain name	Yes	frank.com
-e	`--email`	Tenant's email address	Yes	foo@bar.com

Sample tenant JSON

{
  "admin": "admin",
  "firstName": "Frank",
  "lastName": "Myers",
  "adminPassword": "admin123",
  "tenantDomain": "frank.com",
  "email": "foo@bar.com",
  "active": "true"
}

For information on the property definitions, see Tenant Resource Definition.

Example

Use case: Add a tenant with the username: admin, name: Frank Myers, password: admin123, tenant domain: frank.com and email: foo@bar.com.

add-tenant -u admin -f Frank -l Myers -p admin123 -d frank.com -e foo@bar.com

Sample output

Tenant added successfully.

Child pages