Subtenant UI Customization

Update the ui customization

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

name of tenant

query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Request Body schema:
image (object) or url (object) or none (object)

The favicon for the web pages.

image (object) or url (object) or none (object)

The logo image is displayed on the splash screen, login page, and at the top of the left main menu.

text (object) or none (object)

The title text is displayed under the icon on the login page and in the main menu.

image (object) or url (object) or none (object)

The decoration image is displayed on the login page, and at the bottom of the left main menu.

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/tenants/{tenant-name}/meta/ui-customization
Request samples
favicon:
  url: https://example.com/favicon.png
logo:
  url: https://example.com/logo.png
title:
  text: Production
decoration:
  none: true

Delete the ui customization

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

name of tenant

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/tenants/{tenant-name}/meta/ui-customization

Replace or create the ui customization

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

name of tenant

query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Request Body schema:
image (object) or url (object) or none (object)

The favicon for the web pages.

image (object) or url (object) or none (object)

The logo image is displayed on the splash screen, login page, and at the top of the left main menu.

text (object) or none (object)

The title text is displayed under the icon on the login page and in the main menu.

image (object) or url (object) or none (object)

The decoration image is displayed on the login page, and at the bottom of the left main menu.

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/tenants/{tenant-name}/meta/ui-customization
Request samples
favicon:
  url: https://example.com/favicon.png
logo:
  url: https://example.com/logo.png
title:
  text: Production
decoration:
  none: true

Retrieve the configuration of ui customization

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

name of tenant

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/tenants/{tenant-name}/meta/ui-customization
Response samples
favicon:
  url: https://example.com/favicon.png
logo:
  url: https://example.com/logo.png
title:
  text: Production
decoration:
  none: true

Retrieve the the state of ui customization

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

name of tenant

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/tenants/{tenant-name}/meta/ui-customization
Response samples
favicon:
  url: https://example.com/favicon.png
logo:
  url: https://example.com/logo.png
title:
  text: Production
decoration:
  none: true