Administration

Create Tenant

Create a new tenant.

Note: Requires administrator permissions.

post/_api/tenant

Request

Request body

emailstring required

Email address of tenant.

displayNamestring

The name of the tenant.

passwdstring

The user password.

planstring

The billing plan name.

attributionstring

The attribution.

dcListstring required

A comma-separated string containing the data center names on which this tenant is to be created. If an empty string is passed in, the tenant is assumed to be global to the federation and is created on all current data centers in the federation.

Example request

{
  "email": "demo@macrometa.com",
  "displayName": "Test",
  "passwd": "XXXX",
  "plan": "ENTERPRISE",
  "attribution": "Macrometa",
  "dcList": "datacenter1, datacenter2",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "contact": {
    "firstname": "demo",
    "lastname": "marometa",
    "email": "demo@macrometa.com",
    "phone": "+1 (650) 555-9144",
    "line1": "646 Waverley Street",
    "line2": "Palo Alto, California 94301",
    "city": "Palo Alto",
    "state": "California ",
    "country": "United States of America",
    "zipcode": "94301"
  }
}

Response

Successfully created tenant.

codeinteger

HTTP response code.

errorboolean

Flag if there is an error in response. False for this response.

Example response

{
  "code": 200,
  "result": {
    "displayName": "Test",
    "email": "demo@macrometa.com",
    "attribution": "Macrometa",
    "plan": "ENTERPRISE",
    "tenant": "Test",
    "metadata": {
      "key1": "value1",
      "key2": "value2"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.