1. Docs
  2. Authentication
  3. Brand the Hosted Pages and the Portal

Brand the Hosted Pages and the Portal

Set a product name, logo, favicon, primary and background colors, and support, terms and privacy links per Environment in the Developer Console. Every hosted sign-in page, the organization admin portal, and the emails your users receive wear them; each field stands on its own.

Set an Environment's brand

In the Developer Console, Tenant → Branding lists one row per Environment across every Application. What you set here shows on the hosted sign-in, sign-up, MFA, password-reset, invitation, and security pages, and in the organization admin portal, so a user of your product never sees another name.

Application
Developer Console
Path
TenantBranding
Opens with
  • env_branding.view Read every Environment's branding: product name, logo, primary color, and support link.
Context
Account-wide. No Application or Environment selection applies.
Set an Environment's brand
Open Branding from the left nav under Tenant. Each row shows the Environment's Product name, whether a Logo is set, its Color, and whether the Attribution mark shows. Expand a row.Enter a Product name of up to 60 characters. It shows in the browser tab, beside an icon logo, and in place of a logo when none is set. Add a Logo URL, an https image shown above the heading, and a Favicon URL, a square https PNG or ICO for the browser tab.Under Logo shows as, say what the logo image is. A Full logo already carries your name, so it stands alone. An Icon beside the product name is a square mark: the pages show it at icon size with the product name next to it.Enter a Primary color as a 6-digit hex such as #0066cc; it drives every button and link, and Canopy derives the hover, link and focus shades from it so each stays readable. The social sign-in buttons stay neutral, each with its provider's own mark. Enter a Background color for the page behind the sign-in card; the card stays white and the footer text adjusts to stay readable on it.Enter a Support link, an https page or a mailto: address shown as Need help?, and Terms link and Privacy link pages shown as Terms and Privacy under every hosted page. Click Save changes; Discard drops an unsaved edit.Clear a field and save to remove it. The others keep what you set: a name without a color, or a color without a logo, is a complete brand. With no product name the pages show no name at all; with no colors they use the default blue on a neutral grey.

Emails to your users

Every email Canopy sends to your users wears the same brand: sign-in and verification codes, password resets, invitations, and security notices. They name your product and never Canopy.

Emails to your users
The email comes from your Product name, or the Application's name when none is set, and carries it in the header and footer.The button and links take your Primary color, and the area behind the email your Background color. Terms and Privacy sit in the footer, and a Support link page shows as Need help?.When the Support link is a mailto: address, replies to the email go to it and the footer invites them. Otherwise replies go nowhere.The logo shows only when it is a PNG, JPG or GIF, because Gmail and Outlook cannot display SVG and Outlook cannot display WebP. Canopy checks the image itself, not its address, and checks it again at least once per hour. With any other format the email shows the product name instead, as it does with no logo.

The attribution mark

A small Canopy mark shows in the footer of every hosted page, and the line Secured by Canopy at the foot of every email. Removing them is part of the Starter, Pro and Enterprise plans, not a setting: the row's Attribution column and the note in the expanded panel say which applies to your Account.

The attribution mark
On a plan without brand removal the mark and the line stay, whatever else you set; the panel's note says so.On a plan with brand removal both are gone and the note confirms it. Nothing on the hosted pages or in the emails then names Canopy.

Read it from your own app

A client rendering its own sign-in screens can wear the same brand: GET /v1/identity/auth/config returns a branding object with every field above and the attribution flag, the default primary color filled in. The same values are readable and changeable with an API key at /api/v1/branding: a scoped key needs branding.view to read and branding.manage to change.

Read it from your own app
Call GET /v1/identity/auth/config?publishable_key=… at boot and read branding.To change the brand from your own tooling, PATCH /api/v1/branding with any of product_name, logo_url, logo_kind (full or icon), favicon_url, primary_color, background_color, support_url, terms_url and privacy_url; send null to clear a field.
If you don't see this

Each control on this page exists only for someone who may use it. When something described above is missing, one of these is why:

Branding is not in the left nav. Your administrator role does not carry env_branding.view.The rows show but every field is disabled, with a notice explaining why. You hold env_branding.view but not env_branding.manage; the page is your read view of the brand.The attribution line is still there after you branded everything. Removing it is part of the Starter, Pro and Enterprise plans; the expanded panel's note says which applies.
Configure sign-in, MFA, and self-signup → Hosted login →
Environment
API version
v1.0
 On this page Was this page helpful?

Tell us how we can improve this guide.

Canopy