Branding
The login your users see, in the modal on your page and on the hosted page alike, carries your app’s name and look. Both come from SeekAuth, not from your code: change them on the Appearance page of the dashboard and every app picks them up, with no deploy.
The theme
Section titled “The theme”A theme is a small JSON object. Every key is optional:
| Key | Values |
|---|---|
colors.primary |
The accent: buttons, links, focus. A hex colour: #rgb, #rrggbb or #rrggbbaa. |
colors.background |
The login’s background, hex. |
colors.text |
The text colour, hex. |
radius |
Corner rounding: none, sm, md, lg or full. |
font |
A font family name: letters, digits, spaces, - and _, up to 60 characters. |
logo_url |
Your logo, an https URL of up to 500 characters. |
copy.title, copy.subtitle |
The login’s heading and the line under it, up to 140 characters each. They are read as names are: a line that passes for one of SeekAuth’s own products (“Log in to Seek”, “Welcome to LinkPay”) is refused with 400 name_not_allowed. “Welcome back” and your own name are fine. |
{ "colors": { "primary": "#0EA5E9" }, "radius": "lg", "font": "Inter", "logo_url": "https://cdn.your-app.com/logo.svg", "copy": { "title": "Welcome back" }}Colours are stored in lowercase (#0ea5e9). Any other key, or a value outside these rules, is refused with 400 and a message that starts theme:, such as theme: radius is none, sm, md, lg or full.
The login follows the light or dark scheme of the device it is shown on.
For an environment, or for one app
Section titled “For an environment, or for one app”A theme can be set at two levels:
-
The environment’s theme applies to every app of the group that has none of its own.
PUT/v1/environments/:id/appearancedeveloperThe body is the theme itself, and replaces the one stored.
-
An app’s own theme replaces the environment’s for that app, as a whole, when it is not empty.
PUT/v1/environments/:id/apps/:app/settingsdeveloper{ "theme": { "colors": { "primary": "#16a34a" } } }GETon the same path answers the app’s settings witheffective_theme, the theme its login actually shows.
Development and production each have their own themes, so a new look can be tried in development first. See Environments in the management API.
Your app’s name
Section titled “Your app’s name”Users see the name of the app they are logging in to: on the login, in “Continue to …?” questions, and in the emails a login causes (codes, notices of a new device). Each app of a group speaks for itself, so users of your storefront never see your other products’ names. Where no single app is in hand, such as the label of an authenticator app and the emails about changes made in account settings, the group’s name is used.
Change an app’s name in the app’s Settings (PATCH /v1/apps/:id); see Apps and groups.
An app can ask its users to accept its terms: set terms_url (an https URL) in the app’s settings, and the login shows a link to them and asks once per user. See Sign-ups and access.