mirror of
https://github.com/bitwarden/help
synced 2025-12-06 00:03:30 +00:00
80a0b17ac6
* jekyll redirect from * Organizations rev (#262) * Organizations revisions initial commit. * API doc updates * Fix absolute link causing build failure. * Add import to org article, and downstream order changes. * Bitwarden 101 videos: 1st steps toward proliferating these throughout /help. * Added 'Create Your Account' article, which references B101 Videos. * About SSO redirect & promote importing for orgs up the list * Create Org FAQs & trim Feature FAQs accordingly. * Image for Org FAQs * Move 'About the Business Portal' to Orgs category, and re-order accordingly. * Final edits. * Dchoi/bootstrap upgrade (#264) * bootstrap 4 upgrade and cleanup update gulp tasks * bootstrap package updates * renaming file convention * general outline of help outline * bitwarden help cleanup * article cleanup * article general styling complete * bootstrap help page upgrades * sidebar updates * Dchoi/bootstrap upgrade (#267) * bootstrap 4 upgrade and cleanup update gulp tasks * bootstrap package updates * renaming file convention * general outline of help outline * bitwarden help cleanup * article cleanup * article general styling complete * bootstrap help page upgrades * sidebar updates * toc dynamic and more updates * fix callout conditions * sidebar collapse functionality added * sidebar header toggle functionality * sidebar article fixes * Update sidebar.html Fix sidebar Release Notes link. * Update releasenotes.md Remove unnecessary category tag. * Delete release-notes.md Remove unnecessary category. * Update why-choose-bitwarden-for-your-team.md Test table image differentiation * Update why-choose-bitwarden-for-your-team.md Second image differentiation test * removed links from category breadcrumb and replaced with badges Co-authored-by: fred_the_tech_writer <69817454+fschillingeriv@users.noreply.github.com>
54 lines
2.5 KiB
Markdown
54 lines
2.5 KiB
Markdown
---
|
|
layout: article
|
|
title: Personal API Key for CLI Authentication
|
|
categories: [miscellaneous]
|
|
featured: false
|
|
popular: false
|
|
tags: [api key, cli]
|
|
---
|
|
|
|
Your Bitwarden Personal API Key can be used as an alternative method for authenticating into the Command Line Interface (CLI).
|
|
|
|
{% callout info %}
|
|
Your Personal API Key is not the same as the API Key used to access the Bitwarden Public API for organization management. Personal API Keys will have a `client_id` with format `"user.clientId"`, while Organization API Keys will have a `client_id` with format `"organization.ClientId"`.
|
|
{% endcallout %}
|
|
|
|
### In This Article
|
|
- [Get your Personal API Key](#get-your-personal-api-key)
|
|
- [Rotate Your API Key](#rotate-your-api-key)
|
|
- [Authenticate using Your API Key](#authenticate-using-your-api-key)
|
|
|
|
## Get Your Personal API Key
|
|
|
|
Complete the following steps to get your Personal API Key:
|
|
|
|
1. Login to your [Web Vault](https://vault.bitwarden.com){:target="_blank"} and select the **Settings** tab.
|
|
2. From the **My Account** screen, scroll down to the **API Key** section.
|
|
3. Select the **View API Key** button will prompt you to enter your Master Password.
|
|
|
|
Once correctly entered, you will be provided the following:
|
|
- `client_id: "user.clientId"` (This value is unique to your account and does not change.)
|
|
- `client_secret: "clientSecret"` (This value is unique and can be rotated.)
|
|
- `scope: "api"` (This value will always be `"api"`.)
|
|
- `grant_type: "client_credentials"` (This value will always be `"client_credentials"`.)
|
|
|
|
### Rotate Your API Key
|
|
|
|
Select the **Rotate API Key** button to rotate your personal API Key. Rotating your Key will only change your `client_secret`.
|
|
|
|
Rotating your key will invalidate your previous key and all active sessions using that key.
|
|
|
|
## Authenticate using your API Key
|
|
|
|
To use your API Key to authenticate into the CLI, enter the following command:
|
|
```
|
|
bw login --apiKey
|
|
```
|
|
which will prompt you to enter the obtained `client_id` and `client_secret` to authenticate. Once you enter these values, enter your Master Password to decrypt your Vault. For more information, see [Bitwarden command line tool (CLI)](https://bitwarden.com/help/article/cli/).
|
|
|
|
### Environment Variables
|
|
|
|
The Bitwarden CLI will look for non-empty environment variables `BW_CLIENTID` or `BW_CLIENTSECRET`. Save these environment variables with your `client_id` and `client_secret` to prevent Bitwarden from prompting you every time.
|
|
|
|
You will still need to enter your Master Password to decrypt your Vault.
|