@@ -73,6 +73,7 @@ configuration options:
7373
7474* ` email ` : The email address to use as the account name when logging into the
7575 Bitwarden server. Required.
76+ * ` client_id ` : Client ID part of the API key. Defaults to regular login process if unset.
7677* ` sso_id ` : The SSO organization ID. Defaults to regular login process if unset.
7778* ` base_url ` : The URL of the Bitwarden server to use. Defaults to the official
7879 server at ` https://api.bitwarden.com/ ` if unset.
@@ -102,6 +103,18 @@ between by using the `RBW_PROFILE` environment variable. Setting it to a name
102103switch between several different vaults - each will use its own separate
103104configuration, local vault, and agent.
104105
106+ ### Auth methods
107+
108+ Currently ` rbw ` supports three login strategies, listed by order of priority:
109+ 1 . ` apikey ` , requires you to provide ` client_id ` and ` client_secret ` . Will be enabled
110+ when a ` client_id ` value is set in the config file
111+ 2 . ` SSO ` (Enterprise Single Sign-On). Will be enabled when a ` sso_id ` value is set in
112+ the config file. (Note: due to the current implementation, if your account is secured with 2FA
113+ you'll be required to go through the browser flow twice. You'll be prompted for the 2FA code
114+ after the first run)
115+ 3 . ` email&password ` , regular auth method, uses the same credentials as Bitwarden's Web Vault.
116+ That's most likely what you want to use
117+
105118## Usage
106119
107120Commands can generally be used directly, and will handle logging in or
0 commit comments