Updates the current tenant's profile information such as name, locale, and admin contact details.
curl --request PUT \
--url https://{install}/api/tenant \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"entity": "<string>",
"name": "<string>",
"welcome": "<string>",
"domain": "<string>",
"publicUrl": "<string>",
"adminContact": "<string>",
"adminEmail": "<string>",
"emailDisplayName": "<string>",
"currency": "<string>",
"locale": "<string>",
"formsAuth": true,
"formsTwoFactor": true,
"entraAuth": true,
"active": true,
"activation": "<string>",
"onboardType": "<string>",
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
'import requests
url = "https://{install}/api/tenant"
payload = {
"entity": "<string>",
"name": "<string>",
"welcome": "<string>",
"domain": "<string>",
"publicUrl": "<string>",
"adminContact": "<string>",
"adminEmail": "<string>",
"emailDisplayName": "<string>",
"currency": "<string>",
"locale": "<string>",
"formsAuth": True,
"formsTwoFactor": True,
"entraAuth": True,
"active": True,
"activation": "<string>",
"onboardType": "<string>",
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
entity: '<string>',
name: '<string>',
welcome: '<string>',
domain: '<string>',
publicUrl: '<string>',
adminContact: '<string>',
adminEmail: '<string>',
emailDisplayName: '<string>',
currency: '<string>',
locale: '<string>',
formsAuth: true,
formsTwoFactor: true,
entraAuth: true,
active: true,
activation: '<string>',
onboardType: '<string>',
tenantId: '<string>',
id: '<string>',
created: '2023-11-07T05:31:56Z',
createdBy: '<string>',
updated: '2023-11-07T05:31:56Z',
updatedBy: '<string>',
deleted: true
})
};
fetch('https://{install}/api/tenant', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));using RestSharp;
var options = new RestClientOptions("https://{install}/api/tenant");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"entity\": \"<string>\",\n \"name\": \"<string>\",\n \"welcome\": \"<string>\",\n \"domain\": \"<string>\",\n \"publicUrl\": \"<string>\",\n \"adminContact\": \"<string>\",\n \"adminEmail\": \"<string>\",\n \"emailDisplayName\": \"<string>\",\n \"currency\": \"<string>\",\n \"locale\": \"<string>\",\n \"formsAuth\": true,\n \"formsTwoFactor\": true,\n \"entraAuth\": true,\n \"active\": true,\n \"activation\": \"<string>\",\n \"onboardType\": \"<string>\",\n \"tenantId\": \"<string>\",\n \"id\": \"<string>\",\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"updated\": \"2023-11-07T05:31:56Z\",\n \"updatedBy\": \"<string>\",\n \"deleted\": true\n}", false);
var response = await client.PutAsync(request);
Console.WriteLine("{0}", response.Content);<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{install}/api/tenant",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'entity' => '<string>',
'name' => '<string>',
'welcome' => '<string>',
'domain' => '<string>',
'publicUrl' => '<string>',
'adminContact' => '<string>',
'adminEmail' => '<string>',
'emailDisplayName' => '<string>',
'currency' => '<string>',
'locale' => '<string>',
'formsAuth' => true,
'formsTwoFactor' => true,
'entraAuth' => true,
'active' => true,
'activation' => '<string>',
'onboardType' => '<string>',
'tenantId' => '<string>',
'id' => '<string>',
'created' => '2023-11-07T05:31:56Z',
'createdBy' => '<string>',
'updated' => '2023-11-07T05:31:56Z',
'updatedBy' => '<string>',
'deleted' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://{install}/api/tenant"
payload := strings.NewReader("{\n \"entity\": \"<string>\",\n \"name\": \"<string>\",\n \"welcome\": \"<string>\",\n \"domain\": \"<string>\",\n \"publicUrl\": \"<string>\",\n \"adminContact\": \"<string>\",\n \"adminEmail\": \"<string>\",\n \"emailDisplayName\": \"<string>\",\n \"currency\": \"<string>\",\n \"locale\": \"<string>\",\n \"formsAuth\": true,\n \"formsTwoFactor\": true,\n \"entraAuth\": true,\n \"active\": true,\n \"activation\": \"<string>\",\n \"onboardType\": \"<string>\",\n \"tenantId\": \"<string>\",\n \"id\": \"<string>\",\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"updated\": \"2023-11-07T05:31:56Z\",\n \"updatedBy\": \"<string>\",\n \"deleted\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.put("https://{install}/api/tenant")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"entity\": \"<string>\",\n \"name\": \"<string>\",\n \"welcome\": \"<string>\",\n \"domain\": \"<string>\",\n \"publicUrl\": \"<string>\",\n \"adminContact\": \"<string>\",\n \"adminEmail\": \"<string>\",\n \"emailDisplayName\": \"<string>\",\n \"currency\": \"<string>\",\n \"locale\": \"<string>\",\n \"formsAuth\": true,\n \"formsTwoFactor\": true,\n \"entraAuth\": true,\n \"active\": true,\n \"activation\": \"<string>\",\n \"onboardType\": \"<string>\",\n \"tenantId\": \"<string>\",\n \"id\": \"<string>\",\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"updated\": \"2023-11-07T05:31:56Z\",\n \"updatedBy\": \"<string>\",\n \"deleted\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{install}/api/tenant")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entity\": \"<string>\",\n \"name\": \"<string>\",\n \"welcome\": \"<string>\",\n \"domain\": \"<string>\",\n \"publicUrl\": \"<string>\",\n \"adminContact\": \"<string>\",\n \"adminEmail\": \"<string>\",\n \"emailDisplayName\": \"<string>\",\n \"currency\": \"<string>\",\n \"locale\": \"<string>\",\n \"formsAuth\": true,\n \"formsTwoFactor\": true,\n \"entraAuth\": true,\n \"active\": true,\n \"activation\": \"<string>\",\n \"onboardType\": \"<string>\",\n \"tenantId\": \"<string>\",\n \"id\": \"<string>\",\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"updated\": \"2023-11-07T05:31:56Z\",\n \"updatedBy\": \"<string>\",\n \"deleted\": true\n}"
response = http.request(request)
puts response.read_bodyTenant & Settings
Updates the current tenant's profile information such as name, locale, and admin contact details.
PUT
/
api
/
tenant
Updates the current tenant's profile information such as name, locale, and admin contact details.
curl --request PUT \
--url https://{install}/api/tenant \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"entity": "<string>",
"name": "<string>",
"welcome": "<string>",
"domain": "<string>",
"publicUrl": "<string>",
"adminContact": "<string>",
"adminEmail": "<string>",
"emailDisplayName": "<string>",
"currency": "<string>",
"locale": "<string>",
"formsAuth": true,
"formsTwoFactor": true,
"entraAuth": true,
"active": true,
"activation": "<string>",
"onboardType": "<string>",
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
'import requests
url = "https://{install}/api/tenant"
payload = {
"entity": "<string>",
"name": "<string>",
"welcome": "<string>",
"domain": "<string>",
"publicUrl": "<string>",
"adminContact": "<string>",
"adminEmail": "<string>",
"emailDisplayName": "<string>",
"currency": "<string>",
"locale": "<string>",
"formsAuth": True,
"formsTwoFactor": True,
"entraAuth": True,
"active": True,
"activation": "<string>",
"onboardType": "<string>",
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
entity: '<string>',
name: '<string>',
welcome: '<string>',
domain: '<string>',
publicUrl: '<string>',
adminContact: '<string>',
adminEmail: '<string>',
emailDisplayName: '<string>',
currency: '<string>',
locale: '<string>',
formsAuth: true,
formsTwoFactor: true,
entraAuth: true,
active: true,
activation: '<string>',
onboardType: '<string>',
tenantId: '<string>',
id: '<string>',
created: '2023-11-07T05:31:56Z',
createdBy: '<string>',
updated: '2023-11-07T05:31:56Z',
updatedBy: '<string>',
deleted: true
})
};
fetch('https://{install}/api/tenant', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));using RestSharp;
var options = new RestClientOptions("https://{install}/api/tenant");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"entity\": \"<string>\",\n \"name\": \"<string>\",\n \"welcome\": \"<string>\",\n \"domain\": \"<string>\",\n \"publicUrl\": \"<string>\",\n \"adminContact\": \"<string>\",\n \"adminEmail\": \"<string>\",\n \"emailDisplayName\": \"<string>\",\n \"currency\": \"<string>\",\n \"locale\": \"<string>\",\n \"formsAuth\": true,\n \"formsTwoFactor\": true,\n \"entraAuth\": true,\n \"active\": true,\n \"activation\": \"<string>\",\n \"onboardType\": \"<string>\",\n \"tenantId\": \"<string>\",\n \"id\": \"<string>\",\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"updated\": \"2023-11-07T05:31:56Z\",\n \"updatedBy\": \"<string>\",\n \"deleted\": true\n}", false);
var response = await client.PutAsync(request);
Console.WriteLine("{0}", response.Content);<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{install}/api/tenant",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'entity' => '<string>',
'name' => '<string>',
'welcome' => '<string>',
'domain' => '<string>',
'publicUrl' => '<string>',
'adminContact' => '<string>',
'adminEmail' => '<string>',
'emailDisplayName' => '<string>',
'currency' => '<string>',
'locale' => '<string>',
'formsAuth' => true,
'formsTwoFactor' => true,
'entraAuth' => true,
'active' => true,
'activation' => '<string>',
'onboardType' => '<string>',
'tenantId' => '<string>',
'id' => '<string>',
'created' => '2023-11-07T05:31:56Z',
'createdBy' => '<string>',
'updated' => '2023-11-07T05:31:56Z',
'updatedBy' => '<string>',
'deleted' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://{install}/api/tenant"
payload := strings.NewReader("{\n \"entity\": \"<string>\",\n \"name\": \"<string>\",\n \"welcome\": \"<string>\",\n \"domain\": \"<string>\",\n \"publicUrl\": \"<string>\",\n \"adminContact\": \"<string>\",\n \"adminEmail\": \"<string>\",\n \"emailDisplayName\": \"<string>\",\n \"currency\": \"<string>\",\n \"locale\": \"<string>\",\n \"formsAuth\": true,\n \"formsTwoFactor\": true,\n \"entraAuth\": true,\n \"active\": true,\n \"activation\": \"<string>\",\n \"onboardType\": \"<string>\",\n \"tenantId\": \"<string>\",\n \"id\": \"<string>\",\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"updated\": \"2023-11-07T05:31:56Z\",\n \"updatedBy\": \"<string>\",\n \"deleted\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.put("https://{install}/api/tenant")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"entity\": \"<string>\",\n \"name\": \"<string>\",\n \"welcome\": \"<string>\",\n \"domain\": \"<string>\",\n \"publicUrl\": \"<string>\",\n \"adminContact\": \"<string>\",\n \"adminEmail\": \"<string>\",\n \"emailDisplayName\": \"<string>\",\n \"currency\": \"<string>\",\n \"locale\": \"<string>\",\n \"formsAuth\": true,\n \"formsTwoFactor\": true,\n \"entraAuth\": true,\n \"active\": true,\n \"activation\": \"<string>\",\n \"onboardType\": \"<string>\",\n \"tenantId\": \"<string>\",\n \"id\": \"<string>\",\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"updated\": \"2023-11-07T05:31:56Z\",\n \"updatedBy\": \"<string>\",\n \"deleted\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{install}/api/tenant")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entity\": \"<string>\",\n \"name\": \"<string>\",\n \"welcome\": \"<string>\",\n \"domain\": \"<string>\",\n \"publicUrl\": \"<string>\",\n \"adminContact\": \"<string>\",\n \"adminEmail\": \"<string>\",\n \"emailDisplayName\": \"<string>\",\n \"currency\": \"<string>\",\n \"locale\": \"<string>\",\n \"formsAuth\": true,\n \"formsTwoFactor\": true,\n \"entraAuth\": true,\n \"active\": true,\n \"activation\": \"<string>\",\n \"onboardType\": \"<string>\",\n \"tenantId\": \"<string>\",\n \"id\": \"<string>\",\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"updated\": \"2023-11-07T05:31:56Z\",\n \"updatedBy\": \"<string>\",\n \"deleted\": true\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
JWT Bearer token. Obtain via the OAuth 2.0 token endpoint.
Body
application/jsonapplication/*+json
The updated tenant data.
Response
Tenant profile updated successfully.
Retrieves a single application setting by identifier.
Previous
Retrieves the AI provider configuration for the current tenant. Hidden from the
SDK/CLI because the response shape carries provider API keys; AI config is tenant
infrastructure, not customer data ops or migration scope.
Next
⌘I