Get SMS OTP authenticator configuration

GET

authenticator-configurations

sms

Get the SMS OTP configuration

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

import requests

url = "https://api.authsignal.com/v1/management/authenticator-configurations/sms"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.authsignal.com/v1/management/authenticator-configurations/sms', 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/sms",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.authsignal.com/v1/management/authenticator-configurations/sms"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.authsignal.com/v1/management/authenticator-configurations/sms")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "authenticatorId": "6b736c64-ff30-4b85-8706-0c78c34c0ca9",
  "verificationMethod": "SMS",
  "isActive": true,
  "smsProvider": "BIRD",
  "smsCountryCodes": [
    "AU",
    "NZ"
  ],
  "defaultCountryCode": "NZ",
  "sendingRateLimitConfigurations": [
    {
      "rateLimit": 2,
      "windowInMinutes": 1
    },
    {
      "rateLimit": 10,
      "windowInMinutes": 60
    }
  ],
  "birdSmsCredentials": {
    "workspaceId": "workspace-id",
    "channelId": "channel-id"
  }
}

{
  "error": "<string>",
  "errorDescription": "<string>"
}

{
  "error": "<string>",
  "errorDescription": "<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

authenticatorId

string

required

read-only

The immutable identifier for this configuration.

isActive

boolean

required

verificationMethod

string

required

read-only

The verification method produced by this configuration.

Allowed value: "SMS"

smsProvider

enum<string>

The SMS provider. Supply the matching credential object for BIRD, TWILIO, MESSAGE_MEDIA, MODICA_GROUP, or TNZ. WEBHOOK requires webhookUrl.

Available options:

BIRD,

TWILIO,

MESSAGE_MEDIA,

MODICA_GROUP,

TNZ,

WEBHOOK

webhookUrl

string<uri>

The HTTPS endpoint used by a WEBHOOK provider. Authsignal posts each verification code to this endpoint as an sms.created event.

smsCountryCodes

enum<string>[]

Allowed destination countries for SMS OTP.

A supported two-letter country code.

Available options:

AD,

AE,

AF,

AG,

AI,

AL,

AM,

AO,

AR,

AS,

AT,

AU,

AW,

AX,

AZ,

BA,

BB,

BD,

BE,

BF,

BG,

BH,

BI,

BJ,

BL,

BM,

BN,

BO,

BR,

BS,

BT,

BW,

BY,

BZ,

CA,

CC,

CD,

CF,

CG,

CH,

CI,

CK,

CL,

CM,

CN,

CO,

CR,

CU,

CV,

CX,

CY,

CZ,

DE,

DJ,

DK,

DM,

DO,

DZ,

EC,

EE,

EG,

ER,

ES,

ET,

FI,

FJ,

FK,

FM,

FO,

FR,

GA,

GB,

GD,

GE,

GF,

GG,

GH,

GI,

GL,

GM,

GN,

GP,

GQ,

GR,

GT,

GU,

GW,

GY,

HK,

HN,

HR,

HT,

HU,

ID,

IE,

IL,

IM,

IN,

IO,

IQ,

IR,

IS,

IT,

JE,

JM,

JO,

JP,

KE,

KG,

KH,

KI,

KM,

KN,

KP,

KR,

KW,

KY,

KZ,

LA,

LB,

LC,

LI,

LK,

LR,

LS,

LT,

LU,

LV,

LY,

MA,

MC,

MD,

ME,

MF,

MG,

MH,

MK,

ML,

MM,

MN,

MO,

MP,

MQ,

MR,

MS,

MT,

MU,

MV,

MW,

MX,

MY,

MZ,

NA,

NC,

NE,

NF,

NG,

NI,

NL,

NO,

NP,

NR,

NU,

NZ,

OM,

PA,

PE,

PF,

PG,

PH,

PK,

PL,

PM,

PR,

PS,

PT,

PW,

PY,

QA,

RE,

RO,

RS,

RU,

RW,

SA,

SB,

SC,

SD,

SE,

SG,

SH,

SI,

SJ,

SK,

SL,

SM,

SN,

SO,

SR,

SS,

ST,

SV,

SY,

SZ,

TC,

TD,

TG,

TH,

TJ,

TK,

TL,

TM,

TN,

TO,

TR,

TT,

TV,

TW,

TZ,

UA,

UG,

US,

UY,

UZ,

VA,

VC,

VE,

VG,

VI,

VN,

VU,

WF,

WS,

XK,

YE,

YT,

ZA,

ZM,

ZW

defaultCountryCode

enum<string>

A supported two-letter country code.

Available options:

AD,

AE,

AF,

AG,

AI,

AL,

AM,

AO,

AR,

AS,

AT,

AU,

AW,

AX,

AZ,

BA,

BB,

BD,

BE,

BF,

BG,

BH,

BI,

BJ,

BL,

BM,

BN,

BO,

BR,

BS,

BT,

BW,

BY,

BZ,

CA,

CC,

CD,

CF,

CG,

CH,

CI,

CK,

CL,

CM,

CN,

CO,

CR,

CU,

CV,

CX,

CY,

CZ,

DE,

DJ,

DK,

DM,

DO,

DZ,

EC,

EE,

EG,

ER,

ES,

ET,

FI,

FJ,

FK,

FM,

FO,

FR,

GA,

GB,

GD,

GE,

GF,

GG,

GH,

GI,

GL,

GM,

GN,

GP,

GQ,

GR,

GT,

GU,

GW,

GY,

HK,

HN,

HR,

HT,

HU,

ID,

IE,

IL,

IM,

IN,

IO,

IQ,

IR,

IS,

IT,

JE,

JM,

JO,

JP,

KE,

KG,

KH,

KI,

KM,

KN,

KP,

KR,

KW,

KY,

KZ,

LA,

LB,

LC,

LI,

LK,

LR,

LS,

LT,

LU,

LV,

LY,

MA,

MC,

MD,

ME,

MF,

MG,

MH,

MK,

ML,

MM,

MN,

MO,

MP,

MQ,

MR,

MS,

MT,

MU,

MV,

MW,

MX,

MY,

MZ,

NA,

NC,

NE,

NF,

NG,

NI,

NL,

NO,

NP,

NR,

NU,

NZ,

OM,

PA,

PE,

PF,

PG,

PH,

PK,

PL,

PM,

PR,

PS,

PT,

PW,

PY,

QA,

RE,

RO,

RS,

RU,

RW,

SA,

SB,

SC,

SD,

SE,

SG,

SH,

SI,

SJ,

SK,

SL,

SM,

SN,

SO,

SR,

SS,

ST,

SV,

SY,

SZ,

TC,

TD,

TG,

TH,

TJ,

TK,

TL,

TM,

TN,

TO,

TR,

TT,

TV,

TW,

TZ,

UA,

UG,

US,

UY,

UZ,

VA,

VC,

VE,

VG,

VI,

VN,

VU,

WF,

WS,

XK,

YE,

YT,

ZA,

ZM,

ZW

submissionRateLimitConfiguration

object

Show child attributes

sendingRateLimitConfigurations

object[]

Limits on how many messages are sent to one phone number or email address. Every configured limit applies, so sending is blocked as soon as any is exceeded. Add a limit of 1 to set a cooldown between sends. See Rate limits.

Required array length: 1 - 6 elements

Show child attributes

prefixRateLimitConfigurations

object[]

Limits on how many SMS messages are sent across a country or a block of consecutive phone numbers. Every enabled limit applies. See Rate limits.

Maximum array length: 5

Show child attributes

allowedCustomSmsVariables

string[]

twilioCredentials

object

Use with the TWILIO SMS provider.

Show child attributes

messageMediaCredentials

object

Use with the MESSAGE_MEDIA SMS provider.

Show child attributes

modicaGroupCredentials

object

Use with the MODICA_GROUP SMS provider.

Show child attributes

tnzCredentials

object

Use with the TNZ SMS provider.

birdSmsCredentials

object

Use with the BIRD SMS provider.

Show child attributes

⌘I

Get the SMS OTP configuration

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

import requests

url = "https://api.authsignal.com/v1/management/authenticator-configurations/sms"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.authsignal.com/v1/management/authenticator-configurations/sms', 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/sms",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.authsignal.com/v1/management/authenticator-configurations/sms"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.authsignal.com/v1/management/authenticator-configurations/sms")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "authenticatorId": "6b736c64-ff30-4b85-8706-0c78c34c0ca9",
  "verificationMethod": "SMS",
  "isActive": true,
  "smsProvider": "BIRD",
  "smsCountryCodes": [
    "AU",
    "NZ"
  ],
  "defaultCountryCode": "NZ",
  "sendingRateLimitConfigurations": [
    {
      "rateLimit": 2,
      "windowInMinutes": 1
    },
    {
      "rateLimit": 10,
      "windowInMinutes": 60
    }
  ],
  "birdSmsCredentials": {
    "workspaceId": "workspace-id",
    "channelId": "channel-id"
  }
}

{
  "error": "<string>",
  "errorDescription": "<string>"
}

{
  "error": "<string>",
  "errorDescription": "<string>"
}

API reference

Server API

Client API

Management API

Call Connect API

Terminal API

Get SMS OTP authenticator configuration

Authorizations

Response