Get Authenticator Configurations

GET

authenticator-configurations

curl --request GET \
  --url https://api.authsignal.com/v1/management/authenticator-configurations \
  --header 'Authorization: Basic <encoded-value>'

[
  {
    "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": [],
    "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

Authorization

string

header

required

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.

Response

200 - application/json

authenticatorId

string

Unique identifier for this configuration

authenticatorType

any

isActive

boolean

isEditableByUser

boolean

isHiddenToUser

boolean

verificationMethod

enum<string>

Available options:

SMS,

AUTHENTICATOR_APP,

RECOVERY_CODE,

EMAIL_MAGIC_LINK,

EMAIL_OTP,

PUSH,

DEVICE,

SECURITY_KEY,

PASSKEY,

VERIFF,

IPROOV,

PALM_BIOMETRICS_RR,

IDVERSE

oobChannel

enum<string>

Available options:

EMAIL_OTP,

EMAIL_MAGIC_LINK,

SMS

smsProvider

enum<string>

Available options:

TWILIO,

MESSAGE_BIRD,

MESSAGE_BIRD_V2,

MODICA_GROUP,

TNZ,

WEBHOOK

smsChannel

enum<string>

Available options:

DEFAULT,

WHATSAPP

emailProvider

enum<string>

Available options:

SES,

SMTP,

AIRNZ,

WEBHOOK,

MAILJET,

MAILGUN,

BIRD,

MANDRILL,

SENDGRID

pushProvider

enum<string>

Available options:

URBAN_AIRSHIP,

WEBHOOK

webhookUrl

string<uri>

magicLinkMode

enum<string>

Available options:

NEW_TAB,

ORIGINAL_TAB

messageTemplate

string

sender

string

providerType

enum<string>

Available options:

VERIFF,

IPROOV,

PALM_BIOMETRICS_RR,

IDVERSE

relyingParty

string

expectedOrigins

string[]

verificationCodeLength

integer

Required range: 2 <= x <= 10

enrollmentPromptInterval

number

hideTotpAppDownloadScreen

boolean

issuerName

string

sessionTtlInMinutes

number

Required range: 0 <= x <= 60

userVerificationRequirement

enum<string> | null

Available options:

discouraged,

preferred,

required

authenticatorAttachment

enum<string> | null

Available options:

cross-platform,

platform,

all-supported

showEmailDeliveryTimeWarning

boolean

smsCountryCodes

string[]

ISO country codes for SMS (e.g. US, GB)

allowMultipleUserAuthenticators

boolean

rateLimitConfiguration

object

Show child attributes

sendingRateLimitConfiguration

object

Show child attributes

passkeyRegistrationHints

enum<string>[]

Available options:

security-key,

client-device,

hybrid

whatsAppProvider

enum<string>

Available options:

BIRD

redirectUrls

string<uri>[]

dontSkipEnrollmentInputScreen

boolean

documentTypes

object

Show child attributes

recoveryMethods

enum<string>[]

Available options:

SMS,

AUTHENTICATOR_APP,

RECOVERY_CODE,

EMAIL_MAGIC_LINK,

EMAIL_OTP,

PUSH,

DEVICE,

SECURITY_KEY,

PASSKEY,

VERIFF,

IPROOV,

PALM_BIOMETRICS_RR,

IDVERSE

disableEnrollmentPrompt

boolean

requireDeviceIntegrity

boolean

deviceIntegrityFailureMode

enum<string>

Available options:

BLOCK,

ALLOW_WITH_WARNING

twilioCredentials

object

Show child attributes

messageBirdV2Credentials

object

Show child attributes

modicaGroupCredentials

object

Show child attributes

tnzCredentials

object

Show child attributes

urbanAirshipCredentials

object

Show child attributes

veriff

object

Show child attributes

iproov

object

Show child attributes

idverseCredentials

object

Show child attributes

messageMediaCredentials

object

Show child attributes

mailjetEmailCredentials

object

Show child attributes

mailgunEmailCredentials

object

Show child attributes

smtpEmailCredentials

object

Show child attributes

birdEmailCredentials

object

Show child attributes

Update Authenticator ConfigurationUpdates an authenticator configuration by authenticator ID.

⌘I

Get Authenticator Configurations

curl --request GET \
  --url https://api.authsignal.com/v1/management/authenticator-configurations \
  --header 'Authorization: Basic <encoded-value>'

[
  {
    "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": [],
    "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>"
    }
  }
]