bitwarden/help
1
0
Fork 0
mirror of https://github.com/bitwarden/help synced 2025-12-06 00:03:30 +00:00
Code Issues Releases Wiki Activity

2021-08-18 Release Documentation (#708)

Browse Source 
* Stage Providers (#691)

* initial provider drafts

* fix build errors

* image overlays & alt-text

* capitalize title

* update /about-collections/ for providers

* update /about-groups/ for provider users

* updating 'sharing' for provider users

* update /managing-users/ for provider users

* provider - create org permissions fixes

* update create org permissions

* about-orgs compare to providers

* temp remove pricing FAQ item

* Update Staging w/ Latest (#695)

* initial provider drafts

* fix build errors

* image overlays & alt-text

* capitalize title

* update /about-collections/ for providers

* update /about-groups/ for provider users

* updating 'sharing' for provider users

* update /managing-users/ for provider users

* provider - create org permissions fixes

* update create org permissions

* about-orgs compare to providers

* temp remove pricing FAQ item

* updates from cscharf & gtran review

* updates from cscharf & gtran review

* Update Staging w/ Latest Again (#696)

* initial provider drafts

* fix build errors

* image overlays & alt-text

* capitalize title

* update /about-collections/ for providers

* update /about-groups/ for provider users

* updating 'sharing' for provider users

* update /managing-users/ for provider users

* provider - create org permissions fixes

* update create org permissions

* about-orgs compare to providers

* temp remove pricing FAQ item

* updates from cscharf & gtran review

* updates from cscharf & gtran review

* updates

* Update Staging w/ Latest (#697)

* initial provider drafts

* fix build errors

* image overlays & alt-text

* capitalize title

* update /about-collections/ for providers

* update /about-groups/ for provider users

* updating 'sharing' for provider users

* update /managing-users/ for provider users

* provider - create org permissions fixes

* update create org permissions

* about-orgs compare to providers

* temp remove pricing FAQ item

* updates from cscharf & gtran review

* updates from cscharf & gtran review

* updates

* note on freeing up user seat

* Update Staging w/ APR v1.0 (#698)

* Update to Automatic Enrollment option

* update for 'force change on login', image outstanding

* reset via email updates, images outstanding

* pre-release updates to admin pw reset

* Update Staging w/ Latest (#699)

* initial provider drafts

* fix build errors

* image overlays & alt-text

* capitalize title

* update /about-collections/ for providers

* update /about-groups/ for provider users

* updating 'sharing' for provider users

* update /managing-users/ for provider users

* provider - create org permissions fixes

* update create org permissions

* about-orgs compare to providers

* temp remove pricing FAQ item

* updates from cscharf & gtran review

* updates from cscharf & gtran review

* updates

* note on freeing up user seat

* Updates from recent product changes
- title-cased buttons
- access vault event

+ diagram in /article/providers/

* resolve conflict

* Updating Staging w/ Latest (#701)

* Update "share" -> "move"

* resolve conflict

* update /sharing/ refs

* Update Staging w/ Latest (#702)

* Bad link due to typo (#692)

* release notes inital

* update release notes and index.html to surface admin pw reset in popular articles

Co-authored-by: Daniel Pedigo <dpedigo@gmail.com>

* update diagram

* additional FAQ items, edits from Gina, suggestion to provision 2nd Provider Admin

* update CTA for signup

* cli auth challenge draft (#706)

* Update CLI doc for captcha error, rollback policies article

* rollback pw reset article

* rollback release notes

* update move/share screenshots in provider content

* update releasenotes date

* faqs & feedback from rluibrand

* redirect

* resolve conflicts 1/3

* resolve conflicts 2/3

* test resolution for conflict

* test resolution for conflict

* hide deprecated articles & update links

Co-authored-by: Daniel Pedigo <dpedigo@gmail.com>
This commit is contained in:
fred_the_tech_writer
2021-08-18 13:50:15 -04:00
committed by GitHub
parent b5c2c8e600
commit 25bc445da1
67 changed files with 734 additions and 159 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
_articles/miscellaneous/cli-auth-challenges.md Normal file
View File

@@ -0,0 +1,55 @@
---
layout: article
title: CLI Authentication Challenges
categories: [miscellaneous]
featured: false
popular: false
tags: [cli, captcha]
---
The August 2021 release of Bitwarden (**2021-08-18**) introduced [Captcha](https://www.hcaptcha.com/about){:target="\_blank"} requirements to increase security against bot traffic. On the CLI, Captcha challenges are substituted with authentication challenges that can validated using your account's [Personal API Key]({{site.baseurl}}/article/personal-api-key) `client_secret`.
## Get your Personal API Key
To get your Personal API Key:
1. Log in to the [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 and enter your Master Password to validate access.
4. From the **API Key** dialog box, copy the **client_secret:** value, which is a random string like `efrbgT9C6BogEfXi5pZc48XyJjfpR`.
## Answering Challenges
Depending on your preferences, you can [save an environment variable](#answer-challenges-with-an-environment-variable) to automatically pass authentication challenges or [manually enter](#using-the-prompt) your `client_secret` whenever a challenge is made:
{% callout success %}
Aside from using environment variable, any possible challenge is automatically bypassed when using the `bw login --apikey` method. [Learn more]({{site.baseurl}}/article/cli/#using-an-api-key).
{% endcallout %}
### Answer Challenges with an Environment Variable
Authentication challenges will look for a non-empty environment variables `BW_CLIENTSECRET` before prompting you to enter one manually. Saving this variable with the [retrieved client_secret value](#get-your-personal-api-key) will allow you to automatically pass authentication challenges. To save this environment variable:
{% icon fa-linux %} {% icon fa-apple %} Bash
```
export BW_CLIENTSECRET="client_secret"
```
{% icon fa-windows %} PowerShell
```
env:BW_CLIENTSECRET="client_secret"
```
{% callout warning %}
If your `client_secret` is incorrect, you will receive an error. In most cases, this is because you have [rotated your API Key]({{site.baseurl}}/article/personal-api-key/#rotate-your-api-key) since saving the variable. [Use the above steps](#get-your-personal-api-key) to retrieve the correct value.
{% endcallout %}
### Answer Challenges Manually
When an authentication challenge is made and no `BW_CLIENTSECRET` value is found, you will be prompted to manually enter your `client_secret` value:
{% image cli/cli-captcha-1-markup.png Login Prompt with Auth Challenge %}
{% callout warning %}
If your `client_secret` is incorrect, you will receive an error. In most cases, this is because you have [rotated your API Key]({{site.baseurl}}/article/personal-api-key/#rotate-your-api-key) since saving the variable. [Use the above steps](#get-your-personal-api-key) to retrieve the correct value.
{% endcallout %}

20
_articles/miscellaneous/cli.md
View File

@@ -21,7 +21,7 @@ Or, pass `--help` as an option on any `bw` command to see available options and
```
bw list --help
bw share --help
bw move --help
```
Most information you'll need can be accessed using `--help`, however this article replicates all that information and goes into greater depth on some topics.
@@ -157,6 +157,10 @@ See [Appendices &rarr; Enums](#enums) for `<method>` values.
### Using an API key
{% callout success %}
**Getting prompted for additional authentication** or getting a `Your authentication request appears to be coming from a bot.` error? Use your API Key `client_secret` to answer the authentication challenge. [Learn more]({{site.baseurl}}/article/cli-auth-challenges/).
{% endcallout %}
Logging in with a [Personal API Key]({{site.baseurl}}/article/personal-api-key/) authenticates you with Bitwarden servers, syncs your Vault, but **does not unlock your Vault**. After logging in with an API key, you will be required to unlock your Vault using your Master Password. To log in with an API key use:
```
@@ -479,18 +483,22 @@ bw list org-collections --organizationid 4016326f-98b6-42ff-b9fc-ac63014988f5
You can `bw list` both `collections` and `org-collections`. `bw list collections` will list *all* Collections, agnostic of which Organization they belong to. `bw list org-collections` will list *only* Collections that belong to the Organization specified using `--organizationid`.
{% endcallout %}
### share
### move
The `share` command transfers a Vault item [to an Organization]({{site.baseurl}}/article/share-to-a-collection/):
{% callout info %}
**August 2021**: The `share` command has been changed to `move`. [Find out more]({{site.baseurl}}/article/release-notes).
{% endcallout %}
The `move` command transfers a Vault item [to an Organization]({{site.baseurl}}/article/sharing/):
```
bw share <itemid> <organizationid> [encodedJson]
bw move <itemid> <organizationid> [encodedJson]
```
The `share` command requires you to `encode` a Collection ID, and takes an **exact** `id` (the object to share) and an **exact** `organizationid` (the Organization to share the object to). For example:
The `move` command requires you to `encode` a Collection ID, and takes an **exact** `id` (the object to share) and an **exact** `organizationid` (the Organization to share the object to). For example:
```
echo '["bq209461-4129-4b8d-b760-acd401474va2"]' | bw encode | bw share ed42f44c-f81f-48de-a123-ad01013132ca dfghbc921-04eb-43a7-84b1-ac74013bqb2e
echo '["bq209461-4129-4b8d-b760-acd401474va2"]' | bw encode | bw move ed42f44c-f81f-48de-a123-ad01013132ca dfghbc921-04eb-43a7-84b1-ac74013bqb2e
```
Upon success, the updated item will be returned.