PUT api/authentications/settings

Updates your default settings for new SMS authentications

Request Information

URI Parameters

None.

Body Parameters

New SMS authentication settings

AuthenticationSettingsDTO
NameDescriptionTypeAdditional information
ConcurrentLimit

The maximum number of allowed active SMS authentications per phone number, default 5

integer

None.

From

Sending name or phone number, default iP1

string

None.

MessageFormat

Format for the SMS message, {0} = code

string

Matching regular expression pattern: ^(?=.*\{0\}).*$

Length

SMS authentication code length, default 5

integer

Range: inclusive between 3 and 25

ExpirationTime

Amount of time (in seconds) until the SMS authentication expires, default 1200 (20 minutes)

integer

Range: inclusive between 1 and 86400

NumericOnly

Whether to force the code to be only numbers, default false

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "ConcurrentLimit": 1,
  "From": "sample string 1",
  "MessageFormat": "sample string 2",
  "Length": 1,
  "ExpirationTime": 1,
  "NumericOnly": true
}

Response Information

Resource Description

Updated SMS authentication settings

AuthenticationSettingsDTO
NameDescriptionTypeAdditional information
ConcurrentLimit

The maximum number of allowed active SMS authentications per phone number, default 5

integer

None.

From

Sending name or phone number, default iP1

string

None.

MessageFormat

Format for the SMS message, {0} = code

string

Matching regular expression pattern: ^(?=.*\{0\}).*$

Length

SMS authentication code length, default 5

integer

Range: inclusive between 3 and 25

ExpirationTime

Amount of time (in seconds) until the SMS authentication expires, default 1200 (20 minutes)

integer

Range: inclusive between 1 and 86400

NumericOnly

Whether to force the code to be only numbers, default false

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "ConcurrentLimit": 1,
  "From": "sample string 1",
  "MessageFormat": "sample string 2",
  "Length": 1,
  "ExpirationTime": 1,
  "NumericOnly": true
}