Tenant Domains

Retrieve the list of assigned domains

GET /api/v1/tenants/(string: tenant_id)/domains/

Get the list of assigned domains to the tenant along with tenant’s default domain.

Example request:

Authorization Right:minimum Tenant Admin.

GET /api/v1/tenants/foo/domains/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
   "defaultDomain": "netaxis.sip.be",
   "domains": [
      "netaxis.sip.be",
      "customer.com"
   ]
}
Response JSON Object:

  • defaultDomain (string) – The default domain name assigned to the tenant.

  • domains (array) – The list of domain names assigned to the tenant.

Status Codes:

Assign new domains

PUT /api/v1/tenants/(string: tenant_id)/domains/

Assign new domains to the tenant.

Example request:

Authorization Right:minimum Tenant Admin.

Template Actions: this end point is available as template action under the name tenant_assign_domains and group_assign_domains

PUT /api/v1/tenants/foo/domains/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "domains": [
      "netaxis.be"
   ]
}
Request JSON Object:

  • domains (array) – (Required) The list of domain names to assign to the tenant. The domain names must already be defined at system’s level.

Example response:

Response:

Similar to GET instance method response.

Status Codes:

Un-assign existing domains

DELETE /api/v1/tenants/(string: tenant_id)/domains/

Un-assign domains from the tenant.

Example request:

Authorization Right:minimum Tenant Admin.

DELETE /api/v1/tenants/foo/domains/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "domains": [
      "netaxis.be"
   ]
}
Request JSON Object:

  • domains (array) – (Required) The list of domain names to un-assign from the tenant.

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{}
Status Codes: