Powered by Redocly

Assigned Site Settings

A tenant has a set of assigned site settings, which is controlled by the tenant's parent tenant.

The tenant's parent tenant can configure the settings to an assigned site by creating and editing resources in /config/tenants/<tenant-name>/assigned-sites/<site-name>/settings.

Update the assigned site settings

SecurityaccessToken
Request
path Parameters
assigned-site-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of assigned-site

query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Request Body schema:
resource-profile
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

patch/v1/config/assigned-sites/{assigned-site-name}/settings
Request samples 
resource-profile: appowner-profile

Delete the assigned site settings

SecurityaccessToken
Request
path Parameters
assigned-site-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of assigned-site

query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

delete/v1/config/assigned-sites/{assigned-site-name}/settings

Replace or create the assigned site settings

SecurityaccessToken
Request
path Parameters
assigned-site-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of assigned-site

query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Request Body schema:
resource-profile
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$
Responses
201

Created

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

put/v1/config/assigned-sites/{assigned-site-name}/settings
Request samples 
resource-profile: appowner-profile

Retrieve the configuration of assigned site settings

SecurityaccessToken
Request
path Parameters
assigned-site-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of assigned-site

query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Responses
200

OK

304

Not Modified

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

get/v1/config/assigned-sites/{assigned-site-name}/settings
Response samples 
resource-profile: appowner-profile

Retrieve the the state of assigned site settings

SecurityaccessToken
Request
path Parameters
assigned-site-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of assigned-site

query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

site
string

Send the request to the specfifed site

content
string <enumeration>

Filter descendant nodes in the response

Enum: "config" "nonconfig"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/assigned-sites/{assigned-site-name}/settings
Response samples 
resource-profile: appowner-profile
➔ Next to Assigned Sites