Embedded components overview
SecureAuth Connect embedded components are custom HTML elements that render account self-service inside your own application: a person's profile, the methods they sign in with, the sessions they have open, and the applications that hold access to their account. You load one JavaScript module from your deployment, place an element in your markup, and the element renders as part of your page.
For developers integrating a web application, and for administrators who decide what those elements show.
What you get
Four panes, and one composite element that carries its own navigation between them.
| Element | Renders |
|---|---|
sa-self-service | All of the panes below, with its own tab navigation. |
sa-self-service-profile | Personal details, contact details, and preferred language. |
sa-self-service-security | Sign-in methods and open sessions. |
sa-self-service-privacy | Applications with access to the account, and the ability to revoke it. |
sa-self-service-applications | The applications available to the person. |
Mount the composite for a single account page, or the panes on their own when your product already has somewhere for each one to live.
Embedded or hosted
SecureAuth also hosts these panes for you, at the end user portal. The portal needs no integration work and lives on a SecureAuth URL. Embedded components live on yours, inside your own navigation, with your own colors. The two render the same data, so the choice is about where the person is when they manage their account.
Use embedded components when leaving your product to manage an account would be a visible seam, or when account settings belong next to your own settings rather than beside them.
How it fits together
- An element is a custom HTML tag you place in your markup.
- A variant is a named set of choices (which sections an element renders, and how it looks) saved in your workspace. You build variants under Embedded components in the admin console.
- A client application is bound to one variant on its Embed tab, which also lists the scopes its access token has to carry and writes the code to paste.
Your application owns authentication. The element never runs a sign-in flow, never reads your page's storage, and never holds a token of its own: it calls a function you supply whenever it needs one. See Authentication and tokens.
What the elements do not do
They render content, and no chrome. There is no page heading, no shell, no navigation around the pane, and no modal or drawer. Your application supplies all of that, which is what lets the element sit in a layout you already have. See Layout and events.
Browser support
The elements run in current versions of Chrome, Edge, Firefox, and Safari, on desktop and mobile. They need native ES modules, custom elements, and shadow DOM, and the bundle ships no polyfills. Internet Explorer and the legacy, pre-Chromium Edge cannot load them.
Availability
Embedded components are available on every deployment. Two things decide what you can reach:
- Embedded components under Extensions in the admin console needs the
read_embed_variantspermission on the workspace. It is where you create and style the variants the elements render. - The Embed tab on an application appears on any client that can carry a signed-in user's access token: a client with a user-facing application type that is not a SAML registration.
The integration is a plain ES module served by your deployment at /embed/v1/. There is no
npm package to install and no bundler plugin to configure.