GET api/v1/portals/{portalUid}/users/logon/{logon}/2fainfo

Get logon two factor authentication info

Request Information

URI Parameters

Name	Description	Type	Additional information
portalUid	The portal UID.	globally unique identifier	Required
logon	The user logon	string	Required

Body Parameters

None.

Response Information

Resource Description

Returns two factor authentication details

UserSecretKey2FAViewModel

Name	Description	Type	Additional information
Logon	The user logon.	string	None.
SecretKey2FA	The user secret key for 2 factor authentication.	string	None.
Is2FASiteWide	Two factor authentication type. False shows that user enabled 2fa only on change password. True means the 2fa will be anabled both on logon and change password.	boolean	None.
Uid	The GUID.	globally unique identifier	None.
Links	The links.	Collection of Link	None.
DateUpdated	Last time the record was updated	date	None.
UpdatedBy	Who updated the record last	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Logon": "sample string 1",
  "SecretKey2FA": "sample string 2",
  "Is2FASiteWide": true,
  "Uid": "7a526b5f-7522-480f-af86-43c0a3467e07",
  "Links": [
    {
      "Href": "http://webapihelppage1.com",
      "Method": "sample string 2",
      "Rel": "sample string 3",
      "Title": "sample string 4",
      "Type": "sample string 5"
    },
    {
      "Href": "http://webapihelppage1.com",
      "Method": "sample string 2",
      "Rel": "sample string 3",
      "Title": "sample string 4",
      "Type": "sample string 5"
    }
  ],
  "DateUpdated": "2025-10-27T13:56:22.3378138+00:00",
  "UpdatedBy": "sample string 5"
}

application/xml, text/xml

Sample:

<UserSecretKey2FAViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
  <DateUpdated>2025-10-27T13:56:22.3378138+00:00</DateUpdated>
  <Links xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
    <d2p1:Link>
      <d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
      <d2p1:Method>sample string 2</d2p1:Method>
      <d2p1:Rel>sample string 3</d2p1:Rel>
      <d2p1:Title>sample string 4</d2p1:Title>
      <d2p1:Type>sample string 5</d2p1:Type>
    </d2p1:Link>
    <d2p1:Link>
      <d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
      <d2p1:Method>sample string 2</d2p1:Method>
      <d2p1:Rel>sample string 3</d2p1:Rel>
      <d2p1:Title>sample string 4</d2p1:Title>
      <d2p1:Type>sample string 5</d2p1:Type>
    </d2p1:Link>
  </Links>
  <Uid>7a526b5f-7522-480f-af86-43c0a3467e07</Uid>
  <UpdatedBy>sample string 5</UpdatedBy>
  <Is2FASiteWide>true</Is2FASiteWide>
  <Logon>sample string 1</Logon>
  <SecretKey2FA>sample string 2</SecretKey2FA>
</UserSecretKey2FAViewModel>