Skip to main content

TenantParms

Parameters passed when creating a tenant.

Properties

NameTypeDescriptionNotes
authentication_accountboolWhen creating a new tenant as a child of the root service provider set this to true if the tenant is to be an authentication service. If not specified, it defaults to true. You cannot set the authenticate and issuance values to both true or both false. A child of a non-root service provider inherits the value of its service provider and if specified, this value is ignored.[optional]
company_countrystrThe country two-letter code (ISO 3166-1) of the location of the company that will own this account.[optional]
company_namestrThe name of the company that will own this account. This value is required.
company_statestrThe province/state two-letter code (postal abbreviation) of the location of the company that will own this account. This value is required for companies in the United States or Canada when the companyCountry attribute is provided.[optional]
domainstrThe domain for this account. This value is required when creating a tenant
issuance_accountboolWhen creating a new tenant as a child of the root service provider set this to true if the tenant is to be an issuance service. If not specified, it defaults to false. You cannot set the authenticate and issuance values to both true or both false. A child of a non-root service provider inherits the value of its service provider and if specified, this value is ignored.[optional]
service_providerboolWhen creating a new tenant set this to true if the tenant is to be a service provider.[optional]

Example