Skip to main content

OTP settings (addon otp)

Definition

The OTP settings allow the administrator users to configure the available OPTOTP options. Soffid provides foursix different OTP implementations.

MainThis Menupage >is Configurationavailable >if Securityyou settingshave >previously installed the Soffid OTP settingsadd-on.

Configure these options as a second authentication factor in the Soffid identity provider. Remember that this functionality is found in the federation add-on.

Screen overview

image.png

image.png

image.png



Related objects

  • Identity providers : to enable OTP options as second factors of authentication

    • Standard attributes

    Email

    • Enabled: allows you to enable or disable a PIN sent by the OTPEmail implementation.
    • Number of digits: number of digits of the PIN code that will be generated.
    • Subject: subject of the email
    • Body: body of the email
    • Number of failures to lock the token: upon reaching the configured number of failures, the token will no longer be usable.

    To send an email,email, willyou bemust mandatoryregister toa fillmail inserver. theTo valuethis purpose, Soffid has a set of the mail.fromparameters parameter.that Youyou can visitfind on the mail serverSoffid parameters. page.

    SMS

    • Enabled: allows you to enable or disable a PIN sent by the OTPSMS implementation.
    • Number of digits: number of digits of the PIN code that will be generated.
    • URL to send the SMS: enter the URL of your SMS provider rest service
    https://www.xxxxxxx.com/cgi-bin/sms/http2sms.cgi?account=sms-bg490971-1&password=XXXXXXt&login=user&from=SOFFID&to=${PHONE}&message=This is your access PIN: ${PIN}&noStop&contentType=application/json&class=0
    • HTTP Method: enter POST or GET depending on your provider documentation
    • HTTP Header: optionally, you can add any HTTY header, including Basic or Bearer authentication tokens. The header must include the header name and header value. For instance:
      Authorization: Basic dXNlcjpwYXNzd29yZA==
    • POST data to send Enter the body of the HTTP request
    • Text to be present in the HTTP response: Soffid will check the response from your SMS Provider contains this text
    "status":100
    • Number of failures to lock the token: upon reaching the configured number of failures, the token will no longer be usable.

    The URL and POST data to be sent, the administrator can use some tags that will be replaced by some target user attributes:

    • ${PHONE}: The target phone number
    • ${PIN}: The one-time password to be entered by the user
    • ${userAttribute}: Any of the standard or custom user attributes, like ${fullName} or ${userName}

    Soffid does not offer any SMS services, this service must be provided by the customer.

    Voice (alternative to SMS)

    • Enabled: allows you to enable or disable a PIN sent by the OTPvoice implementation.
    • URL to send the SMS: enter the URL of your voice call provider rest service
    • HTTP Method: enter POST or GET depending on your provider's documentation
    • HTTP Header: optionally, you can add any HTTY header, including Basic or Bearer authentication tokens. The header must include the header name and header value. For instance:
      Authorization: Basic xxxxxxxxxxxxxxOUVCRS1DMzE0LTI3MzAtQkY0Qy05RDgwRTMyQUQ4OUY=
Content-Type: application/json
Accept: application/json

    • POST data to send Enter the body of the HTTP request.
    Text to be present in the HTTP response: Soffid will check the response from your SMS Provider contains this text
    • Text to be present in the HTTP response: Soffid will check the response from your SMS Provider contains this text
    "status":100

    The POST data to be sent, the administrator can use some tags that will be replaced by some target user attributes:

      • ${PHONE}: The target phone number
      • ${PIN}: The one-time password to be entered by the user
    • Number
    of

    Soffid failuresdoes tonot lockoffer any voice service, this service must be provided by the token customer.

    Time based HMAC Token

    • Enabled: allows you to enable or disable thean OTP Time based HMAC Token implementation.
    • Number of digits: number of digits of the PIN code that will be generated.
    • Algorithm: allows you to select an HMAC algorithm.
    • Issuer: name of the issuer of the PIN.
    • Number of failures to lock the token

    An additional application is required to load the OTP generation settings. You may use any of the following: Google Authenticator, Microsoft Authenticator, FreeOTP Authenticator.

    Event based HMAC Token

    • Enabled: allows you to enable or disable thean OTP Event based HMAC Token implementation.
    • Number of digits: number of digits of the PIN code that will be generated.
    • Algorithm: allows you to select an HMAC algorithm.
    • Issuer: name of the issuer of the PIN.
    • Number of failures to lock the token: upon reaching the configured number of failures, the token will no longer be usable.

    An additional application is required to load the OTP generation settings. You may use any of the following: Google Authenticator, Microsoft Authenticator, FreeOTP Authenticator. 

    Security PIN

    • Enabled: allows you to enable or disable the Security PIN implementation.
    • Minimum PIN length: minimum number of digits that the PIN has to have.
    • Number of digits from the PIN to ask: number of digits that Soffil will ask to verify the identity.
    • Number of failures to lock the token: upon reaching the configured number of failures, the token will no longer be usable.

    Actions

    Confirm changes

    Allows you to save the updates and quit the page.

    Back to top