Skip to main content
POST
Create an email OTP configuration

Authorizations

Authorization
string
header
required

Use your Authsignal Management API secret key as the username and leave the password empty. This key is different from the Server API key and can be found in the API Keys section of the Authsignal Portal settings page.

Body

application/json

Email OTP configuration to create.

emailProvider
enum<string>
required

The email provider. Supply the matching credential object for BIRD, MAILJET, MAILGUN, MANDRILL, SENDGRID, or SMTP.

Available options:
BIRD,
MAILJET,
MAILGUN,
MANDRILL,
SENDGRID,
SMTP
isActive
boolean

Whether the authentication method is active. Defaults to true.

submissionRateLimitConfiguration
object

The verification-code submission limit for email OTP.

sendingRateLimitConfigurations
object[]

Message delivery limits. Every configured limit applies.

Required array length: 1 - 6 elements
allowedCustomEmailVariables
string[]

Custom template variable names for email.

mailjetEmailCredentials
object

Use with the MAILJET email provider.

mailgunEmailCredentials
object

Use with the MAILGUN email provider.

mandrillEmailCredentials
object

Use with the MANDRILL email provider.

birdEmailCredentials
object

Use with the BIRD email provider.

sendgridEmailCredentials
object

Use with the SENDGRID email provider.

smtpEmailCredentials
object

Use with the SMTP email provider.

Response

OK

authenticatorId
string
required
read-only

The immutable identifier for this configuration.

isActive
boolean
required
verificationMethod
string
required
read-only

The verification method produced by this configuration.

Allowed value: "EMAIL_OTP"
emailProvider
enum<string>

The email provider. Supply the matching credential object for BIRD, MAILJET, MAILGUN, MANDRILL, SENDGRID, or SMTP.

Available options:
BIRD,
MAILJET,
MAILGUN,
MANDRILL,
SENDGRID,
SMTP
submissionRateLimitConfiguration
object
sendingRateLimitConfigurations
object[]

Message delivery limits. Every configured limit applies.

Required array length: 1 - 6 elements
allowedCustomEmailVariables
string[]
mailjetEmailCredentials
object

Use with the MAILJET email provider.

mailgunEmailCredentials
object

Use with the MAILGUN email provider.

mandrillEmailCredentials
object

Use with the MANDRILL email provider.

birdEmailCredentials
object

Use with the BIRD email provider.

sendgridEmailCredentials
object

Use with the SENDGRID email provider.

smtpEmailCredentials
object

Use with the SMTP email provider.