| ||
| detail: element | attribute | value | ||
Attributes used for controlling the creation of a new tenant.
XML Example:<createTenantOptions> zero or N[<activationCodes>xsd:string</activationCodes>] <adminAccount>xsd:string</adminAccount> <adminEmail>xsd:string</adminEmail> <adminPassword>xsd:string</adminPassword> <confirmationRequired>xsd:boolean</confirmationRequired> <generateMasterPassword>xsd:boolean</generateMasterPassword> </createTenantOptions> | JSON Example:{"createTenantOptions":
{
"activationCodes": [String],
"adminAccount": String,
"adminEmail": String,
"adminPassword": String,
"confirmationRequired": Boolean,
"generateMasterPassword": Boolean,
}
}
|
| Name | Type | Required | Nillable | Default Value | Description |
|---|---|---|---|---|---|
| activationCodes | zero or N[xsd:string] | false | false | An list of activation codes that can be used when each tenant licenses features separately (optional).
| |
| adminAccount | xsd:string | false | false | The name of the master user account to create for the tenant.
| |
| adminEmail | xsd:string | false | false | The email address to associate with the master user account created for the tenant, and
as the primary point of contact for the tenant.
| |
| adminPassword | xsd:string | false | false | The password for the master user account to create for the tenant.
| |
| confirmationRequired | xsd:boolean | false | false | Create the tenat in a "confirmation required" state, where the tenant will receive an
email with a link they must follow in order to activate their account
| |
| generateMasterPassword | xsd:boolean | false | false | Automatically generate a password for the master user account If set, the password is emailed to the given primary email address.
|
| ||
| detail: element | attribute | value | ||