Skip to main content
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
}
'

Authorizations

​
Authorization
string
header
required

JWT Bearer token. Obtain via the OAuth 2.0 token endpoint.

Body

The updated tenant data.

​
entity
null | string
​
name
string
​
welcome
string
​
domain
string
​
publicUrl
string
​
adminContact
string
​
adminEmail
string
​
emailDisplayName
string
​
currency
string
​
locale
string
​
formsAuth
boolean
​
formsTwoFactor
boolean
​
entraAuth
boolean
​
active
boolean
​
activation
string
​
onboardType
string
​
tenantId
string
​
id
string
​
created
string<date-time>
​
createdBy
string
​
updated
string<date-time>
​
updatedBy
string
​
deleted
boolean

Response

Tenant profile updated successfully.