Skip to main content
POST
Create OTP login config

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

appID
string
required

The id of the app the request refers to. An application's unique identifier.

Examples:

"54e9ujn"

"fvua38g"

Body

application/json
config_type
enum<string>
required
Available options:
otp
Example:

"otp"

channel_type
enum<string>
required
Available options:
sms,
email
Example:

"sms"

template_id
string
Example:

"tpl_01jqebhswje1ka1z7ahr9rfsgt"

sender_id
string
Example:

"Prelude"

is_default
boolean
Example:

false

granted_scopes
string[]

Session scopes attached to the session when a login completes through this OTP configuration (for example prld:pwd:write).

Example:
code_size
integer

OTP code length (number of digits) used for verifications created through this login configuration. When omitted, the account default code size applies.

Required range: 4 <= x <= 8
Example:

6

Response

Created

login_config
object
required