MFA API

This document provides a brief description of the MFA OpEN APIs. It provides the following services:

• Get user's multifactor authentication state.
• Set user's multifactor authentication state
• Get user's Configured emailId information.
• Set user's emailId information.
• Get global multifactor authentication state
• Set global multifactor authentication state.

Example C mfa_example

Initialization

In the main function, the sample application initializes the OpEN API RPC service by calling openapiClientRegister() and waits for the RPC service in switchdrvr to start. A Client Handle is returned by openapiClientRegister() which is used while invoking the OpEN APIs. The application then exercises the associated OpEN APIs and logs informational and/or error messages on the console. The example application runs to its completion and exits.

_example

mfa_example.c is a sample application that demonstrates the use of OpEN's APIs. mfa_example is started from the command line and can be used to exercise the various APIs by specifying arguments on the command line.

Sample Output

• Usage: ./mfa_example <test#> <arg1> <arg2> ...
• Test 1: Get user's multifactor authentication state: mfa_example 1 <userName>
• Test 2: Set user's multifactor authentication state: mfa_example 2 <userName><mfaPwdEnable>
• Test 3: Get user's Configured emailId information: mfa_example 3 <userName>
• Test 4: Set user's emailId information: mfa_example 4 <userName><emailInfo>
• Test 5: Get global multifactor authentication state: mfa_example 5
• Test 6: Set global multifactor authentication state: mfa_example 6 <mfaCnfgEnable>
• Test 7: Run API sanity checks: mfa_example 7

CLI/API Cross Reference

CLI Command	OpEN API Reference
(Config)# [no] mfa-enable	openapiGlobalMultiFactorAuthSet()
# show mfa	openapiGlobalMultiFactorAuthGet()
(Config)# [no] username <name> password <password> [encryption-type [[md5][sha256][sha512][aes]]] [encrypted] [override-complexity-check] [level <level>] [mfa-enable] [email-id <email-address>]	openapiUserMultiFactorAuthStateSet() openapiUserEmailIdSet()
# show users accounts	openapiUserEmailIdGet() openapiUserMultiFactorAuthStateGet()