Skip to content

Fix mfa argument + backport #1104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix mfa argument + backport #1104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9b6992f
Fix the -mfa flag description since it was wrong.
Soromeister Oct 14, 2025
ffd7d09
Add `-mfa` argument description to the `Single-Phase` page for 1.14.x…
Soromeister Oct 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions content/vault/v1.14.x/content/docs/auth/login-mfa/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,13 @@ $ curl \
http://127.0.0.1:8200/v1/auth/userpass/login/alice
```

For CLI, you need to make use of the `-mfa` flag or `VAULT_MFA` environment variable to pass in the MFA credentials.

**Examples**:
Comment on lines +111 to +113
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For CLI, you need to make use of the `-mfa` flag or `VAULT_MFA` environment variable to pass in the MFA credentials.
**Examples**:
Use the `-mfa` CLI flag or `VAULT_MFA` environment variable to pass in MFA credentials. For example:

Style correction: write simply


- CLI flag: `-mfa "d16fd3c2-50de-0b9b-eed3-0301dadeca10:695452"`
- Environment variable: `export VAULT_MFA="d16fd3c2-50de-0b9b-eed3-0301dadeca10:695452"`

### Two-Phase login

The more conventional and prevalent MFA method is a two-request mechanism, also referred to as Two-phase Login MFA.
Expand Down
7 changes: 7 additions & 0 deletions content/vault/v1.15.x/content/docs/auth/login-mfa/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,13 @@ $ curl \
http://127.0.0.1:8200/v1/auth/userpass/login/alice
```

For CLI, you need to make use of the `-mfa` flag or `VAULT_MFA` environment variable to pass in the MFA credentials.

**Examples**:
Comment on lines +111 to +113
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For CLI, you need to make use of the `-mfa` flag or `VAULT_MFA` environment variable to pass in the MFA credentials.
**Examples**:
Use the `-mfa` CLI flag or `VAULT_MFA` environment variable to pass in MFA credentials. For example:

Edited to match original suggestion


- CLI flag: `-mfa "d16fd3c2-50de-0b9b-eed3-0301dadeca10:695452"`
- Environment variable: `export VAULT_MFA="d16fd3c2-50de-0b9b-eed3-0301dadeca10:695452"`

### Two-Phase login

The more conventional and prevalent MFA method is a two-request mechanism, also referred to as Two-phase Login MFA.
Expand Down
7 changes: 7 additions & 0 deletions content/vault/v1.16.x/content/docs/auth/login-mfa/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,13 @@ $ curl \
http://127.0.0.1:8200/v1/auth/userpass/login/alice
```

For CLI, you need to make use of the `-mfa` flag or `VAULT_MFA` environment variable to pass in the MFA credentials.

**Examples**:
Comment on lines +111 to +113
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For CLI, you need to make use of the `-mfa` flag or `VAULT_MFA` environment variable to pass in the MFA credentials.
**Examples**:
Use the `-mfa` CLI flag or `VAULT_MFA` environment variable to pass in MFA credentials. For example:

Edited to match original suggestion


- CLI flag: `-mfa "d16fd3c2-50de-0b9b-eed3-0301dadeca10:695452"`
- Environment variable: `export VAULT_MFA="d16fd3c2-50de-0b9b-eed3-0301dadeca10:695452"`

### Two-Phase login

The more conventional and prevalent MFA method is a two-request mechanism, also referred to as Two-phase Login MFA.
Expand Down
7 changes: 7 additions & 0 deletions content/vault/v1.17.x/content/docs/auth/login-mfa/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,13 @@ $ curl \
http://127.0.0.1:8200/v1/auth/userpass/login/alice
```

For CLI, you need to make use of the `-mfa` flag or `VAULT_MFA` environment variable to pass in the MFA credentials.

**Examples**:
Comment on lines +111 to +113
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For CLI, you need to make use of the `-mfa` flag or `VAULT_MFA` environment variable to pass in the MFA credentials.
**Examples**:
Use the `-mfa` CLI flag or `VAULT_MFA` environment variable to pass in MFA credentials. For example:

Edited to match original suggestion


- CLI flag: `-mfa "d16fd3c2-50de-0b9b-eed3-0301dadeca10:695452"`
- Environment variable: `export VAULT_MFA="d16fd3c2-50de-0b9b-eed3-0301dadeca10:695452"`

### Two-Phase login

The more conventional and prevalent MFA method is a two-request mechanism, also referred to as Two-phase Login MFA.
Expand Down
7 changes: 7 additions & 0 deletions content/vault/v1.18.x/content/docs/auth/login-mfa/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,13 @@ $ curl \
http://127.0.0.1:8200/v1/auth/userpass/login/alice
```

For CLI, you need to make use of the `-mfa` flag or `VAULT_MFA` environment variable to pass in the MFA credentials.

**Examples**:
Comment on lines +115 to +117
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For CLI, you need to make use of the `-mfa` flag or `VAULT_MFA` environment variable to pass in the MFA credentials.
**Examples**:
Use the `-mfa` CLI flag or `VAULT_MFA` environment variable to pass in MFA credentials. For example:

Edited to match original suggestion


- CLI flag: `-mfa "d16fd3c2-50de-0b9b-eed3-0301dadeca10:695452"`
- Environment variable: `export VAULT_MFA="d16fd3c2-50de-0b9b-eed3-0301dadeca10:695452"`

### Two-Phase login

The more conventional and prevalent MFA method is a two-request mechanism, also referred to as Two-phase Login MFA.
Expand Down
7 changes: 7 additions & 0 deletions content/vault/v1.19.x/content/docs/auth/login-mfa/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,13 @@ $ curl \
http://127.0.0.1:8200/v1/auth/userpass/login/alice
```

