Skip to main content
PATCH
/
v1
/
tenants
/
{tenant_id}
Update Tenant
curl --request PATCH \
  --url http://localhost:8000/v1/tenants/{tenant_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "idp_config": {
    "provider": "OAUTH2",
    "configuration": {}
  },
  "settings": {
    "language": "en",
    "description": "<string>",
    "timezone": "<string>",
    "brand_name": "<string>",
    "brand_color": "<string>",
    "theme_overrides": {}
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "settings": {
    "language": "en",
    "description": "<string>",
    "timezone": "<string>"
  },
  "idp_config": {},
  "branding": {
    "brand_name": "<string>",
    "brand_color": "<string>",
    "logo_url": "<string>",
    "logo_dark_url": "<string>",
    "favicon_url": "<string>",
    "theme_overrides": {}
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.knowledgestack.ai/llms.txt

Use this file to discover all available pages before exploring further.

Headers

authorization
string | null

Path Parameters

tenant_id
string<uuid>
required

Cookies

ks_uat
string | null

Body

application/json

Update tenant request model.

name
string | null

Optional tenant name to update

idp_config
IdpConfig · object

Optional external IdP configuration to update

settings
TenantSettingsUpdate · object

Optional tenant settings to update

Response

Successful Response

Tenant response model.

id
string<uuid>
required

Tenant ID

name
string
required

Tenant name

settings
TenantSettingsResponse · object
required

User-configurable tenant settings

idp_config
Idp Config · object

External IdP configuration

branding
TenantBrandingResponse · object

Resolved branding (colors, logo URLs, theme overrides)