CreateTenant service

Use this service to create a new tenant. The service has all of the same functionality that is available on the Tenant Creation landing page, and adds additional capabilities that are available only in the service implementation. Specifically, the service allows custom parameters to be passed to the post-setup activity allowing client applications to vary the configuration of a tenant. For example, the sample ImportRAPs activity has been enhanced to load different RAP files from different directories based on specific parameter values.

The service takes the following parameters as arguments:

  • Tenant ID
  • Description
  • Contact Name
  • Contact Email
  • Activity Name (optional)
  • AccessGroup (if an access group different from the caller is required)
  • Param Name (optional)
  • Param Value (optional)
  • Administrator
    • Username
    • Password
  • Organization Name (for backward compatibility)
  • Web Domain Type (for backward compatibility)

The service returns a status message of success or failure.

  • If the service request is successful, the tenant’s generated URL is returned in the response.
  • If the service fails, the service response contains an error code or error message.
  • If an optional post-setup activity is specified, the service returns a job ID. If a job ID is returned, it can be used by the getTenantStatus service to determine the status of the tenant creation process.