GetUserMultiFactorAuthentication Method

The GetUserMultiFactorAuthentication method tells you whether a user has enabled two-step authentication and returns the notification method that the user has selected.

The GetUserMultiFactorAuthentication method is invoked using the MethodOperation.

You can also retrieve two-factor authentication settings at the office level using the GetOfficeMultiFactorAuthentication method.

Parameters

Name Type Description
UserID String The object ID of the SmartOffice user account.

Examples

Request XML
<request version='1.0'>
    <header>
        <office>myoffice</office>
        <user>jdoe</user>
        <password>password</password>
    </header>
    <method>
        <GetUserMultiFactorAuthentication>
            <UserID>User.1.1</UserID>
        </GetUserMultiFactorAuthentication>  
    </method>
</request>

Response XML
<response version="1.0">
    <header>
        <sessionClosed /> 
    </header>
    <method>
        <GetUserMultiFactorAuthentication>
            <UserMultiFactorAuthentication>
                <TwoWayAuthMode>0</TwoWayAuthMode>
                <OTPNotifyMethod>0</OTPNotifyMethod>
            </UserMultiFactorAuthentication>
        </GetUserMultiFactorAuthentication> 
    </method>
    <_status>OK</_status> 
    <_systime>2017-09-27T15:50:44</_systime> 
    <!-- Cost 18 mill seconds. --> 
</response>

The response contains the following values:
Element Description Possible Values
TwoWayAuthMode Specifies whether two-step authentication is enabled. 0 (disabled) or 1 (enabled)
OTPNotifyMethod Specifies the notification method the user has selected for receiving verification codes. Note: If the user has disabled two-step authentication, this value reflects the notification method selected the last time the user enabled two-step authentication. If the user has never enabled two-step authentication, the value is 0 (none). 0 (none), 1 (text), 2 (e-mail), or 3 (text and e-mail)
Topic revision: 27 Sep 2017, DinosLambropoulos
 

This site is powered by FoswikiCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback