PUT api/v1/portals/{portalUid}/users/logon/secretkey2fa

Update the two factor authentication secret key.

Request Information

URI Parameters

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

Body Parameters

The user Secret Key 2FA.

UserSecretKey2FA

Name	Description	Type	Additional information
Logon	The logon.	string	Required String length: inclusive between 0 and 255
SecretKey2FA	Gets or sets secret key for two factor authentication	string	Required
Is2FASiteWide	Gets or sets 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	Required

Name

Description

Type

Additional information

Logon

The logon.

string

Required

String length: inclusive between 0 and 255

SecretKey2FA

Gets or sets secret key for two factor authentication

string

Required

Is2FASiteWide

Gets or sets 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

Required

Request Formats

application/json, text/json

Sample:

{
  "Logon": "sample string 1",
  "SecretKey2FA": "sample string 2",
  "Is2FASiteWide": true
}

application/xml, text/xml

Sample:

<UserSecretKey2FA xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
  <Is2FASiteWide>true</Is2FASiteWide>
  <Logon>sample string 1</Logon>
  <SecretKey2FA>sample string 2</SecretKey2FA>
</UserSecretKey2FA>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns response message.

None.