For CLI, you need to make use of the `-mfa` flag or `VAULT_MFA` environment variable to pass in the MFA credentials.

**Examples**:
Comment on lines +115 to +117
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For CLI, you need to make use of the `-mfa` flag or `VAULT_MFA` environment variable to pass in the MFA credentials.
**Examples**:
Use the `-mfa` CLI flag or `VAULT_MFA` environment variable to pass in MFA credentials. For example:

Edited to match original suggestion


- CLI flag: `-mfa "d16fd3c2-50de-0b9b-eed3-0301dadeca10:695452"`
- Environment variable: `export VAULT_MFA="d16fd3c2-50de-0b9b-eed3-0301dadeca10:695452"`

### Two-Phase login

The more conventional and prevalent MFA method is a two-request mechanism, also referred to as Two-phase Login MFA.
Expand Down
6 changes: 3 additions & 3 deletions content/vault/v1.19.x/content/partials/global-settings/both/mfa.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
**`[-mfa | VAULT_MFA] (string : "")`** <EnterpriseAlert inline="true" />

A multi-factor authentication (MFA) credential, in the format
`mfa_method_name[:key[=value]]`, that the CLI should use to authenticate to
`mfa_method_id:passcode`, that the CLI should use to authenticate to
Vault. The CLI adds MFA credentials to the `X-Vault-MFA` header when calling the
underlying API endpoint.

**Examples**:

- CLI flag: `-mfa "totp:password=12345"`
- Environment variable: `export VAULT_MFA="totp:password=12345"`
- CLI flag: `-mfa "d16fd3c2-50de-0b9b-eed3-0301dadeca10:695452"`
- Environment variable: `export VAULT_MFA="d16fd3c2-50de-0b9b-eed3-0301dadeca10:695452"`

<Note>

Expand Down
7 changes: 7 additions & 0 deletions content/vault/v1.20.x/content/docs/auth/login-mfa/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,13 @@ $ curl \
http://127.0.0.1:8200/v1/auth/userpass/login/alice
```

For CLI, you need to make use of the `-mfa` flag or `VAULT_MFA` environment variable to pass in the MFA credentials.

**Examples**:
Comment on lines +115 to +117
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For CLI, you need to make use of the `-mfa` flag or `VAULT_MFA` environment variable to pass in the MFA credentials.
**Examples**:
Use the `-mfa` CLI flag or `VAULT_MFA` environment variable to pass in MFA credentials. For example:

Edited to match original suggestion


- CLI flag: `-mfa "d16fd3c2-50de-0b9b-eed3-0301dadeca10:695452"`
- Environment variable: `export VAULT_MFA="d16fd3c2-50de-0b9b-eed3-0301dadeca10:695452"`

### Two-Phase login

The more conventional and prevalent MFA method is a two-request mechanism, also referred to as Two-phase Login MFA.
Expand Down
6 changes: 3 additions & 3 deletions content/vault/v1.20.x/content/partials/global-settings/both/mfa.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
**`[-mfa | VAULT_MFA] (string : "")`** <EnterpriseAlert inline="true" />

A multi-factor authentication (MFA) credential, in the format
`mfa_method_name[:key[=value]]`, that the CLI should use to authenticate to
`mfa_method_id:passcode`, that the CLI should use to authenticate to
Vault. The CLI adds MFA credentials to the `X-Vault-MFA` header when calling the
underlying API endpoint.

**Examples**:

- CLI flag: `-mfa "totp:password=12345"`
- Environment variable: `export VAULT_MFA="totp:password=12345"`
- CLI flag: `-mfa "d16fd3c2-50de-0b9b-eed3-0301dadeca10:695452"`
- Environment variable: `export VAULT_MFA="d16fd3c2-50de-0b9b-eed3-0301dadeca10:695452"`

<Note>

Expand Down
7 changes: 7 additions & 0 deletions content/vault/v1.21.x (rc)/content/docs/auth/login-mfa/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,13 @@ $ curl \
http://127.0.0.1:8200/v1/auth/userpass/login/alice
```

For CLI, you need to make use of the `-mfa` flag or `VAULT_MFA` environment variable to pass in the MFA credentials.

**Examples**:
Comment on lines +116 to +118
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For CLI, you need to make use of the `-mfa` flag or `VAULT_MFA` environment variable to pass in the MFA credentials.
**Examples**:
Use the `-mfa` CLI flag or `VAULT_MFA` environment variable to pass in MFA credentials. For example:

Edited to match original suggestion


- CLI flag: `-mfa "d16fd3c2-50de-0b9b-eed3-0301dadeca10:695452"`
- Environment variable: `export VAULT_MFA="d16fd3c2-50de-0b9b-eed3-0301dadeca10:695452"`

### Two-Phase login

The more conventional and prevalent MFA method is a two-request mechanism, also referred to as Two-phase Login MFA.
Expand Down
6 changes: 3 additions & 3 deletions content/vault/v1.21.x (rc)/content/partials/global-settings/both/mfa.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
**`[-mfa | VAULT_MFA] (string : "")`** <EnterpriseAlert inline="true" />

A multi-factor authentication (MFA) credential, in the format
`mfa_method_name[:key[=value]]`, that the CLI should use to authenticate to
`mfa_method_id:passcode`, that the CLI should use to authenticate to
Vault. The CLI adds MFA credentials to the `X-Vault-MFA` header when calling the
underlying API endpoint.

**Examples**:

- CLI flag: `-mfa "totp:password=12345"`
- Environment variable: `export VAULT_MFA="totp:password=12345"`
- CLI flag: `-mfa "d16fd3c2-50de-0b9b-eed3-0301dadeca10:695452"`
- Environment variable: `export VAULT_MFA="d16fd3c2-50de-0b9b-eed3-0301dadeca10:695452"`

<Note>

Expand Down
Loading