Skip to content

Update a Configuration

post
https://api.reach.talkylabs.com/rest/authentix/v1/configurations/{configurationId}

This operation allows to update the attributes of a configuration.

Parameters

  • configurationIdstringrequiredpath

    The identifier of the configuration to be updated.

  • serviceNamestringoptional

    The name of the authentication service attached to this configuration. It can be up to 40 characters long.

  • codeLengthintegeroptional

    The length of the code to be generated. It must be a value between 4 and 10, inclusive.

  • allowCustomCodebooleanoptional

    A flag indicating if the configuration should allow sending custom and pre-generated code.

  • usedForDigitalPaymentbooleanoptional

    A flag indicating if the configuration is used to authenticate digital payments. In such a case, additional information such as the amount and the payee of the financial transaction should be sent to when starting the authentication.

  • defaultExpiryTimeintegeroptional

    It represents how long, in minutes, an authentication process will remained in the awaiting status before moving to expired in the case no valid matching is performed in between. It must be any value between 1 and 1440 which represents 24 hours.

  • defaultMaxTrialsintegeroptional

    It represents the maximum number of authentication trials for an authentication process.

  • defaultMaxControlsintegeroptional

    It represents the maximum number of code controls for an authentication process. It must be between 1 and 6 inclusive.

  • smtpSettingIdstringoptional

    This is the ID of the SMTP settings used by this configuration. It is mandatory for sending authentication codes via email.

  • emailTemplateIdstringoptional

    This is the ID of the default email template to use for sending authenetication codes via email.

  • smsTemplateIdstringoptional

    This is the ID of the default sms template to use for sending authenetication codes via sms.

Example 1: Update a configuration

The example below shows how to update a configuration having the configurationId attribute set to CIDXXXXXXXXXXXX using the Reach Authentix API.

In this example, the code length is updated to the value 7.

curl -X POST https://api.reach.talkylabs.com/rest/authentix/v1/configurations/CIDXXXXXXXXXXXX --data-urlencode "codeLength=7" -H "ApiUser: $REACH_TALKYLABS_API_USER" -H "ApiKey: $REACH_TALKYLABS_API_KEY"
Output example
{
  "appletId": "AIDXXXXXXXXXXXX",
  "apiVersion": "1.0.0",
  "configurationId": "CIDXXXXXXXXXXXX",
  "serviceName": "myService",
  "codeLength": 5,
  "allowCustomCode": false,
  "usedForDigitalPayment": false,
  "defaultExpiryTime": 5,
  "defaultMaxTrials": 5,
  "defaultMaxControls": 3,
  "smtpSettingId": "STPXXXXXXXXXXXXX",
  "emailTemplateId": "TMEXXXXXXXXXXXXXXX",
  "smsTemplateId": "TMSXXXXXXXXXXXXXXX",
  "dateCreated": "2016-08-29T09:12:33.001Z",
  "dateUpdated": "2016-08-29T09:12:35.001Z"
}