Resolve Tenant Page Branding Overrides

post

https://{application_vanity_domain}/api/v1/tenants/{tenantId}/page-brandings/resolve-overrides

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Resolves the page branding overrides at the tenant level. Page brandings support default values; therefore, if tenant-level overrides are enabled and no overrides are defined at the tenant level, this API will return the defaults instead.

Required Permissions

Below is the list of required permissions needed to interact with this API. For each permission, the allowed permission boundaries are also specified.

Permission	Boundary	Description
page-branding:read	Application	The subject can perform this request if the tenant specified in the URL path is associated with the subject's application.
	Tenant	The subject can perform this request if they are associated with the tenant specified in the URL path.
	Tenant Inclusion List	The subject can perform this request if the tenant specified in the URL path is included in the tenant inclusion list.
	Tenant Exclusion List	The subject can perform this request if the tenant specified in the URL path belongs to the subject's associated application and is not included in the tenant exclusion list.

Path Params

tenantId

string

required

length between 1 and 26

The ID of the tenant that the resource or action is scoped to.

Query Params

fields

string

length ≥ 0

Defaults to *

List of resource fields that should be returned in a response. The wildcard value of * can be used to return all fields for the resource.

recurse_ancestors

boolean

Defaults to true

Boolean indicating if the resolve API should recurse the tenant's ancestors for the case where tenant level overrides are disabled. If set to "false", then this API will only resolve the overrides for the tenant level regardless of whether tenant level overrides are enabled or not.

application_login_page_branding_fields

string

length ≥ 0

Comma separated list specifying which fields should be returned in the application loging page branding object. A wildcard * value can be used to include all fields. By default, no fields will be included.

application_signup_page_branding_fields

string

length ≥ 0

Comma separated list specifying which fields should be returned in the application signup page branding object. A wildcard * value can be used to include all fields. By default, no fields will be included.

tenant_login_page_branding_fields

string

length ≥ 0

Comma separated list specifying which fields should be returned in the tenant login page branding object. A wildcard * value can be used to include all fields. By default, no fields will be included.

tenant_signup_page_branding_fields

string

length ≥ 0

Comma separated list specifying which fields should be returned in the tenant signup page branding object. A wildcard * value can be used to include all fields. By default, no fields will be included.

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Required Permissions

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

405Method Not Allowed

406Not Acceptable

500Internal Server Error

503Service Unavailable