Tenants
Update Tenant
Updates tenant information.
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": "<string>",
"disableRecoveryCodes": true,
"tokenDurationInMinutes": 123
}
'import requests
url = "https://api.authsignal.com/v1/management/tenant"
payload = {
"name": "<string>",
"disableRecoveryCodes": True,
"tokenDurationInMinutes": 123
}
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: '<string>', disableRecoveryCodes: true, tokenDurationInMinutes: 123})
};
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' => '<string>',
'disableRecoveryCodes' => true,
'tokenDurationInMinutes' => 123
]),
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\": \"<string>\",\n \"disableRecoveryCodes\": true,\n \"tokenDurationInMinutes\": 123\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\": \"<string>\",\n \"disableRecoveryCodes\": true,\n \"tokenDurationInMinutes\": 123\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\": \"<string>\",\n \"disableRecoveryCodes\": true,\n \"tokenDurationInMinutes\": 123\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
}{
"error": "<string>",
"errorDescription": "<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.
Body
application/json
The name of the tenant.
Whether to disable recovery codes as an authentication method.
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.
Response
OK
Was this page helpful?
⌘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": "<string>",
"disableRecoveryCodes": true,
"tokenDurationInMinutes": 123
}
'import requests
url = "https://api.authsignal.com/v1/management/tenant"
payload = {
"name": "<string>",
"disableRecoveryCodes": True,
"tokenDurationInMinutes": 123
}
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: '<string>', disableRecoveryCodes: true, tokenDurationInMinutes: 123})
};
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' => '<string>',
'disableRecoveryCodes' => true,
'tokenDurationInMinutes' => 123
]),
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\": \"<string>\",\n \"disableRecoveryCodes\": true,\n \"tokenDurationInMinutes\": 123\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\": \"<string>\",\n \"disableRecoveryCodes\": true,\n \"tokenDurationInMinutes\": 123\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\": \"<string>\",\n \"disableRecoveryCodes\": true,\n \"tokenDurationInMinutes\": 123\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
}{
"error": "<string>",
"errorDescription": "<string>"
}
