---
title: "Update Tenant"
method: PUT
path: "/tenants/{tenant_id}"
tags: ["Identity"]
---

# Update Tenant

`PUT /tenants/{tenant_id}`

Update a tenant's status, description & metadata using its id. No operation can be performed when a tenant is made suspended.

## Path parameters

- `tenant_id` string, required

## Request body

- UpdateTenantRequest
  - `name` string — New name for the tenant. Tenant Name must be unique within the account. Must be 3-100 characters. Special characters ' " # ? / \ are not allowed.
  - `description` string — Description of the the tenant.
  - `metadata` object — metadata is freeform JSON. It allows to store custom keys and values. It will be useful for storing information about an external applications that will refer to CoreStack tenant.
  - `account_id` string — Id of the CoreStack account under which the tenant to be updated.
  - `fiscal_year_configuration` FiscalYearConfiguration
    - `start` string — Start Date for Financial Year in DD-MMM format
    - `end` string — End Date for Financial Year in DD-MMM format
  - `cost_anomaly_settings` CostAnomalyConfiguration
    - `threshold_configuration` CostAnomalySetting
      - `category` 'all' | 'product_category' | 'resource_category' — Cost anomaly settings category.
      - `category_values` string[] — List of categories.
      - `minimum_cost_spend` integer — Minimum Cost Spend
      - `minimum_cost_impact` integer — Minimum Cost Impact
      - `minimum_cost_impact_percentage` integer — Minimum Cost Anomaly Impact Percentage
      - `cost_impact_spend_operator` 'and' | 'or' — Cost Impact and Spend condition
    - `notifications` ConfigurationForCostAnomalyNotification[] — Notification configuration.
      - `enabled` boolean — Whether Notifications Are Enabled
      - `emails` string[] — Emails
      - `webhooks` string[] — Webhooks
      - `microsoft_teams_webhooks` string[] — Microsoft Teams Webhooks
      - `enable_realtime_notification` boolean — Specifies whether realtime notification enabled or not.
      - `enable_daily_summary_notification` boolean — Specifies whether daily summary notification enabled or not.
  - `cost_processing_settings` CostProcessingSettings
    - `max_tag_value_count` integer — Maximum number of unique values per tag to process for cost allocation tags
    - `number_of_months_to_backfill` integer — Back filling value for cost processing (in months)
  - `azure_hybrid_benefits_enabled` boolean — azure hybrid benefits enabled under finOps
  - `disk_utilization_settings` DiskUtilizationSetting
    - `settings` DiskUtilizationWorkspaceConfiguration[]
      - `workspace_ids` string[] — Log Analytics Workspace Ids
      - `service_account_id` string — Service Account Id
  - `dimension_settings` DimensionTenantSettings[] — Dimension Settings for this Tenant
    - `product` 'AppSecOps' | 'Assessments' | 'CloudOps' | 'FinOps' | 'Product_Admin' | 'SecOps' | 'Self Service' | 'StackOps', required — Name of the product
    - `mandate_dimension_selection` boolean — Mandate Dimension Selection
  - `status` 'active' | 'suspended' — Indicates the status of the Tenant

## Response `200`

Success

- TenantUpdateResponse
  - `tenant_id` string, required — Id of the updated tenant. This Id will be used for performing tenant level operations such as createPolicy, createScript, onboardCloudAccount and so on.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `500` — Internal Server Error

---

[API](https://skmtc.dev/corestack/apis/corestack-external-api.md) · [All operations](https://skmtc.dev/corestack/apis/corestack-external-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/corestack/corestack-external-api/revisions/bf2cdf20826d/schema)