This page describes how to setup and use the break-glass mechanism for your Canary Console.
For most customers, Break-glass credentials are simply a specific username and password kept in reserve, and can be used to login to the Console when other credentials are lost.
There is one case where this doesn't work. If your Console has SAML SSO enabled, and you have elected to prevent direct logins to your Console, then there is no login page to enter Break-glass credentials. Some customer may want to still have Break-glass capabilities in the event their IdP suffers an outage.
In this (very) specific configuration, we support a separate Break-glass mechanism. This page describes how to configure the mechanism, and how to use it.
Break-glass Links
The mechanism is a Break-glass Link. You will generate and save a special Link. Later on, if you want to access your Console then the Break-glass Link will initiate a process that logs you into your Console. The Break-glass Link is tied to a Global Administrator account; each administrator may create their own Break-glass Link.
Break-glass Links are only available to Global Administrators, who can enable the feature only for their own accounts. They can, however, disable Break-glass links for other Global Administrators.
Prerequisites
Your Console must have SAML enabled, and must disallow direct logins. If either of these are not the case, the Break-glass Link functionality will be absent.
Enabling Break-glass Links
Remember: Break-glass links are only available to Global Administrators, and they can only enable it on their own accounts.
Step 1: Sign in to the Console
Log in to your Console:
Step 2: Open User Management
- Click on the Gear icon at the top right of your Console.
- Select User Management from the dropdown options.
Step 3: Enable the Break-glass Link
In your Profile, you will see a toggle for the Break-glass link. Click on the toggle to enable.
Step 4: Copy and save the Break-glass link
You will be shown a long link.
- Click on the Copy icon on the right of the link.
- Save this link into your password manager.
- Click I've saved it to permanently dismiss the Link from view. You will not be able to retrieve the link later.
Step 5: Test the link
We recommend testing the link to ensure it works as you expect. Follow the section below on "Using the Break-glass Link".
Disabling Break-glass Links
Global Administrators can disable the break-glass link for themselves, or any other Global Administrator.
Step 1: Disable the Break-glass Link
In your Profile, you will see a toggle for the Break-glass link. Click on the toggle to disable.
Step 2: Confirm disabling the Link
Click "Remove Link" to permanently remove the link.
When the Break-glass Link is removed, it is permanently erased. If the setting is later enabled, a new Link will be generated.
Using the Break-glass Link
Break-glass Logins are unusual. If link is used to login, several notifications will be created. An Incident will be recorded, which will trigger alerts in accordance with your notification settings. In addition, all Global Administrators will receive an email. The login is also recorded in the audit log.
Step 1: Retrieve your Break-glass Link from your Password Manager
When you need to make use of the Break-glass Link, retrieve it from your password manager and paste into your browser.
Step 2: Send an sign-in link
On this screen, click Send Emergency sign-in link:
This will trigger an email to be sent to your mailbox, and you will be shown a partially redacted email address of where the mail was sent. You can close the confirmation page.
Step 3: Open your mailbox and find the sign-in mail
The email will have the subject "Canary Console Break-glass Sign-in Link". Click Login to Console.
Step 4: Sign-in to your Console
Click Login as... to access your Console: