1. Docs
  2. Authentication
  3. Brand the hosted pages and the portal

Brand the hosted pages and the portal

Set a product name, logo, primary color, and support link per Environment in the Developer Console. Every hosted sign-in page and the organization admin portal wear them; each field you leave empty uses Canopy's default 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 effective Product name, whether a Logo is set, its Color, and whether the Attribution line shows. Expand a row.Enter a Product name of up to 60 characters; it replaces Canopy in page titles and headings. Enter a Primary color as a six-digit hex such as #0066cc; it drives every button and link.Enter a Logo URL, an https image shown above the heading, and a Support link, an https page or a mailto: address your users can reach for help. Click Save changes; Discard drops an unsaved edit.Clear a field and save to return that one field to Canopy's default. The others keep what you set: a name without a color, or a color without a logo, is a complete brand.

The attribution line

Under every hosted page a small Secured by Canopy line shows. Removing it is part of the Pro plan, not a setting: the row's Attribution column and the note in the expanded panel say which applies to your Account.

The attribution line
On a plan without brand removal the line stays, whatever else you set; the panel's note says so.On a plan with brand removal the line is gone from every page and the note confirms it. Nothing on the hosted pages 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 the effective product name, logo, color, support link, and attribution flag, defaults filled in. The same values are readable and changeable with an API key at /api/v1/branding.

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, primary_color, and support_url; send null to return a field to the default.
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 Pro plan; 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