Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit ed4cf4f

Browse files
committedJun 22, 2024··
Add README about the auth methods
1 parent 338e9c8 commit ed4cf4f

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed
 

‎README.md

+13
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ configuration options:
6666

6767
* `email`: The email address to use as the account name when logging into the
6868
Bitwarden server. Required.
69+
* `client_id`: Client ID part of the API key. Defaults to regular login process if unset.
6970
* `sso_id`: The SSO organization ID. Defaults to regular login process if unset.
7071
* `base_url`: The URL of the Bitwarden server to use. Defaults to the official
7172
server at `https://api.bitwarden.com/` if unset.
@@ -95,6 +96,18 @@ between by using the `RBW_PROFILE` environment variable. Setting it to a name
9596
switch between several different vaults - each will use its own separate
9697
configuration, local vault, and agent.
9798

99+
### Auth methods
100+
101+
Currently `rbw` supports three login strategies, listed by order of priority:
102+
1. `apikey`, requires you to provide `client_id` and `client_secret`. Will be enabled
103+
when a `client_id` value is set in the config file
104+
2. `SSO` (Enterprise Single Sign-On). Will be enabled when a `sso_id` value is set in
105+
the config file. (Note: due to the current implementation, if your account is secured with 2FA
106+
you'll be required to go through the browser flow twice. You'll be prompted for the 2FA code
107+
after the first run)
108+
3. `email&password`, regular auth method, uses the same credentials as Bitwarden's Web Vault.
109+
That's most likely what you want to use
110+
98111
## Usage
99112

100113
Commands can generally be used directly, and will handle logging in or

0 commit comments

Comments
 (0)
Please sign in to comment.