Update Tenant

PATCH

tenant

Update Tenant

curl --request PATCH \
  --url https://api.authsignal.com/v1/management/tenant \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Acme",
  "tokenDurationInMinutes": 15,
  "authenticatorEventsWebhookConfig": {
    "url": "https://example.com/authsignal/authenticator-events",
    "includeCredentialPublicKey": true
  },
  "logEventsWebhookConfig": {
    "endpointUrl": "https://example.com/authsignal/log-events"
  },
  "ipWhitelist": [
    "203.0.113.0/24",
    "198.51.100.7/32"
  ]
}
'

import requests

url = "https://api.authsignal.com/v1/management/tenant"

payload = {
    "name": "Acme",
    "tokenDurationInMinutes": 15,
    "authenticatorEventsWebhookConfig": {
        "url": "https://example.com/authsignal/authenticator-events",
        "includeCredentialPublicKey": True
    },
    "logEventsWebhookConfig": { "endpointUrl": "https://example.com/authsignal/log-events" },
    "ipWhitelist": ["203.0.113.0/24", "198.51.100.7/32"]
}
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({
    name: 'Acme',
    tokenDurationInMinutes: 15,
    authenticatorEventsWebhookConfig: {
      url: 'https://example.com/authsignal/authenticator-events',
      includeCredentialPublicKey: true
    },
    logEventsWebhookConfig: {endpointUrl: 'https://example.com/authsignal/log-events'},
    ipWhitelist: ['203.0.113.0/24', '198.51.100.7/32']
  })
};

fetch('https://api.authsignal.com/v1/management/tenant', 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/tenant",
  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([
    'name' => 'Acme',
    'tokenDurationInMinutes' => 15,
    'authenticatorEventsWebhookConfig' => [
        'url' => 'https://example.com/authsignal/authenticator-events',
        'includeCredentialPublicKey' => true
    ],
    'logEventsWebhookConfig' => [
        'endpointUrl' => 'https://example.com/authsignal/log-events'
    ],
    'ipWhitelist' => [
        '203.0.113.0/24',
        '198.51.100.7/32'
    ]
  ]),
  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/tenant"

	payload := strings.NewReader("{\n  \"name\": \"Acme\",\n  \"tokenDurationInMinutes\": 15,\n  \"authenticatorEventsWebhookConfig\": {\n    \"url\": \"https://example.com/authsignal/authenticator-events\",\n    \"includeCredentialPublicKey\": true\n  },\n  \"logEventsWebhookConfig\": {\n    \"endpointUrl\": \"https://example.com/authsignal/log-events\"\n  },\n  \"ipWhitelist\": [\n    \"203.0.113.0/24\",\n    \"198.51.100.7/32\"\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/tenant")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Acme\",\n  \"tokenDurationInMinutes\": 15,\n  \"authenticatorEventsWebhookConfig\": {\n    \"url\": \"https://example.com/authsignal/authenticator-events\",\n    \"includeCredentialPublicKey\": true\n  },\n  \"logEventsWebhookConfig\": {\n    \"endpointUrl\": \"https://example.com/authsignal/log-events\"\n  },\n  \"ipWhitelist\": [\n    \"203.0.113.0/24\",\n    \"198.51.100.7/32\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.authsignal.com/v1/management/tenant")

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  \"name\": \"Acme\",\n  \"tokenDurationInMinutes\": 15,\n  \"authenticatorEventsWebhookConfig\": {\n    \"url\": \"https://example.com/authsignal/authenticator-events\",\n    \"includeCredentialPublicKey\": true\n  },\n  \"logEventsWebhookConfig\": {\n    \"endpointUrl\": \"https://example.com/authsignal/log-events\"\n  },\n  \"ipWhitelist\": [\n    \"203.0.113.0/24\",\n    \"198.51.100.7/32\"\n  ]\n}"

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

