Welcome to the Dashlane Custom Security Dashboard Documentation. After releasing the Dashlane Public API, we released this sample application and guide for learning and demonstration purposes. This serves as a basic introduction to using the Dashlane Public API read-only endpoints to access valuable insights related to your Dashlane team account, its members and their devices.
We’ve built a simple React application that creates a configurable security dashboard. This dashboard can be expanded to include other metrics, creating a custom dashboard so you can monitor in real time and quickly respond to credential-based risks.
-
Clone the repository
Clone this repository and download it on to your machine. -
Generate an API Key
To communicate with our API, you’ll need an access key. Navigate to the Dashlane Admin Console > Integrations > Public API. Select “Create Key.” Give the key a description. Make sure you copy and save the bearer token in a secure place. You will not be able to access it again. -
Install the dependencies
Go to your preferred console and run:npm install
-
Run the dashboard
From your console, navigate to the project folder, and run:REACT_APP_DASHLANE_API_KEY="<DASHLANE BEARER TOKEN>" npm startA new browser window will open with your company’s custom security dashboard.
Currently, the dashboard retrieves information from the four available endpoints.
It shows user information, including password health metrics and the user’s registered devices, available from the Devices endpoint.
In addition, the dashboard shows historical and current Password Health scores, as well as the number of weak, compromised, reused, and safe passwords, available from the Password Health endpoint.
Lastly, it shows company information such as available seats and pending invitations.
Want to add more to your dashboard? The Dashlane Public API currently offers four endpoints that you can use to extend and add value to your dashboards or custom solutions.
Dashlane provides an OpenAPI 3.0 specification to help you explore and utilize the Public API.
- Download the specification here.
- Alternatively, use the Documentation UI for a user-friendly interface to explore the available endpoints.
We welcome contributions to this project! If you have ideas or enhancements, feel free to fork the repository and submit a pull request. Please ensure that any contributions are either open source or your original work.