Update Authenticator Configuration
Updates an authenticator configuration by authenticator ID.
curl --request PATCH \
--url https://api.authsignal.com/v1/management/authenticator-configurations/{authenticator_id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"authenticatorId": "<string>",
"authenticatorType": "<unknown>",
"isActive": true,
"isEditableByUser": true,
"isHiddenToUser": true,
"webhookUrl": "<string>",
"messageTemplate": "<string>",
"sender": "<string>",
"relyingParty": "<string>",
"expectedOrigins": [
"<string>"
],
"verificationCodeLength": 6,
"enrollmentPromptInterval": 123,
"hideTotpAppDownloadScreen": true,
"issuerName": "<string>",
"sessionTtlInMinutes": 30,
"showEmailDeliveryTimeWarning": true,
"smsCountryCodes": [
"<string>"
],
"allowMultipleUserAuthenticators": true,
"rateLimitConfiguration": {
"rateLimit": 50,
"windowInMinutes": 720
},
"sendingRateLimitConfiguration": {
"rateLimit": 50,
"windowInMinutes": 720
},
"passkeyRegistrationHints": [],
"whatsAppProvider": "BIRD",
"redirectUrls": [
"<string>"
],
"dontSkipEnrollmentInputScreen": true,
"documentTypes": {},
"recoveryMethods": [],
"disableEnrollmentPrompt": true,
"requireDeviceIntegrity": true,
"twilioCredentials": {
"accountSid": "<string>",
"messagingServiceSid": "<string>",
"authToken": "<string>"
},
"messageBirdV2Credentials": {
"accessKey": "<string>",
"workspaceId": "<string>",
"channelId": "<string>",
"navigatorId": "<string>",
"projectId": "<string>",
"locale": "<string>",
"enableMessageTemplates": true
},
"modicaGroupCredentials": {
"username": "<string>",
"password": "<string>"
},
"tnzCredentials": {
"apiKey": "<string>"
},
"urbanAirshipCredentials": {
"apiKey": "<string>",
"masterSecret": "<string>"
},
"veriff": {
"apiKey": "<string>",
"apiSecret": "<string>"
},
"iproov": {
"apiKey": "<string>",
"apiSecret": "<string>",
"baseUrl": "<string>"
},
"idverseCredentials": {
"apiKey": "<string>",
"apiSecret": "<string>"
},
"messageMediaCredentials": {
"apiKey": "<string>",
"apiSecret": "<string>",
"sourceNumber": "<string>"
},
"mailjetEmailCredentials": {
"privateKey": "<string>",
"publicKey": "<string>",
"templateId": "<string>"
},
"mailgunEmailCredentials": {
"apiKey": "<string>",
"url": "<string>",
"domain": "<string>",
"from": "<string>"
},
"smtpEmailCredentials": {
"host": "<string>",
"port": 123,
"secure": true,
"username": "<string>",
"password": "<string>",
"from": "<string>",
"fromName": "<string>"
},
"birdEmailCredentials": {
"accessKey": "<string>",
"workspaceId": "<string>",
"channelId": "<string>",
"projectId": "<string>",
"versionId": "<string>",
"locale": "<string>",
"senderEmail": "<string>",
"senderName": "<string>"
}
}
'import requests
url = "https://api.authsignal.com/v1/management/authenticator-configurations/{authenticator_id}"
payload = {
"authenticatorId": "<string>",
"authenticatorType": "<unknown>",
"isActive": True,
"isEditableByUser": True,
"isHiddenToUser": True,
"webhookUrl": "<string>",
"messageTemplate": "<string>",
"sender": "<string>",
"relyingParty": "<string>",
"expectedOrigins": ["<string>"],
"verificationCodeLength": 6,
"enrollmentPromptInterval": 123,
"hideTotpAppDownloadScreen": True,
"issuerName": "<string>",
"sessionTtlInMinutes": 30,
"showEmailDeliveryTimeWarning": True,
"smsCountryCodes": ["<string>"],
"allowMultipleUserAuthenticators": True,
"rateLimitConfiguration": {
"rateLimit": 50,
"windowInMinutes": 720
},
"sendingRateLimitConfiguration": {
"rateLimit": 50,
"windowInMinutes": 720
},
"passkeyRegistrationHints": [],
"whatsAppProvider": "BIRD",
"redirectUrls": ["<string>"],
"dontSkipEnrollmentInputScreen": True,
"documentTypes": {},
"recoveryMethods": [],
"disableEnrollmentPrompt": True,
"requireDeviceIntegrity": True,
"twilioCredentials": {
"accountSid": "<string>",
"messagingServiceSid": "<string>",
"authToken": "<string>"
},
"messageBirdV2Credentials": {
"accessKey": "<string>",
"workspaceId": "<string>",
"channelId": "<string>",
"navigatorId": "<string>",
"projectId": "<string>",
"locale": "<string>",
"enableMessageTemplates": True
},
"modicaGroupCredentials": {
"username": "<string>",
"password": "<string>"
},
"tnzCredentials": { "apiKey": "<string>" },
"urbanAirshipCredentials": {
"apiKey": "<string>",
"masterSecret": "<string>"
},
"veriff": {
"apiKey": "<string>",
"apiSecret": "<string>"
},
"iproov": {
"apiKey": "<string>",
"apiSecret": "<string>",
"baseUrl": "<string>"
},
"idverseCredentials": {
"apiKey": "<string>",
"apiSecret": "<string>"
},
"messageMediaCredentials": {
"apiKey": "<string>",
"apiSecret": "<string>",
"sourceNumber": "<string>"
},
"mailjetEmailCredentials": {
"privateKey": "<string>",
"publicKey": "<string>",
"templateId": "<string>"
},
"mailgunEmailCredentials": {
"apiKey": "<string>",
"url": "<string>",
"domain": "<string>",
"from": "<string>"
},
"smtpEmailCredentials": {
"host": "<string>",
"port": 123,
"secure": True,
"username": "<string>",
"password": "<string>",
"from": "<string>",
"fromName": "<string>"
},
"birdEmailCredentials": {
"accessKey": "<string>",
"workspaceId": "<string>",
"channelId": "<string>",
"projectId": "<string>",
"versionId": "<string>",
"locale": "<string>",
"senderEmail": "<string>",
"senderName": "<string>"
}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
authenticatorId: '<string>',
authenticatorType: '<unknown>',
isActive: true,
isEditableByUser: true,
isHiddenToUser: true,
webhookUrl: '<string>',
messageTemplate: '<string>',
sender: '<string>',
relyingParty: '<string>',
expectedOrigins: ['<string>'],
verificationCodeLength: 6,
enrollmentPromptInterval: 123,
hideTotpAppDownloadScreen: true,
issuerName: '<string>',
sessionTtlInMinutes: 30,
showEmailDeliveryTimeWarning: true,
smsCountryCodes: ['<string>'],
allowMultipleUserAuthenticators: true,
rateLimitConfiguration: {rateLimit: 50, windowInMinutes: 720},
sendingRateLimitConfiguration: {rateLimit: 50, windowInMinutes: 720},
passkeyRegistrationHints: [],
whatsAppProvider: 'BIRD',
redirectUrls: ['<string>'],
dontSkipEnrollmentInputScreen: true,
documentTypes: {},
recoveryMethods: [],
disableEnrollmentPrompt: true,
requireDeviceIntegrity: true,
twilioCredentials: {accountSid: '<string>', messagingServiceSid: '<string>', authToken: '<string>'},
messageBirdV2Credentials: {
accessKey: '<string>',
workspaceId: '<string>',
channelId: '<string>',
navigatorId: '<string>',
projectId: '<string>',
locale: '<string>',
enableMessageTemplates: true
},
modicaGroupCredentials: {username: '<string>', password: '<string>'},
tnzCredentials: {apiKey: '<string>'},
urbanAirshipCredentials: {apiKey: '<string>', masterSecret: '<string>'},
veriff: {apiKey: '<string>', apiSecret: '<string>'},
iproov: {apiKey: '<string>', apiSecret: '<string>', baseUrl: '<string>'},
idverseCredentials: {apiKey: '<string>', apiSecret: '<string>'},
messageMediaCredentials: {apiKey: '<string>', apiSecret: '<string>', sourceNumber: '<string>'},
mailjetEmailCredentials: {privateKey: '<string>', publicKey: '<string>', templateId: '<string>'},
mailgunEmailCredentials: {apiKey: '<string>', url: '<string>', domain: '<string>', from: '<string>'},
smtpEmailCredentials: {
host: '<string>',
port: 123,
secure: true,
username: '<string>',
password: '<string>',
from: '<string>',
fromName: '<string>'
},
birdEmailCredentials: {
accessKey: '<string>',
workspaceId: '<string>',
channelId: '<string>',
projectId: '<string>',
versionId: '<string>',
locale: '<string>',
senderEmail: '<string>',
senderName: '<string>'
}
})
};
fetch('https://api.authsignal.com/v1/management/authenticator-configurations/{authenticator_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.authsignal.com/v1/management/authenticator-configurations/{authenticator_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'authenticatorId' => '<string>',
'authenticatorType' => '<unknown>',
'isActive' => true,
'isEditableByUser' => true,
'isHiddenToUser' => true,
'webhookUrl' => '<string>',
'messageTemplate' => '<string>',
'sender' => '<string>',
'relyingParty' => '<string>',
'expectedOrigins' => [
'<string>'
],
'verificationCodeLength' => 6,
'enrollmentPromptInterval' => 123,
'hideTotpAppDownloadScreen' => true,
'issuerName' => '<string>',
'sessionTtlInMinutes' => 30,
'showEmailDeliveryTimeWarning' => true,
'smsCountryCodes' => [
'<string>'
],
'allowMultipleUserAuthenticators' => true,
'rateLimitConfiguration' => [
'rateLimit' => 50,
'windowInMinutes' => 720
],
'sendingRateLimitConfiguration' => [
'rateLimit' => 50,
'windowInMinutes' => 720
],
'passkeyRegistrationHints' => [
],
'whatsAppProvider' => 'BIRD',
'redirectUrls' => [
'<string>'
],
'dontSkipEnrollmentInputScreen' => true,
'documentTypes' => [
],
'recoveryMethods' => [
],
'disableEnrollmentPrompt' => true,
'requireDeviceIntegrity' => true,
'twilioCredentials' => [
'accountSid' => '<string>',
'messagingServiceSid' => '<string>',
'authToken' => '<string>'
],
'messageBirdV2Credentials' => [
'accessKey' => '<string>',
'workspaceId' => '<string>',
'channelId' => '<string>',
'navigatorId' => '<string>',
'projectId' => '<string>',
'locale' => '<string>',
'enableMessageTemplates' => true
],
'modicaGroupCredentials' => [
'username' => '<string>',
'password' => '<string>'
],
'tnzCredentials' => [
'apiKey' => '<string>'
],
'urbanAirshipCredentials' => [
'apiKey' => '<string>',
'masterSecret' => '<string>'
],
'veriff' => [
'apiKey' => '<string>',
'apiSecret' => '<string>'
],
'iproov' => [
'apiKey' => '<string>',
'apiSecret' => '<string>',
'baseUrl' => '<string>'
],
'idverseCredentials' => [
'apiKey' => '<string>',
'apiSecret' => '<string>'
],
'messageMediaCredentials' => [
'apiKey' => '<string>',
'apiSecret' => '<string>',
'sourceNumber' => '<string>'
],
'mailjetEmailCredentials' => [
'privateKey' => '<string>',
'publicKey' => '<string>',
'templateId' => '<string>'
],
'mailgunEmailCredentials' => [
'apiKey' => '<string>',
'url' => '<string>',
'domain' => '<string>',
'from' => '<string>'
],
'smtpEmailCredentials' => [
'host' => '<string>',
'port' => 123,
'secure' => true,
'username' => '<string>',
'password' => '<string>',
'from' => '<string>',
'fromName' => '<string>'
],
'birdEmailCredentials' => [
'accessKey' => '<string>',
'workspaceId' => '<string>',
'channelId' => '<string>',
'projectId' => '<string>',
'versionId' => '<string>',
'locale' => '<string>',
'senderEmail' => '<string>',
'senderName' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.authsignal.com/v1/management/authenticator-configurations/{authenticator_id}"
payload := strings.NewReader("{\n \"authenticatorId\": \"<string>\",\n \"authenticatorType\": \"<unknown>\",\n \"isActive\": true,\n \"isEditableByUser\": true,\n \"isHiddenToUser\": true,\n \"webhookUrl\": \"<string>\",\n \"messageTemplate\": \"<string>\",\n \"sender\": \"<string>\",\n \"relyingParty\": \"<string>\",\n \"expectedOrigins\": [\n \"<string>\"\n ],\n \"verificationCodeLength\": 6,\n \"enrollmentPromptInterval\": 123,\n \"hideTotpAppDownloadScreen\": true,\n \"issuerName\": \"<string>\",\n \"sessionTtlInMinutes\": 30,\n \"showEmailDeliveryTimeWarning\": true,\n \"smsCountryCodes\": [\n \"<string>\"\n ],\n \"allowMultipleUserAuthenticators\": true,\n \"rateLimitConfiguration\": {\n \"rateLimit\": 50,\n \"windowInMinutes\": 720\n },\n \"sendingRateLimitConfiguration\": {\n \"rateLimit\": 50,\n \"windowInMinutes\": 720\n },\n \"passkeyRegistrationHints\": [],\n \"whatsAppProvider\": \"BIRD\",\n \"redirectUrls\": [\n \"<string>\"\n ],\n \"dontSkipEnrollmentInputScreen\": true,\n \"documentTypes\": {},\n \"recoveryMethods\": [],\n \"disableEnrollmentPrompt\": true,\n \"requireDeviceIntegrity\": true,\n \"twilioCredentials\": {\n \"accountSid\": \"<string>\",\n \"messagingServiceSid\": \"<string>\",\n \"authToken\": \"<string>\"\n },\n \"messageBirdV2Credentials\": {\n \"accessKey\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"channelId\": \"<string>\",\n \"navigatorId\": \"<string>\",\n \"projectId\": \"<string>\",\n \"locale\": \"<string>\",\n \"enableMessageTemplates\": true\n },\n \"modicaGroupCredentials\": {\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n },\n \"tnzCredentials\": {\n \"apiKey\": \"<string>\"\n },\n \"urbanAirshipCredentials\": {\n \"apiKey\": \"<string>\",\n \"masterSecret\": \"<string>\"\n },\n \"veriff\": {\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\"\n },\n \"iproov\": {\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\",\n \"baseUrl\": \"<string>\"\n },\n \"idverseCredentials\": {\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\"\n },\n \"messageMediaCredentials\": {\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\",\n \"sourceNumber\": \"<string>\"\n },\n \"mailjetEmailCredentials\": {\n \"privateKey\": \"<string>\",\n \"publicKey\": \"<string>\",\n \"templateId\": \"<string>\"\n },\n \"mailgunEmailCredentials\": {\n \"apiKey\": \"<string>\",\n \"url\": \"<string>\",\n \"domain\": \"<string>\",\n \"from\": \"<string>\"\n },\n \"smtpEmailCredentials\": {\n \"host\": \"<string>\",\n \"port\": 123,\n \"secure\": true,\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"from\": \"<string>\",\n \"fromName\": \"<string>\"\n },\n \"birdEmailCredentials\": {\n \"accessKey\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"channelId\": \"<string>\",\n \"projectId\": \"<string>\",\n \"versionId\": \"<string>\",\n \"locale\": \"<string>\",\n \"senderEmail\": \"<string>\",\n \"senderName\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.authsignal.com/v1/management/authenticator-configurations/{authenticator_id}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"authenticatorId\": \"<string>\",\n \"authenticatorType\": \"<unknown>\",\n \"isActive\": true,\n \"isEditableByUser\": true,\n \"isHiddenToUser\": true,\n \"webhookUrl\": \"<string>\",\n \"messageTemplate\": \"<string>\",\n \"sender\": \"<string>\",\n \"relyingParty\": \"<string>\",\n \"expectedOrigins\": [\n \"<string>\"\n ],\n \"verificationCodeLength\": 6,\n \"enrollmentPromptInterval\": 123,\n \"hideTotpAppDownloadScreen\": true,\n \"issuerName\": \"<string>\",\n \"sessionTtlInMinutes\": 30,\n \"showEmailDeliveryTimeWarning\": true,\n \"smsCountryCodes\": [\n \"<string>\"\n ],\n \"allowMultipleUserAuthenticators\": true,\n \"rateLimitConfiguration\": {\n \"rateLimit\": 50,\n \"windowInMinutes\": 720\n },\n \"sendingRateLimitConfiguration\": {\n \"rateLimit\": 50,\n \"windowInMinutes\": 720\n },\n \"passkeyRegistrationHints\": [],\n \"whatsAppProvider\": \"BIRD\",\n \"redirectUrls\": [\n \"<string>\"\n ],\n \"dontSkipEnrollmentInputScreen\": true,\n \"documentTypes\": {},\n \"recoveryMethods\": [],\n \"disableEnrollmentPrompt\": true,\n \"requireDeviceIntegrity\": true,\n \"twilioCredentials\": {\n \"accountSid\": \"<string>\",\n \"messagingServiceSid\": \"<string>\",\n \"authToken\": \"<string>\"\n },\n \"messageBirdV2Credentials\": {\n \"accessKey\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"channelId\": \"<string>\",\n \"navigatorId\": \"<string>\",\n \"projectId\": \"<string>\",\n \"locale\": \"<string>\",\n \"enableMessageTemplates\": true\n },\n \"modicaGroupCredentials\": {\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n },\n \"tnzCredentials\": {\n \"apiKey\": \"<string>\"\n },\n \"urbanAirshipCredentials\": {\n \"apiKey\": \"<string>\",\n \"masterSecret\": \"<string>\"\n },\n \"veriff\": {\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\"\n },\n \"iproov\": {\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\",\n \"baseUrl\": \"<string>\"\n },\n \"idverseCredentials\": {\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\"\n },\n \"messageMediaCredentials\": {\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\",\n \"sourceNumber\": \"<string>\"\n },\n \"mailjetEmailCredentials\": {\n \"privateKey\": \"<string>\",\n \"publicKey\": \"<string>\",\n \"templateId\": \"<string>\"\n },\n \"mailgunEmailCredentials\": {\n \"apiKey\": \"<string>\",\n \"url\": \"<string>\",\n \"domain\": \"<string>\",\n \"from\": \"<string>\"\n },\n \"smtpEmailCredentials\": {\n \"host\": \"<string>\",\n \"port\": 123,\n \"secure\": true,\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"from\": \"<string>\",\n \"fromName\": \"<string>\"\n },\n \"birdEmailCredentials\": {\n \"accessKey\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"channelId\": \"<string>\",\n \"projectId\": \"<string>\",\n \"versionId\": \"<string>\",\n \"locale\": \"<string>\",\n \"senderEmail\": \"<string>\",\n \"senderName\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.authsignal.com/v1/management/authenticator-configurations/{authenticator_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"authenticatorId\": \"<string>\",\n \"authenticatorType\": \"<unknown>\",\n \"isActive\": true,\n \"isEditableByUser\": true,\n \"isHiddenToUser\": true,\n \"webhookUrl\": \"<string>\",\n \"messageTemplate\": \"<string>\",\n \"sender\": \"<string>\",\n \"relyingParty\": \"<string>\",\n \"expectedOrigins\": [\n \"<string>\"\n ],\n \"verificationCodeLength\": 6,\n \"enrollmentPromptInterval\": 123,\n \"hideTotpAppDownloadScreen\": true,\n \"issuerName\": \"<string>\",\n \"sessionTtlInMinutes\": 30,\n \"showEmailDeliveryTimeWarning\": true,\n \"smsCountryCodes\": [\n \"<string>\"\n ],\n \"allowMultipleUserAuthenticators\": true,\n \"rateLimitConfiguration\": {\n \"rateLimit\": 50,\n \"windowInMinutes\": 720\n },\n \"sendingRateLimitConfiguration\": {\n \"rateLimit\": 50,\n \"windowInMinutes\": 720\n },\n \"passkeyRegistrationHints\": [],\n \"whatsAppProvider\": \"BIRD\",\n \"redirectUrls\": [\n \"<string>\"\n ],\n \"dontSkipEnrollmentInputScreen\": true,\n \"documentTypes\": {},\n \"recoveryMethods\": [],\n \"disableEnrollmentPrompt\": true,\n \"requireDeviceIntegrity\": true,\n \"twilioCredentials\": {\n \"accountSid\": \"<string>\",\n \"messagingServiceSid\": \"<string>\",\n \"authToken\": \"<string>\"\n },\n \"messageBirdV2Credentials\": {\n \"accessKey\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"channelId\": \"<string>\",\n \"navigatorId\": \"<string>\",\n \"projectId\": \"<string>\",\n \"locale\": \"<string>\",\n \"enableMessageTemplates\": true\n },\n \"modicaGroupCredentials\": {\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n },\n \"tnzCredentials\": {\n \"apiKey\": \"<string>\"\n },\n \"urbanAirshipCredentials\": {\n \"apiKey\": \"<string>\",\n \"masterSecret\": \"<string>\"\n },\n \"veriff\": {\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\"\n },\n \"iproov\": {\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\",\n \"baseUrl\": \"<string>\"\n },\n \"idverseCredentials\": {\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\"\n },\n \"messageMediaCredentials\": {\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\",\n \"sourceNumber\": \"<string>\"\n },\n \"mailjetEmailCredentials\": {\n \"privateKey\": \"<string>\",\n \"publicKey\": \"<string>\",\n \"templateId\": \"<string>\"\n },\n \"mailgunEmailCredentials\": {\n \"apiKey\": \"<string>\",\n \"url\": \"<string>\",\n \"domain\": \"<string>\",\n \"from\": \"<string>\"\n },\n \"smtpEmailCredentials\": {\n \"host\": \"<string>\",\n \"port\": 123,\n \"secure\": true,\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"from\": \"<string>\",\n \"fromName\": \"<string>\"\n },\n \"birdEmailCredentials\": {\n \"accessKey\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"channelId\": \"<string>\",\n \"projectId\": \"<string>\",\n \"versionId\": \"<string>\",\n \"locale\": \"<string>\",\n \"senderEmail\": \"<string>\",\n \"senderName\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"authenticatorId": "<string>",
"authenticatorType": "<unknown>",
"isActive": true,
"isEditableByUser": true,
"isHiddenToUser": true,
"webhookUrl": "<string>",
"messageTemplate": "<string>",
"sender": "<string>",
"relyingParty": "<string>",
"expectedOrigins": [
"<string>"
],
"verificationCodeLength": 6,
"enrollmentPromptInterval": 123,
"hideTotpAppDownloadScreen": true,
"issuerName": "<string>",
"sessionTtlInMinutes": 30,
"showEmailDeliveryTimeWarning": true,
"smsCountryCodes": [
"<string>"
],
"allowMultipleUserAuthenticators": true,
"rateLimitConfiguration": {
"rateLimit": 50,
"windowInMinutes": 720
},
"sendingRateLimitConfiguration": {
"rateLimit": 50,
"windowInMinutes": 720
},
"passkeyRegistrationHints": [],
"whatsAppProvider": "BIRD",
"redirectUrls": [
"<string>"
],
"dontSkipEnrollmentInputScreen": true,
"documentTypes": {},
"recoveryMethods": [],
"disableEnrollmentPrompt": true,
"requireDeviceIntegrity": true,
"twilioCredentials": {
"accountSid": "<string>",
"messagingServiceSid": "<string>",
"authToken": "<string>"
},
"messageBirdV2Credentials": {
"accessKey": "<string>",
"workspaceId": "<string>",
"channelId": "<string>",
"navigatorId": "<string>",
"projectId": "<string>",
"locale": "<string>",
"enableMessageTemplates": true
},
"modicaGroupCredentials": {
"username": "<string>",
"password": "<string>"
},
"tnzCredentials": {
"apiKey": "<string>"
},
"urbanAirshipCredentials": {
"apiKey": "<string>",
"masterSecret": "<string>"
},
"veriff": {
"apiKey": "<string>",
"apiSecret": "<string>"
},
"iproov": {
"apiKey": "<string>",
"apiSecret": "<string>",
"baseUrl": "<string>"
},
"idverseCredentials": {
"apiKey": "<string>",
"apiSecret": "<string>"
},
"messageMediaCredentials": {
"apiKey": "<string>",
"apiSecret": "<string>",
"sourceNumber": "<string>"
},
"mailjetEmailCredentials": {
"privateKey": "<string>",
"publicKey": "<string>",
"templateId": "<string>"
},
"mailgunEmailCredentials": {
"apiKey": "<string>",
"url": "<string>",
"domain": "<string>",
"from": "<string>"
},
"smtpEmailCredentials": {
"host": "<string>",
"port": 123,
"secure": true,
"username": "<string>",
"password": "<string>",
"from": "<string>",
"fromName": "<string>"
},
"birdEmailCredentials": {
"accessKey": "<string>",
"workspaceId": "<string>",
"channelId": "<string>",
"projectId": "<string>",
"versionId": "<string>",
"locale": "<string>",
"senderEmail": "<string>",
"senderName": "<string>"
}
}Authorizations
Use your Authsignal Management API secret key as the username and leave the password empty. This key is different from the Server API key and can be found in the API Keys section of the Authsignal Portal settings page.
Path Parameters
The authenticator ID used to identify the authenticator configuration.
Body
An authenticator configuration (tenant-level settings for an authentication method).
Unique identifier for this configuration
SMS, AUTHENTICATOR_APP, RECOVERY_CODE, EMAIL_MAGIC_LINK, EMAIL_OTP, PUSH, DEVICE, SECURITY_KEY, PASSKEY, VERIFF, IPROOV, PALM_BIOMETRICS_RR, IDVERSE EMAIL_OTP, EMAIL_MAGIC_LINK, SMS TWILIO, MESSAGE_BIRD, MESSAGE_BIRD_V2, MODICA_GROUP, TNZ, WEBHOOK DEFAULT, WHATSAPP SES, SMTP, AIRNZ, WEBHOOK, MAILJET, MAILGUN, BIRD, MANDRILL, SENDGRID URBAN_AIRSHIP, WEBHOOK NEW_TAB, ORIGINAL_TAB VERIFF, IPROOV, PALM_BIOMETRICS_RR, IDVERSE 2 <= x <= 100 <= x <= 60discouraged, preferred, required cross-platform, platform, all-supported ISO country codes for SMS (e.g. US, GB)
Show child attributes
Show child attributes
Show child attributes
Show child attributes
security-key, client-device, hybrid BIRD Show child attributes
Show child attributes
SMS, AUTHENTICATOR_APP, RECOVERY_CODE, EMAIL_MAGIC_LINK, EMAIL_OTP, PUSH, DEVICE, SECURITY_KEY, PASSKEY, VERIFF, IPROOV, PALM_BIOMETRICS_RR, IDVERSE BLOCK, ALLOW_WITH_WARNING Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
OK
An authenticator configuration (tenant-level settings for an authentication method).
Unique identifier for this configuration
SMS, AUTHENTICATOR_APP, RECOVERY_CODE, EMAIL_MAGIC_LINK, EMAIL_OTP, PUSH, DEVICE, SECURITY_KEY, PASSKEY, VERIFF, IPROOV, PALM_BIOMETRICS_RR, IDVERSE EMAIL_OTP, EMAIL_MAGIC_LINK, SMS TWILIO, MESSAGE_BIRD, MESSAGE_BIRD_V2, MODICA_GROUP, TNZ, WEBHOOK DEFAULT, WHATSAPP SES, SMTP, AIRNZ, WEBHOOK, MAILJET, MAILGUN, BIRD, MANDRILL, SENDGRID URBAN_AIRSHIP, WEBHOOK NEW_TAB, ORIGINAL_TAB VERIFF, IPROOV, PALM_BIOMETRICS_RR, IDVERSE 2 <= x <= 100 <= x <= 60discouraged, preferred, required cross-platform, platform, all-supported ISO country codes for SMS (e.g. US, GB)
Show child attributes
Show child attributes
Show child attributes
Show child attributes
security-key, client-device, hybrid BIRD Show child attributes
Show child attributes
SMS, AUTHENTICATOR_APP, RECOVERY_CODE, EMAIL_MAGIC_LINK, EMAIL_OTP, PUSH, DEVICE, SECURITY_KEY, PASSKEY, VERIFF, IPROOV, PALM_BIOMETRICS_RR, IDVERSE BLOCK, ALLOW_WITH_WARNING Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
curl --request PATCH \
--url https://api.authsignal.com/v1/management/authenticator-configurations/{authenticator_id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"authenticatorId": "<string>",
"authenticatorType": "<unknown>",
"isActive": true,
"isEditableByUser": true,
"isHiddenToUser": true,
"webhookUrl": "<string>",
"messageTemplate": "<string>",
"sender": "<string>",
"relyingParty": "<string>",
"expectedOrigins": [
"<string>"
],
"verificationCodeLength": 6,
"enrollmentPromptInterval": 123,
"hideTotpAppDownloadScreen": true,
"issuerName": "<string>",
"sessionTtlInMinutes": 30,
"showEmailDeliveryTimeWarning": true,
"smsCountryCodes": [
"<string>"
],
"allowMultipleUserAuthenticators": true,
"rateLimitConfiguration": {
"rateLimit": 50,
"windowInMinutes": 720
},
"sendingRateLimitConfiguration": {
"rateLimit": 50,
"windowInMinutes": 720
},
"passkeyRegistrationHints": [],
"whatsAppProvider": "BIRD",
"redirectUrls": [
"<string>"
],
"dontSkipEnrollmentInputScreen": true,
"documentTypes": {},
"recoveryMethods": [],
"disableEnrollmentPrompt": true,
"requireDeviceIntegrity": true,
"twilioCredentials": {
"accountSid": "<string>",
"messagingServiceSid": "<string>",
"authToken": "<string>"
},
"messageBirdV2Credentials": {
"accessKey": "<string>",
"workspaceId": "<string>",
"channelId": "<string>",
"navigatorId": "<string>",
"projectId": "<string>",
"locale": "<string>",
"enableMessageTemplates": true
},
"modicaGroupCredentials": {
"username": "<string>",
"password": "<string>"
},
"tnzCredentials": {
"apiKey": "<string>"
},
"urbanAirshipCredentials": {
"apiKey": "<string>",
"masterSecret": "<string>"
},
"veriff": {
"apiKey": "<string>",
"apiSecret": "<string>"
},
"iproov": {
"apiKey": "<string>",
"apiSecret": "<string>",
"baseUrl": "<string>"
},
"idverseCredentials": {
"apiKey": "<string>",
"apiSecret": "<string>"
},
"messageMediaCredentials": {
"apiKey": "<string>",
"apiSecret": "<string>",
"sourceNumber": "<string>"
},
"mailjetEmailCredentials": {
"privateKey": "<string>",
"publicKey": "<string>",
"templateId": "<string>"
},
"mailgunEmailCredentials": {
"apiKey": "<string>",
"url": "<string>",
"domain": "<string>",
"from": "<string>"
},
"smtpEmailCredentials": {
"host": "<string>",
"port": 123,
"secure": true,
"username": "<string>",
"password": "<string>",
"from": "<string>",
"fromName": "<string>"
},
"birdEmailCredentials": {
"accessKey": "<string>",
"workspaceId": "<string>",
"channelId": "<string>",
"projectId": "<string>",
"versionId": "<string>",
"locale": "<string>",
"senderEmail": "<string>",
"senderName": "<string>"
}
}
'import requests
url = "https://api.authsignal.com/v1/management/authenticator-configurations/{authenticator_id}"
payload = {
"authenticatorId": "<string>",
"authenticatorType": "<unknown>",
"isActive": True,
"isEditableByUser": True,
"isHiddenToUser": True,
"webhookUrl": "<string>",
"messageTemplate": "<string>",
"sender": "<string>",
"relyingParty": "<string>",
"expectedOrigins": ["<string>"],
"verificationCodeLength": 6,
"enrollmentPromptInterval": 123,
"hideTotpAppDownloadScreen": True,
"issuerName": "<string>",
"sessionTtlInMinutes": 30,
"showEmailDeliveryTimeWarning": True,
"smsCountryCodes": ["<string>"],
"allowMultipleUserAuthenticators": True,
"rateLimitConfiguration": {
"rateLimit": 50,
"windowInMinutes": 720
},
"sendingRateLimitConfiguration": {
"rateLimit": 50,
"windowInMinutes": 720
},
"passkeyRegistrationHints": [],
"whatsAppProvider": "BIRD",
"redirectUrls": ["<string>"],
"dontSkipEnrollmentInputScreen": True,
"documentTypes": {},
"recoveryMethods": [],
"disableEnrollmentPrompt": True,
"requireDeviceIntegrity": True,
"twilioCredentials": {
"accountSid": "<string>",
"messagingServiceSid": "<string>",
"authToken": "<string>"
},
"messageBirdV2Credentials": {
"accessKey": "<string>",
"workspaceId": "<string>",
"channelId": "<string>",
"navigatorId": "<string>",
"projectId": "<string>",
"locale": "<string>",
"enableMessageTemplates": True
},
"modicaGroupCredentials": {
"username": "<string>",
"password": "<string>"
},
"tnzCredentials": { "apiKey": "<string>" },
"urbanAirshipCredentials": {
"apiKey": "<string>",
"masterSecret": "<string>"
},
"veriff": {
"apiKey": "<string>",
"apiSecret": "<string>"
},
"iproov": {
"apiKey": "<string>",
"apiSecret": "<string>",
"baseUrl": "<string>"
},
"idverseCredentials": {
"apiKey": "<string>",
"apiSecret": "<string>"
},
"messageMediaCredentials": {
"apiKey": "<string>",
"apiSecret": "<string>",
"sourceNumber": "<string>"
},
"mailjetEmailCredentials": {
"privateKey": "<string>",
"publicKey": "<string>",
"templateId": "<string>"
},
"mailgunEmailCredentials": {
"apiKey": "<string>",
"url": "<string>",
"domain": "<string>",
"from": "<string>"
},
"smtpEmailCredentials": {
"host": "<string>",
"port": 123,
"secure": True,
"username": "<string>",
"password": "<string>",
"from": "<string>",
"fromName": "<string>"
},
"birdEmailCredentials": {
"accessKey": "<string>",
"workspaceId": "<string>",
"channelId": "<string>",
"projectId": "<string>",
"versionId": "<string>",
"locale": "<string>",
"senderEmail": "<string>",
"senderName": "<string>"
}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
authenticatorId: '<string>',
authenticatorType: '<unknown>',
isActive: true,
isEditableByUser: true,
isHiddenToUser: true,
webhookUrl: '<string>',
messageTemplate: '<string>',
sender: '<string>',
relyingParty: '<string>',
expectedOrigins: ['<string>'],
verificationCodeLength: 6,
enrollmentPromptInterval: 123,
hideTotpAppDownloadScreen: true,
issuerName: '<string>',
sessionTtlInMinutes: 30,
showEmailDeliveryTimeWarning: true,
smsCountryCodes: ['<string>'],
allowMultipleUserAuthenticators: true,
rateLimitConfiguration: {rateLimit: 50, windowInMinutes: 720},
sendingRateLimitConfiguration: {rateLimit: 50, windowInMinutes: 720},
passkeyRegistrationHints: [],
whatsAppProvider: 'BIRD',
redirectUrls: ['<string>'],
dontSkipEnrollmentInputScreen: true,
documentTypes: {},
recoveryMethods: [],
disableEnrollmentPrompt: true,
requireDeviceIntegrity: true,
twilioCredentials: {accountSid: '<string>', messagingServiceSid: '<string>', authToken: '<string>'},
messageBirdV2Credentials: {
accessKey: '<string>',
workspaceId: '<string>',
channelId: '<string>',
navigatorId: '<string>',
projectId: '<string>',
locale: '<string>',
enableMessageTemplates: true
},
modicaGroupCredentials: {username: '<string>', password: '<string>'},
tnzCredentials: {apiKey: '<string>'},
urbanAirshipCredentials: {apiKey: '<string>', masterSecret: '<string>'},
veriff: {apiKey: '<string>', apiSecret: '<string>'},
iproov: {apiKey: '<string>', apiSecret: '<string>', baseUrl: '<string>'},
idverseCredentials: {apiKey: '<string>', apiSecret: '<string>'},
messageMediaCredentials: {apiKey: '<string>', apiSecret: '<string>', sourceNumber: '<string>'},
mailjetEmailCredentials: {privateKey: '<string>', publicKey: '<string>', templateId: '<string>'},
mailgunEmailCredentials: {apiKey: '<string>', url: '<string>', domain: '<string>', from: '<string>'},
smtpEmailCredentials: {
host: '<string>',
port: 123,
secure: true,
username: '<string>',
password: '<string>',
from: '<string>',
fromName: '<string>'
},
birdEmailCredentials: {
accessKey: '<string>',
workspaceId: '<string>',
channelId: '<string>',
projectId: '<string>',
versionId: '<string>',
locale: '<string>',
senderEmail: '<string>',
senderName: '<string>'
}
})
};
fetch('https://api.authsignal.com/v1/management/authenticator-configurations/{authenticator_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.authsignal.com/v1/management/authenticator-configurations/{authenticator_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'authenticatorId' => '<string>',
'authenticatorType' => '<unknown>',
'isActive' => true,
'isEditableByUser' => true,
'isHiddenToUser' => true,
'webhookUrl' => '<string>',
'messageTemplate' => '<string>',
'sender' => '<string>',
'relyingParty' => '<string>',
'expectedOrigins' => [
'<string>'
],
'verificationCodeLength' => 6,
'enrollmentPromptInterval' => 123,
'hideTotpAppDownloadScreen' => true,
'issuerName' => '<string>',
'sessionTtlInMinutes' => 30,
'showEmailDeliveryTimeWarning' => true,
'smsCountryCodes' => [
'<string>'
],
'allowMultipleUserAuthenticators' => true,
'rateLimitConfiguration' => [
'rateLimit' => 50,
'windowInMinutes' => 720
],
'sendingRateLimitConfiguration' => [
'rateLimit' => 50,
'windowInMinutes' => 720
],
'passkeyRegistrationHints' => [
],
'whatsAppProvider' => 'BIRD',
'redirectUrls' => [
'<string>'
],
'dontSkipEnrollmentInputScreen' => true,
'documentTypes' => [
],
'recoveryMethods' => [
],
'disableEnrollmentPrompt' => true,
'requireDeviceIntegrity' => true,
'twilioCredentials' => [
'accountSid' => '<string>',
'messagingServiceSid' => '<string>',
'authToken' => '<string>'
],
'messageBirdV2Credentials' => [
'accessKey' => '<string>',
'workspaceId' => '<string>',
'channelId' => '<string>',
'navigatorId' => '<string>',
'projectId' => '<string>',
'locale' => '<string>',
'enableMessageTemplates' => true
],
'modicaGroupCredentials' => [
'username' => '<string>',
'password' => '<string>'
],
'tnzCredentials' => [
'apiKey' => '<string>'
],
'urbanAirshipCredentials' => [
'apiKey' => '<string>',
'masterSecret' => '<string>'
],
'veriff' => [
'apiKey' => '<string>',
'apiSecret' => '<string>'
],
'iproov' => [
'apiKey' => '<string>',
'apiSecret' => '<string>',
'baseUrl' => '<string>'
],
'idverseCredentials' => [
'apiKey' => '<string>',
'apiSecret' => '<string>'
],
'messageMediaCredentials' => [
'apiKey' => '<string>',
'apiSecret' => '<string>',
'sourceNumber' => '<string>'
],
'mailjetEmailCredentials' => [
'privateKey' => '<string>',
'publicKey' => '<string>',
'templateId' => '<string>'
],
'mailgunEmailCredentials' => [
'apiKey' => '<string>',
'url' => '<string>',
'domain' => '<string>',
'from' => '<string>'
],
'smtpEmailCredentials' => [
'host' => '<string>',
'port' => 123,
'secure' => true,
'username' => '<string>',
'password' => '<string>',
'from' => '<string>',
'fromName' => '<string>'
],
'birdEmailCredentials' => [
'accessKey' => '<string>',
'workspaceId' => '<string>',
'channelId' => '<string>',
'projectId' => '<string>',
'versionId' => '<string>',
'locale' => '<string>',
'senderEmail' => '<string>',
'senderName' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.authsignal.com/v1/management/authenticator-configurations/{authenticator_id}"
payload := strings.NewReader("{\n \"authenticatorId\": \"<string>\",\n \"authenticatorType\": \"<unknown>\",\n \"isActive\": true,\n \"isEditableByUser\": true,\n \"isHiddenToUser\": true,\n \"webhookUrl\": \"<string>\",\n \"messageTemplate\": \"<string>\",\n \"sender\": \"<string>\",\n \"relyingParty\": \"<string>\",\n \"expectedOrigins\": [\n \"<string>\"\n ],\n \"verificationCodeLength\": 6,\n \"enrollmentPromptInterval\": 123,\n \"hideTotpAppDownloadScreen\": true,\n \"issuerName\": \"<string>\",\n \"sessionTtlInMinutes\": 30,\n \"showEmailDeliveryTimeWarning\": true,\n \"smsCountryCodes\": [\n \"<string>\"\n ],\n \"allowMultipleUserAuthenticators\": true,\n \"rateLimitConfiguration\": {\n \"rateLimit\": 50,\n \"windowInMinutes\": 720\n },\n \"sendingRateLimitConfiguration\": {\n \"rateLimit\": 50,\n \"windowInMinutes\": 720\n },\n \"passkeyRegistrationHints\": [],\n \"whatsAppProvider\": \"BIRD\",\n \"redirectUrls\": [\n \"<string>\"\n ],\n \"dontSkipEnrollmentInputScreen\": true,\n \"documentTypes\": {},\n \"recoveryMethods\": [],\n \"disableEnrollmentPrompt\": true,\n \"requireDeviceIntegrity\": true,\n \"twilioCredentials\": {\n \"accountSid\": \"<string>\",\n \"messagingServiceSid\": \"<string>\",\n \"authToken\": \"<string>\"\n },\n \"messageBirdV2Credentials\": {\n \"accessKey\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"channelId\": \"<string>\",\n \"navigatorId\": \"<string>\",\n \"projectId\": \"<string>\",\n \"locale\": \"<string>\",\n \"enableMessageTemplates\": true\n },\n \"modicaGroupCredentials\": {\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n },\n \"tnzCredentials\": {\n \"apiKey\": \"<string>\"\n },\n \"urbanAirshipCredentials\": {\n \"apiKey\": \"<string>\",\n \"masterSecret\": \"<string>\"\n },\n \"veriff\": {\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\"\n },\n \"iproov\": {\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\",\n \"baseUrl\": \"<string>\"\n },\n \"idverseCredentials\": {\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\"\n },\n \"messageMediaCredentials\": {\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\",\n \"sourceNumber\": \"<string>\"\n },\n \"mailjetEmailCredentials\": {\n \"privateKey\": \"<string>\",\n \"publicKey\": \"<string>\",\n \"templateId\": \"<string>\"\n },\n \"mailgunEmailCredentials\": {\n \"apiKey\": \"<string>\",\n \"url\": \"<string>\",\n \"domain\": \"<string>\",\n \"from\": \"<string>\"\n },\n \"smtpEmailCredentials\": {\n \"host\": \"<string>\",\n \"port\": 123,\n \"secure\": true,\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"from\": \"<string>\",\n \"fromName\": \"<string>\"\n },\n \"birdEmailCredentials\": {\n \"accessKey\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"channelId\": \"<string>\",\n \"projectId\": \"<string>\",\n \"versionId\": \"<string>\",\n \"locale\": \"<string>\",\n \"senderEmail\": \"<string>\",\n \"senderName\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.authsignal.com/v1/management/authenticator-configurations/{authenticator_id}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"authenticatorId\": \"<string>\",\n \"authenticatorType\": \"<unknown>\",\n \"isActive\": true,\n \"isEditableByUser\": true,\n \"isHiddenToUser\": true,\n \"webhookUrl\": \"<string>\",\n \"messageTemplate\": \"<string>\",\n \"sender\": \"<string>\",\n \"relyingParty\": \"<string>\",\n \"expectedOrigins\": [\n \"<string>\"\n ],\n \"verificationCodeLength\": 6,\n \"enrollmentPromptInterval\": 123,\n \"hideTotpAppDownloadScreen\": true,\n \"issuerName\": \"<string>\",\n \"sessionTtlInMinutes\": 30,\n \"showEmailDeliveryTimeWarning\": true,\n \"smsCountryCodes\": [\n \"<string>\"\n ],\n \"allowMultipleUserAuthenticators\": true,\n \"rateLimitConfiguration\": {\n \"rateLimit\": 50,\n \"windowInMinutes\": 720\n },\n \"sendingRateLimitConfiguration\": {\n \"rateLimit\": 50,\n \"windowInMinutes\": 720\n },\n \"passkeyRegistrationHints\": [],\n \"whatsAppProvider\": \"BIRD\",\n \"redirectUrls\": [\n \"<string>\"\n ],\n \"dontSkipEnrollmentInputScreen\": true,\n \"documentTypes\": {},\n \"recoveryMethods\": [],\n \"disableEnrollmentPrompt\": true,\n \"requireDeviceIntegrity\": true,\n \"twilioCredentials\": {\n \"accountSid\": \"<string>\",\n \"messagingServiceSid\": \"<string>\",\n \"authToken\": \"<string>\"\n },\n \"messageBirdV2Credentials\": {\n \"accessKey\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"channelId\": \"<string>\",\n \"navigatorId\": \"<string>\",\n \"projectId\": \"<string>\",\n \"locale\": \"<string>\",\n \"enableMessageTemplates\": true\n },\n \"modicaGroupCredentials\": {\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n },\n \"tnzCredentials\": {\n \"apiKey\": \"<string>\"\n },\n \"urbanAirshipCredentials\": {\n \"apiKey\": \"<string>\",\n \"masterSecret\": \"<string>\"\n },\n \"veriff\": {\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\"\n },\n \"iproov\": {\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\",\n \"baseUrl\": \"<string>\"\n },\n \"idverseCredentials\": {\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\"\n },\n \"messageMediaCredentials\": {\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\",\n \"sourceNumber\": \"<string>\"\n },\n \"mailjetEmailCredentials\": {\n \"privateKey\": \"<string>\",\n \"publicKey\": \"<string>\",\n \"templateId\": \"<string>\"\n },\n \"mailgunEmailCredentials\": {\n \"apiKey\": \"<string>\",\n \"url\": \"<string>\",\n \"domain\": \"<string>\",\n \"from\": \"<string>\"\n },\n \"smtpEmailCredentials\": {\n \"host\": \"<string>\",\n \"port\": 123,\n \"secure\": true,\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"from\": \"<string>\",\n \"fromName\": \"<string>\"\n },\n \"birdEmailCredentials\": {\n \"accessKey\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"channelId\": \"<string>\",\n \"projectId\": \"<string>\",\n \"versionId\": \"<string>\",\n \"locale\": \"<string>\",\n \"senderEmail\": \"<string>\",\n \"senderName\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.authsignal.com/v1/management/authenticator-configurations/{authenticator_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"authenticatorId\": \"<string>\",\n \"authenticatorType\": \"<unknown>\",\n \"isActive\": true,\n \"isEditableByUser\": true,\n \"isHiddenToUser\": true,\n \"webhookUrl\": \"<string>\",\n \"messageTemplate\": \"<string>\",\n \"sender\": \"<string>\",\n \"relyingParty\": \"<string>\",\n \"expectedOrigins\": [\n \"<string>\"\n ],\n \"verificationCodeLength\": 6,\n \"enrollmentPromptInterval\": 123,\n \"hideTotpAppDownloadScreen\": true,\n \"issuerName\": \"<string>\",\n \"sessionTtlInMinutes\": 30,\n \"showEmailDeliveryTimeWarning\": true,\n \"smsCountryCodes\": [\n \"<string>\"\n ],\n \"allowMultipleUserAuthenticators\": true,\n \"rateLimitConfiguration\": {\n \"rateLimit\": 50,\n \"windowInMinutes\": 720\n },\n \"sendingRateLimitConfiguration\": {\n \"rateLimit\": 50,\n \"windowInMinutes\": 720\n },\n \"passkeyRegistrationHints\": [],\n \"whatsAppProvider\": \"BIRD\",\n \"redirectUrls\": [\n \"<string>\"\n ],\n \"dontSkipEnrollmentInputScreen\": true,\n \"documentTypes\": {},\n \"recoveryMethods\": [],\n \"disableEnrollmentPrompt\": true,\n \"requireDeviceIntegrity\": true,\n \"twilioCredentials\": {\n \"accountSid\": \"<string>\",\n \"messagingServiceSid\": \"<string>\",\n \"authToken\": \"<string>\"\n },\n \"messageBirdV2Credentials\": {\n \"accessKey\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"channelId\": \"<string>\",\n \"navigatorId\": \"<string>\",\n \"projectId\": \"<string>\",\n \"locale\": \"<string>\",\n \"enableMessageTemplates\": true\n },\n \"modicaGroupCredentials\": {\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n },\n \"tnzCredentials\": {\n \"apiKey\": \"<string>\"\n },\n \"urbanAirshipCredentials\": {\n \"apiKey\": \"<string>\",\n \"masterSecret\": \"<string>\"\n },\n \"veriff\": {\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\"\n },\n \"iproov\": {\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\",\n \"baseUrl\": \"<string>\"\n },\n \"idverseCredentials\": {\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\"\n },\n \"messageMediaCredentials\": {\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\",\n \"sourceNumber\": \"<string>\"\n },\n \"mailjetEmailCredentials\": {\n \"privateKey\": \"<string>\",\n \"publicKey\": \"<string>\",\n \"templateId\": \"<string>\"\n },\n \"mailgunEmailCredentials\": {\n \"apiKey\": \"<string>\",\n \"url\": \"<string>\",\n \"domain\": \"<string>\",\n \"from\": \"<string>\"\n },\n \"smtpEmailCredentials\": {\n \"host\": \"<string>\",\n \"port\": 123,\n \"secure\": true,\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"from\": \"<string>\",\n \"fromName\": \"<string>\"\n },\n \"birdEmailCredentials\": {\n \"accessKey\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"channelId\": \"<string>\",\n \"projectId\": \"<string>\",\n \"versionId\": \"<string>\",\n \"locale\": \"<string>\",\n \"senderEmail\": \"<string>\",\n \"senderName\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"authenticatorId": "<string>",
"authenticatorType": "<unknown>",
"isActive": true,
"isEditableByUser": true,
"isHiddenToUser": true,
"webhookUrl": "<string>",
"messageTemplate": "<string>",
"sender": "<string>",
"relyingParty": "<string>",
"expectedOrigins": [
"<string>"
],
"verificationCodeLength": 6,
"enrollmentPromptInterval": 123,
"hideTotpAppDownloadScreen": true,
"issuerName": "<string>",
"sessionTtlInMinutes": 30,
"showEmailDeliveryTimeWarning": true,
"smsCountryCodes": [
"<string>"
],
"allowMultipleUserAuthenticators": true,
"rateLimitConfiguration": {
"rateLimit": 50,
"windowInMinutes": 720
},
"sendingRateLimitConfiguration": {
"rateLimit": 50,
"windowInMinutes": 720
},
"passkeyRegistrationHints": [],
"whatsAppProvider": "BIRD",
"redirectUrls": [
"<string>"
],
"dontSkipEnrollmentInputScreen": true,
"documentTypes": {},
"recoveryMethods": [],
"disableEnrollmentPrompt": true,
"requireDeviceIntegrity": true,
"twilioCredentials": {
"accountSid": "<string>",
"messagingServiceSid": "<string>",
"authToken": "<string>"
},
"messageBirdV2Credentials": {
"accessKey": "<string>",
"workspaceId": "<string>",
"channelId": "<string>",
"navigatorId": "<string>",
"projectId": "<string>",
"locale": "<string>",
"enableMessageTemplates": true
},
"modicaGroupCredentials": {
"username": "<string>",
"password": "<string>"
},
"tnzCredentials": {
"apiKey": "<string>"
},
"urbanAirshipCredentials": {
"apiKey": "<string>",
"masterSecret": "<string>"
},
"veriff": {
"apiKey": "<string>",
"apiSecret": "<string>"
},
"iproov": {
"apiKey": "<string>",
"apiSecret": "<string>",
"baseUrl": "<string>"
},
"idverseCredentials": {
"apiKey": "<string>",
"apiSecret": "<string>"
},
"messageMediaCredentials": {
"apiKey": "<string>",
"apiSecret": "<string>",
"sourceNumber": "<string>"
},
"mailjetEmailCredentials": {
"privateKey": "<string>",
"publicKey": "<string>",
"templateId": "<string>"
},
"mailgunEmailCredentials": {
"apiKey": "<string>",
"url": "<string>",
"domain": "<string>",
"from": "<string>"
},
"smtpEmailCredentials": {
"host": "<string>",
"port": 123,
"secure": true,
"username": "<string>",
"password": "<string>",
"from": "<string>",
"fromName": "<string>"
},
"birdEmailCredentials": {
"accessKey": "<string>",
"workspaceId": "<string>",
"channelId": "<string>",
"projectId": "<string>",
"versionId": "<string>",
"locale": "<string>",
"senderEmail": "<string>",
"senderName": "<string>"
}
}
