https://github.com/dashlane/public-api-documentation
Public API OpenAPI Documentation
https://github.com/dashlane/public-api-documentation
api dashlane documentation
Last synced: 4 months ago
JSON representation
Public API OpenAPI Documentation
- Host: GitHub
- URL: https://github.com/dashlane/public-api-documentation
- Owner: Dashlane
- License: apache-2.0
- Created: 2024-11-22T13:09:33.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-04T16:38:10.000Z (over 1 year ago)
- Last Synced: 2025-06-05T03:58:47.363Z (about 1 year ago)
- Topics: api, dashlane, documentation
- Language: HTML
- Homepage: https://dashlane.github.io/public-api-documentation/
- Size: 11.7 KB
- Stars: 2
- Watchers: 7
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dashlane Public API Documentation
Welcome to the **Dashlane Public API Documentation**.
This guide is designed for developers looking to integrate Dashlane into their applications.
The Dashlane Public API provides **read-only** access to valuable insights and functionalities related
to your Dashlane team account, its members and their devices.
### Key Features
With the Dashlane Public API, you can:
- Retrieve real-time team data, including roles, statuses, and usage metrics.
- Automate administrative tasks to boost operational efficiency.
- Analyze password health to identify weak, reused, or compromised credentials.
- Monitor historical trends to strengthen organizational cybersecurity.
- Develop custom solutions tailored to your workflows and integrate seamlessly with your existing systems.
---
## Getting Started
To access the Dashlane Public API endpoints, you'll need an API key. This key can be generated in two ways: directly through the [Dashlane Admin Console](https://support.dashlane.com/hc/en-us/articles/23955544757266-Dashlane-public-API) or the Dashlane CLI.
Follow these steps to use the CLI:
1. **Install the Dashlane CLI**
Download and [install the Dashlane CLI](https://cli.dashlane.com/install) on your machine.
2. **Log in to Your Dashlane Account**
[Authenticate using the Dashlane CLI](https://cli.dashlane.com/personal/authentication) as a team administrator.
3. **Generate an API Key**
Use the Dashlane CLI to create an API key:
```bash
dcli team public-api create-key "Description of the key"
```
The generated API key will follow this format:
`Bearer DLP_teamUuid_accessKey_secretKey`
**Important:** Store your API key securely as it will only be displayed once.
> ![NOTE]
> Use the `DLP` prefix to identify and scan API keys in your codebase and prevent leaking this secret.
4. **Authenticate Your Requests**
Add the API key to the `Authorization` header of your requests, as shown below:
```bash
curl -X POST \
'https://api.dashlane.com/public/teams/Members' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer DLP_teamUuid_accessKey_secretKey' \
-d '{ }'
```
---
## API Reference
Dashlane provides an **OpenAPI 3.0 specification** to help you explore and utilize the Public API.
- Download the specification [here](https://get.dashlane.com/public-api/openapi.json).
- Alternatively, use the [Documentation UI](https://dashlane.github.io/public-api-documentation/) for a user-friendly interface to explore the available endpoints.
---
## Managing API Keys
You can manage your API keys from the [Dashlane Admin Console](https://support.dashlane.com/hc/en-us/articles/23955544757266-Dashlane-public-API) or from the Dashlane CLI:
- **List All API Keys:**
```bash
dcli team public-api list-keys
```
- **Revoke an API Key:**
```bash
dcli team public-api revoke-key
```
---
## Contributing
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.