open-vault/website/content/api-docs/system/mfa/index.mdx
2022-07-13 10:36:52 -07:00

39 lines
1.3 KiB
Plaintext

---
layout: api
page_title: /sys/mfa - HTTP API
description: >-
The '/sys/mfa' endpoint focuses on managing MFA behaviors in Vault Enterprise
MFA.
---
# `/sys/mfa`
The `/sys/mfa` endpoint focuses on managing Multi-factor Authentication (MFA)
behaviors in Vault Enterprise MFA.
## Supported MFA types
- [TOTP](/api/system/mfa/totp)
- [Okta](/api/system/mfa/okta)
- [Duo](/api/system/mfa/duo)
- [PingID](/api/system/mfa/pingid)
## Step-up Enterprise MFA
[Vault Enterprise](/docs/enterprise/mfa) allows MFA for login and access to
sensitive resources in Vault. The Step-up Enterprise MFA expects the method
creator to specify a name for the method; Login MFA does not, and instead
returns an ID when a method is created. Although MFA methods supported with Step-up Enterprise MFA are supported with the Login MFA, they use different API endpoints.
- Step-up Enterprise MFA: `sys/mfa/method/:type/:/name`
- Login MFA: `identity/mfa/method/:type`
~> **Note:** While the `sys/mfa` endpoint is supported for both OSS and Vault Enterprise, `sys/mfa/method/:type/:/name` is only supported for Vault Enterprise.
Refer to the [Login MFA
FAQ](/docs/auth/login-mfa/faq#q-are-there-new-mfa-api-endpoints-introduced-as-part-of-the-new-vault-version-1-10-mfa-for-login-functionality) document
for more details.