Menu AuthGuardHelp centre
Portuguêsauthguard.pt

Distributors and partners · Branding

How branding inheritance works

  • 2 min read
  • SaaS
  • Video
Tutorial 02Put the platform under your brand3:47 · Narrated in Portuguese, with English captions.Transcript and details

Each organization's branding is assembled group by group, from the nearest level that sets that group.

Which groups are there?

Each of these is inherited separately:

  • the palette (the light and dark colours, as a whole);
  • each logo (light and dark);
  • the icon;
  • the sign-in texts of each language;
  • the email settings;
  • the white label;
  • the product name, the approval app name and the sender address, each one separately (field by field);
  • the sign-in hero, field by field: the texts of each language, the typeface and the logo switch.

What is the order?

From strongest to weakest:

  1. The organization itself («This organization's own»).
  2. The parent organization, through an accepted hierarchy («Inherited from the parent organization»).
  3. The distributor that manages it («Inherited from the distributor/partner»).
  4. The platform («Inherited from the platform»).
  5. The default theme.

Removing a group at a level («Back to inherited», «Use the inherited colours», «Use the inherited email settings») falls back to the next level.

Example

The distributor sets the palette and the logos. Customer A sets nothing: it shows everything from the distributor. Customer B uploads only its light logo: it shows its light logo and the rest from the distributor. Customer C writes only a Portuguese hero headline: it shows that headline, and the distributor's typeface and hero logo choice.

How do I check the result?

Each organization's console shows each group's source under «Manage» › «Branding». Technically, GET /v1/branding at the organization's address returns the effective result and, in sources, where each group came from (own, parent, reseller, platform, default); GET /v1/branding?include=hero adds the effective hero with its own sources.

When does it apply?

On every server within about a second (30 seconds at worst). People see the change at their next sign-in, session start or app start; open sessions get no immediate push.

Error codes in this article

Article referenceds-branding-inheritancequote it to support to identify this article. Checked against the product at commit 5f6607a8.