POST api/TwoFactor/CreateTwoFactorSmsOtp

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
UserId	globally unique identifier	None.
GsmNumber	string	None.
TwoFactorConfigurationId	integer	None.
MaxSMSCount	integer	None.
MaxSMSInterval	integer	None.
OtpExpirationPeriod	integer	None.
IsSync	boolean	None.
Source	string	None.

Request Formats

application/json, text/json

Sample:

{
  "UserId": "598e55b7-59a5-4329-b070-ddd679e77ef2",
  "GsmNumber": "sample string 2",
  "TwoFactorConfigurationId": 3,
  "MaxSMSCount": 4,
  "MaxSMSInterval": 5,
  "OtpExpirationPeriod": 6,
  "IsSync": true,
  "Source": "sample string 7"
}

application/xml, text/xml

Sample:

<CreateTwoFactorSmsOtpRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessLayer.Dto.Request">
  <GsmNumber>sample string 2</GsmNumber>
  <IsSync>true</IsSync>
  <MaxSMSCount>4</MaxSMSCount>
  <MaxSMSInterval>5</MaxSMSInterval>
  <OtpExpirationPeriod>6</OtpExpirationPeriod>
  <Source>sample string 7</Source>
  <TwoFactorConfigurationId>3</TwoFactorConfigurationId>
  <UserId>598e55b7-59a5-4329-b070-ddd679e77ef2</UserId>
</CreateTwoFactorSmsOtpRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CreateTwoFactorSmsOtpResponse

Name	Type	Additional information
Id	integer	None.
OtpIdReference	string	None.
ReferenceCode	string	None.
OtpCode	string	None.
RemainingExpirationSeconds	integer	None.
GsmNumber	string	None.
ExceptionMessage	string	None.
Success	boolean	None.
Code	CreateTwoFactorSmsOtpResponseCode	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "OtpIdReference": "sample string 2",
  "ReferenceCode": "sample string 3",
  "OtpCode": "sample string 4",
  "RemainingExpirationSeconds": 5,
  "GsmNumber": "sample string 6",
  "ExceptionMessage": "sample string 7",
  "Success": true,
  "Code": 4000
}

application/xml, text/xml

Sample:

<CreateTwoFactorSmsOtpResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessLayer.Dto.Response">
  <Code>MaxOtpRequestExceededCode</Code>
  <ExceptionMessage>sample string 7</ExceptionMessage>
  <GsmNumber>sample string 6</GsmNumber>
  <Id>1</Id>
  <OtpCode>sample string 4</OtpCode>
  <OtpIdReference>sample string 2</OtpIdReference>
  <ReferenceCode>sample string 3</ReferenceCode>
  <RemainingExpirationSeconds>5</RemainingExpirationSeconds>
  <Success>true</Success>
</CreateTwoFactorSmsOtpResponse>