com.quantum.dxi.rest.security

Class Mfa

java.lang.Object

Base

com.quantum.dxi.rest.security.Mfa

public class Mfa
extends Base

The Mfa resource represents the configuration of multi-factor authentication (MFA). The Mfa interface includes the service for getting and setting the MFA method and modifying user specific settings. Currently the only supported method is time-based one-time passwords (TOTP).

The schema that defines the MFA resource is described below.

 
     <xs:element name="MfaConfiguration">
         <xs:complexType>
             <xs:sequence>
                 <xs:element name="MfaEnabled" type="xs:boolean"/>
                 <xs:element name="MfaMethod" type="xs:string" minOccurs="0"/>
             </xs:sequence>
         </xs:complexType>
     </xs:element>
 
 

Since:

1.2.5

Constructor Summary

Constructors

Constructor and Description
Mfa()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	delTotpKey(javax.servlet.http.HttpServletRequest request, java.lang.String mfaType, java.lang.String name) DELETE /rest/Mfa/{mfaType}/{name}
MfaConfiguration	getMfaConfiguration(javax.servlet.http.HttpServletRequest request) GET /rest/Mfa
BooleanScalarType	getTotpEnabled(javax.servlet.http.HttpServletRequest request, java.lang.String mfaType) GET /rest/Mfa/{mfaType}
BooleanScalarType	setTotpEnabled(javax.servlet.http.HttpServletRequest request, java.lang.String mfaType, BooleanScalarType enabled) POST /rest/Mfa/{mfaType}

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Mfa

public Mfa()

Method Detail

getMfaConfiguration

public MfaConfiguration getMfaConfiguration(@Context
                                            javax.servlet.http.HttpServletRequest request)

GET /rest/Mfa

Get the MFA state and method used on the system. This API can be called without authentication to allow clients to select the appropriate API for authentication. Currently the only supported mfaType is "totp".

Response Entity type: <xs:element name="MfaConfiguration">

Since:

1.2.5

getTotpEnabled

public BooleanScalarType getTotpEnabled(@Context
                                        javax.servlet.http.HttpServletRequest request,
                                        java.lang.String mfaType)

GET /rest/Mfa/{mfaType}

Get the MFA method state information on the system. Currently the only supported mfaType is "totp".

Response Entity type: <xs:element name="BooleanScalar">

Since:

1.2.5

setTotpEnabled

public BooleanScalarType setTotpEnabled(@Context
                                        javax.servlet.http.HttpServletRequest request,
                                        java.lang.String mfaType,
                                        BooleanScalarType enabled)

POST /rest/Mfa/{mfaType}

Set the MFA method state on the system. Currently the only supported mfaType is "totp". Request Entity type: <xs:element name="BooleanScalarType">

Response Entity type: <xs:element name="BooleanScalarType">

Since:

1.2.5

delTotpKey

public javax.ws.rs.core.Response delTotpKey(@Context
                                            javax.servlet.http.HttpServletRequest request,
                                            java.lang.String mfaType,
                                            java.lang.String name)
                                     throws DaoNoSuchNameException

DELETE /rest/Mfa/{mfaType}/{name}

Delete the user specific resource for MFA. Currently the only supported mfaType is "totp". This API will delete the TOTP shared key.

Throws:

DaoNoSuchNameException

Since:

1.2.5