Settings

PreviousStatus NextUnjoin

Last updated 22 days ago

Was this helpful?

Generate Hash

post

Updates the specified site's default tenant broker settings with a new secret hash key.

Query parameters

SiteIdinteger · int32optional

Site Id

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/TenantBrokerSettings/GenerateHash'

200

401

404

text

Get

get

Retrieves the Tenant Broker Settings.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/TenantBrokerSettings'

200

401

404

{
  "brokerAddress": "text",
  "hideBillingInfo": true,
  "overrideAddress": true,
  "tenantBrokerSecretKey": "text",
  "tenantDomain": "text",
  "allowRegistrationWithSecretKey": true
}

Update

put

Modify the Tenant Broker Settings. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.

Query parameters

siteIdinteger · int32optional

Site Id

Body

brokerAddressstring | nullableoptional

IP Address to be used when registering a tenant, when the OverrideAddress is set.

hideBillingInfoboolean | nullableoptional

When set, billing information is not provided in the Licensing category of Tenants joined with secret keys.

overrideAddressboolean | nullableoptional

Override Tenant Broker address in tenant invitations and secret keys.

tenantDomainstring | nullableoptional

Public domain address used to register the tenants. If you want to register tenants as subdomains, specify the domain part of the host name. For example, to use "subdomain.domain.com" as a tenant hosts name, specify "domain.com".

allowRegistrationWithSecretKeyboolean | nullableoptional

Allow RAS Sites to register in Tenant Broker using a secret key.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/TenantBrokerSettings' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "brokerAddress": "text",
    "hideBillingInfo": true,
    "overrideAddress": true,
    "tenantDomain": "text",
    "allowRegistrationWithSecretKey": true
  }'

204

401

404

No body

No Content