Preconfigured Installs: Overview

ℹ️

Audience: account administrators.

A preconfigured install ships your organization's sign-in settings with the extension, so your users open it to a login screen that is already correct — right method, right Access ID, right region, right branding.

One destination, four paths

Every path writes to the same place: a browser-storage record named akeyless_installation_preferences. The login screen reads it every time it opens.

PathUse whenPage
Bridge linkYou can send users a linkBridge Link Install
Store URL parametersYou link to the store from a portalBridge Link Install
Cookiebridge URLYou use the hosted bridge serviceBridge Link Install
Preconfigured packageYou distribute the extension yourselfPreconfigured Package
⚠️

Know which path you used before troubleshooting. The bridge link expires after 10 minutes; the package applies on first install only. The symptoms look identical, the causes are not.

The preconfigured fields

FieldEffect
preferredAuthMethodWhich method the login screen opens on: alias, saml, oidc, google, github, access-id, email
allowedAuthMethodsRestricts the picker to these methods
prefillAccessIdPre-fills the Access ID field
prefillAliasPre-fills the field when the method is Alias
environmentRegion for email sign-in: global, us, eu, wmt, dbk, cvs
config_idID of a stored branding bundle
contactSupportUrlDestination of Contact Support
privacyPolicyUrlDestination of Privacy Policy
openWebConsoleUrlDestination of Open Web Console
passkeyEnabledInitial state of Passkey Management
preconfiguredSignInTitleHeading of the login info box. Default "Ready to Sign In". Max 120 characters
preconfiguredSignInMessageBody of that box. Blank lines separate paragraphs. Max 2000 characters
installationSourceRecords which path delivered the settings

Branding fields may accompany them: sidebarBgColor, buttonColor, mainBgColor, iconColor, loadingColor, logoUrl, brandFolder. See Branding & Customization.

What your users will see

ConfigurationLogin screen
One allowed method, not emailNo auth picker, no Access ID field. Your title and message, and a single sign-in button. Powered by Akeyless at the bottom
One allowed method, emailEmail, password and 2FA only — no auth picker, no region picker
Several allowed methodsPicker limited to those methods, opened on the preferred one, Access ID pre-filled

Defaults

If you set no support or privacy URL, the extension uses:

  • https://www.akeyless.io/contact-support/
  • https://www.akeyless.com/privacy-policy/

Related


Did this page help you?
Footer Section