Tenants
Get Tenant
Retrieves tenant information.
GET
/
tenant
Get Tenant
curl --request GET \
--url https://api.authsignal.com/v1/management/tenant \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.authsignal.com/v1/management/tenant"
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/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 => "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/tenant"
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))
}HttpResponse<String> response = Unirest.get("https://api.authsignal.com/v1/management/tenant")
.header("Authorization", "Basic <encoded-value>")
.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::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"tenantId": "<string>",
"allowDisablingMfa": true,
"hideAuthsignalLogo": true,
"customDomain": "<string>",
"redirectOnSessionExpiry": true,
"disableRecoveryCodes": 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
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
OK
Omitted when not configured.
Show child attributes
Show child attributes
Example:
{
"url": "https://example.com/authsignal/authenticator-events",
"includeCredentialPublicKey": true
}
Omitted when not configured.
Show child attributes
Show child attributes
Example:
{
"endpointUrl": "https://example.com/authsignal/log-events"
}
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"]
Was this page helpful?
⌘I
Get Tenant
curl --request GET \
--url https://api.authsignal.com/v1/management/tenant \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.authsignal.com/v1/management/tenant"
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/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 => "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/tenant"
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))
}HttpResponse<String> response = Unirest.get("https://api.authsignal.com/v1/management/tenant")
.header("Authorization", "Basic <encoded-value>")
.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::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"tenantId": "<string>",
"allowDisablingMfa": true,
"hideAuthsignalLogo": true,
"customDomain": "<string>",
"redirectOnSessionExpiry": true,
"disableRecoveryCodes": 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>"
}