{
  "tenantId": "<string>",
  "allowDisablingMfa": true,
  "hideAuthsignalLogo": true,
  "customDomain": "<string>",
  "redirectOnSessionExpiry": true,
  "allowDeletingUserAuthenticators": true,
  "disableRecoveryCodes": true,
  "skipRecoveryCodesOnProgrammaticEnrollment": true,
  "hideRecoveryCodesOnEnrollment": true,
  "tokenDurationInMinutes": 123,
  "authenticatorEventsWebhookConfig": {
    "url": "https://example.com/authsignal/authenticator-events",
    "includeCredentialPublicKey": true
  },
  "logEventsWebhookConfig": {
    "endpointUrl": "https://example.com/authsignal/log-events"
  },
  "ipWhitelist": [
    "203.0.113.0/24",
    "198.51.100.7/32"
  ]
}

{
  "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.

Body

application/json

name

string

The name your users see, such as the issuer shown in an authenticator app and the sender named in verification emails.

disableRecoveryCodes

boolean

Whether to disable recovery codes as an authentication method.

tokenDurationInMinutes

number

The duration in minutes for which an Authsignal challenge token is valid. This determines the expiry of an Authsignal challenge and the duration of the pre-built UI session.

authenticatorEventsWebhookConfig

object | null

Settings for the authenticator events webhook. Fields you omit are preserved. Include url unless one is already stored. Send null to clear the whole configuration, which also stops delivery of every authenticator event.

Show child attributes

Example:

{
  "url": "https://example.com/authsignal/authenticator-events",
  "includeCredentialPublicKey": true
}

logEventsWebhookConfig

object | null

Settings for the log events webhook. Fields you omit are preserved. Send null to clear the whole configuration, which also stops delivery of log events.

Show child attributes

Example:

{
  "endpointUrl": "https://example.com/authsignal/log-events"
}

ipWhitelist

string[]

The IPv4 address ranges in CIDR notation allowed to call the Server API. An empty array allows every IP address.

Pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])/([0-9]|[12][0-9]|3[0-2])$

Example:

["203.0.113.0/24", "198.51.100.7/32"]

Response

tenantId

string

allowDisablingMfa

boolean

hideAuthsignalLogo

boolean

customDomain

string

redirectOnSessionExpiry

boolean

allowDeletingUserAuthenticators

boolean

disableRecoveryCodes

boolean

skipRecoveryCodesOnProgrammaticEnrollment

boolean

hideRecoveryCodesOnEnrollment

boolean

tokenDurationInMinutes

number

authenticatorEventsWebhookConfig

object

Omitted when not configured.

Show child attributes

Example:

{
  "url": "https://example.com/authsignal/authenticator-events",
  "includeCredentialPublicKey": true
}

logEventsWebhookConfig

object

Omitted when not configured.

Show child attributes

Example:

{
  "endpointUrl": "https://example.com/authsignal/log-events"
}

ipWhitelist

string[]

Omitted when not configured.

Pattern: ^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])/([0-9]|[12][0-9]|3[0-2])$

Example:

["203.0.113.0/24", "198.51.100.7/32"]

⌘I

Update Tenant

curl --request PATCH \
  --url https://api.authsignal.com/v1/management/tenant \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Acme",
  "tokenDurationInMinutes": 15,
  "authenticatorEventsWebhookConfig": {
    "url": "https://example.com/authsignal/authenticator-events",
    "includeCredentialPublicKey": true
  },
  "logEventsWebhookConfig": {
    "endpointUrl": "https://example.com/authsignal/log-events"
  },
  "ipWhitelist": [
    "203.0.113.0/24",
    "198.51.100.7/32"
  ]
}
'

import requests

url = "https://api.authsignal.com/v1/management/tenant"

