Settings

Get

get

Retrieves the Tenant Broker Settings.

Responses
200
OK
application/json; api-version=1.0
get
GET /api/TenantBrokerSettings HTTP/1.1
Host: 
Accept: */*
{
  "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

Updates the Tenant Broker settings

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
204
No Content
put
PUT /api/TenantBrokerSettings HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 130

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

No content

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
200
OK
application/json; api-version=1.0
Responsestring
post
POST /api/TenantBrokerSettings/GenerateHash HTTP/1.1
Host: 
Accept: */*
text

Last updated

Was this helpful?