Skip to content

Cloud Architecture‐ Create Tenant

Sandesh Menath edited this page Oct 25, 2023 · 4 revisions

1. Create Tenant

  • Endpoint: /tenants
  • Method: POST
  • Description: Create a new tenant.

Request Parameters

  • app_key (string, required): Your secret key.
  • domain (string, required): The domain name of the new tenant.
  • username (string, required): The username for the admin user.
  • product (string, required): The product for the new tenant.
  • product_id (integer, required): The product ID.
  • lic_code (string, required): The license code for the new tenant.

Sample Request

POST /tenants
Content-Type: application/json

{
  "app_key": "YOUR_THIRD_PARTY_APP_KEY",
  "domain": "new-tenant-domain.com",
  "username": "admin_user",
  "product": "example_product",
  "product_id": 123,
  "lic_code": "your-license-code"
}

Sample Response

{
  "status": "success",
  "message": "Your cloud instance has been created successfully. Please visit your website at <a href='https://new-tenant-domain.com' rel='noopener noreferrer' target='_blank'>https://new-tenant-domain.com</a>. You will receive a password on your registered email.",
  "password": "your-password",
  "tenant": "new-tenant-id"
}

Note: The request data you see is the data Agora invoicing will be sending and will be expecting the response which is mentioned here and then the parent API Create tenant will continue executing

Clone this wiki locally