payload = {
    "name": "Acme",
    "tokenDurationInMinutes": 15,
    "authenticatorEventsWebhookConfig": {
        "url": "https://example.com/authsignal/authenticator-events",
        "includeCredentialPublicKey": True
    },
    "logEventsWebhookConfig": { "endpointUrl": "https://example.com/authsignal/log-events" },
    "ipWhitelist": ["203.0.113.0/24", "198.51.100.7/32"]
}
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({
    name: 'Acme',
    tokenDurationInMinutes: 15,
    authenticatorEventsWebhookConfig: {
      url: 'https://example.com/authsignal/authenticator-events',
      includeCredentialPublicKey: true
    },
    logEventsWebhookConfig: {endpointUrl: 'https://example.com/authsignal/log-events'},
    ipWhitelist: ['203.0.113.0/24', '198.51.100.7/32']
  })
};

fetch('https://api.authsignal.com/v1/management/tenant', 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/tenant",
  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([
    'name' => 'Acme',
    'tokenDurationInMinutes' => 15,
    'authenticatorEventsWebhookConfig' => [
        'url' => 'https://example.com/authsignal/authenticator-events',
        'includeCredentialPublicKey' => true
    ],
    'logEventsWebhookConfig' => [
        'endpointUrl' => 'https://example.com/authsignal/log-events'
    ],
    'ipWhitelist' => [
        '203.0.113.0/24',
        '198.51.100.7/32'
    ]
  ]),
  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/tenant"

	payload := strings.NewReader("{\n  \"name\": \"Acme\",\n  \"tokenDurationInMinutes\": 15,\n  \"authenticatorEventsWebhookConfig\": {\n    \"url\": \"https://example.com/authsignal/authenticator-events\",\n    \"includeCredentialPublicKey\": true\n  },\n  \"logEventsWebhookConfig\": {\n    \"endpointUrl\": \"https://example.com/authsignal/log-events\"\n  },\n  \"ipWhitelist\": [\n    \"203.0.113.0/24\",\n    \"198.51.100.7/32\"\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/tenant")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Acme\",\n  \"tokenDurationInMinutes\": 15,\n  \"authenticatorEventsWebhookConfig\": {\n    \"url\": \"https://example.com/authsignal/authenticator-events\",\n    \"includeCredentialPublicKey\": true\n  },\n  \"logEventsWebhookConfig\": {\n    \"endpointUrl\": \"https://example.com/authsignal/log-events\"\n  },\n  \"ipWhitelist\": [\n    \"203.0.113.0/24\",\n    \"198.51.100.7/32\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.authsignal.com/v1/management/tenant")

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  \"name\": \"Acme\",\n  \"tokenDurationInMinutes\": 15,\n  \"authenticatorEventsWebhookConfig\": {\n    \"url\": \"https://example.com/authsignal/authenticator-events\",\n    \"includeCredentialPublicKey\": true\n  },\n  \"logEventsWebhookConfig\": {\n    \"endpointUrl\": \"https://example.com/authsignal/log-events\"\n  },\n  \"ipWhitelist\": [\n    \"203.0.113.0/24\",\n    \"198.51.100.7/32\"\n  ]\n}"

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

{
  "tenantId": "<string>",
  "allowDisablingMfa": true,
  "hideAuthsignalLogo": true,
  "customDomain": "<string>",
  "redirectOnSessionExpiry": true,
  "allowDeletingUserAuthenticators": true,
  "disableRecoveryCodes": true,
  "skipRecoveryCodesOnProgrammaticEnrollment": true,
  "hideRecoveryCodesOnEnrollment": true,
  "tokenDurationInMinutes": 123,
  "authenticatorEventsWebhookConfig": {
    "url": "https://example.com/authsignal/authenticator-events",
    "includeCredentialPublicKey": true
  },
  "logEventsWebhookConfig": {
    "endpointUrl": "https://example.com/authsignal/log-events"
  },
  "ipWhitelist": [
    "203.0.113.0/24",
    "198.51.100.7/32"
  ]
}

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

API reference

Server API

Client API

Management API

Call Connect API

Terminal API

Authorizations

Body

Response