Skip to main content

Update Entrust ST Authenticator settings

PUT 
/api/web/v1/settings/entrustst

Update Entrust ST Authenticator settings. Caller requires the SETTINGS:EDIT permission.

Request​

Body

required

    activationLifetime int32

    Possible values: >= 60

    The amount of time in seconds that an activation request is valid. Default is 300 seconds.

    activationTypes string[]

    Possible values: [CLASSIC, ONLINE, OFFLINE]

    The list of activation types that will be performed. Allowed values are: CLASSIC (return activation values that must be manually entered into the mobile application), ONLINE (return a link that when clicked will launch the mobile application) and OFFLINE (return a QR code that can be scanned by the mobile application). If no values are specified in the list then activation types are not updated.

    allowUnsecureDevice boolean

    A flag indicating if the Mobile soft token can be activated on a rooted device. Default is false.

    facialRecognitionAllowed boolean

    A flag indicating if the facial recognition feature supported by the Entrust Soft Token application is allowed. The default is false.

    maxResetTimeSteps int32

    Possible values: >= 1 and <= 1200

    The maximum number of 30 second timestamps that a result response is validated. Default is 120.

    maxTimeSteps int32

    Possible values: >= 1 and <= 120

    The maximum number of 30 second timesteps over which a response is validated. The default is 10.

    mutualChallengeAlphabet string

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

    mutualChallengeEnabled boolean

    A flag indicating if the Push Authentication Mutual Challenge is enabled. The default is false.

    mutualChallengeForPercentOfRequests int32

    Possible values: >= 1 and <= 100

    An integer value that specifies what percent of requests have a mutual challenge. Default is 100.

    mutualChallengeLength int32

    Possible values: >= 1 and <= 5

    The length of the mutual challenge. Default is 2.

    mutualChallengeSize int32

    Possible values: >= 1 and <= 5

    The number of mutual challenges return in a batch. Default is 3.

    offlineActivationPasswordLength int32

    Possible values: >= 4 and <= 20

    The length of the random password generated to encrypt an activation QR code. Default is 8.

    onlineActivationPasswordLength int32

    Possible values: >= 16 and <= 32

    The length of the random password generated for an online activation. Default is 16.

    otpLength int32

    Possible values: [6, 8]

    The length of the OTP generated by the soft token. The default is 8.

    pinRequired boolean

    A flag indicating if this token requires that a PIN be enabled on the Entrust Soft Token application. The default is true.

    scheme string

    Specifies the URL scheme used in soft token activation URLs. It should specify the URL scheme associated with the mobile application to be used. This value should only be changed if you are using your own mobile application written using the Entrust ST SDK. The default value is igmobileotp which corresponds to the Entrust ST application.

Responses​

Successful

Loading...