Get Page Branding

get

https://{application_vanity_domain}/api/v1/page-brandings/{pageBrandingId}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Retrieves the specified page branding.

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 read all page brandings for the application to which the subject belongs.
	Tenant	The subject can read all page brandings associated with the tenant to which the subject belongs.
	Tenant Inclusion List	The subject can read all page brandings associated with tenants specified in the tenant inclusion list.
	Tenant Exclusion List	The subject can read all page brandings associated with tenants in the subject's application that are not on the tenant exclusion list.

Path Params

pageBrandingId

string

required

length between 1 and 26

The ID of the page branding

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.

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.

Headers

If-None-Match

string

length ≥ 0

Used to perform a conditional get of the resource

Responses

Required Permissions

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

405Method Not Allowed

406Not Acceptable

500Internal Server Error

503Service Unavailable