Join

Joins a Tenant Broker.

POST/api/TenantBroker/Join

Query parameters

siteIdinteger (int32)

Site ID from which to retrieve the Tenant Broker settings (optional).

Body

TenantBroker settings

hashKey*nullable string

This can be the Tenant Broker secret key located at Farm | Settings | Tenant Broker, or the Tenant invitation hash created at Farm | Tenants | Add.

tenantBrokernullable string

The IP or DNS address of the Tenant Broker to join.

tenantNamenullable string

The Tenant name. Applicable only if Farms are allowed to register using a secret key.

publicDomainAddressesnullable string

The accessible name. Applicable only if Farms are allowed to register using a secret key.

Response

No Content

Request

Response

Join

Joins a Tenant Broker.

POST/api/TenantBroker/Join

Query parameters

siteIdinteger (int32)

Site ID from which to retrieve the Tenant Broker settings (optional).

Body

TenantBroker settings

hashKey*nullable string

This can be the Tenant Broker secret key located at Farm | Settings | Tenant Broker, or the Tenant invitation hash created at Farm | Tenants | Add.

tenantBrokernullable string

The IP or DNS address of the Tenant Broker to join.

tenantNamenullable string

The Tenant name. Applicable only if Farms are allowed to register using a secret key.

publicDomainAddressesnullable string

The accessible name. Applicable only if Farms are allowed to register using a secret key.

Response

No Content

Request

Response

const response = await fetch('/api/TenantBroker/Join', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "hashKey": "text"
    }),
});
const data = await response.json();

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}