Skip to main content

Get OTP authenticator settings

GET 
/api/web/v3/settings/otp

Get OTP authenticator settings. Caller requires the SETTINGS:VIEW permission.

Responses​

Successful

Schema

    defaultDeliveryEnabled boolean

    Indicates whether client applications can delivery OTP to default delivery contact or can enforce users to choose an OTP delivery.

    deliveryMethods

    object[]

    The allowed OTP delivery mechanisms in order of preference. Default is SMS, followed by Email, and Voice.

  • Array [

    • enabled boolean

    Whether the method is enabled.

    name string

    Possible values: [EMAIL, SMS, VOICE]

    The OTP delivery method type.

  • ]

    • includeOtpExpiryDate boolean

    Indicates whether the OTP expiry date will be included in the OTP SMS message

    otpAlphabet string

    Characters that can appear in a RANDOM OTP. Can contain any non-whitespace character. Default is all digits.

    otpDefaultDelivery stringdeprecated

    Possible values: [EMAIL, SMS, VOICE, NONE]

    The default OTP delivery mechanism. This attribute is deprecated, use the deliveryMethods attribute.

    otpDefaultDeliveryAttribute stringdeprecated

    Id of the default OTP delivery attribute. Deprecated : Use default attribute specific to delivery mechanism instead eg. otpSmsDefaultDeliveryAttribute, otpEmailDefaultDeliveryAttribute

    otpEmailDefaultDeliveryAttribute string

    Id of the default Email OTP delivery attribute.

    otpLength int32

    Possible values: >= 4 and <= 100

    The length of an OTP. Default is 8.

    otpLifetime int32

    Possible values: >= 60 and <= 3600

    The lifetime of an OTP in seconds. Default is 300.

    otpSmsDefaultDeliveryAttribute string

    Id of the default SMS OTP delivery attribute.

    otpType string

    Possible values: [RANDOM, MEMO_PASSCODE]

    The type of OTP generated. Choices are RANDOM or MEMO_PASSCODE. Default is RANDOM

    otpVoiceDefaultDeliveryAttribute string

    Id of the default Voice OTP delivery attribute.

    showOtpDeliveryContact boolean

    Indicates whether masked OTP contact attribute values are included in authentication API.

Loading...