v57

latestOpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-08-012143051018.3 KB

Tenant

Retrieve Tenant for current Org

Retrieve Tenant entity for current Org.

capabilities.targetedInstanceCreation is a deprecated read-only aggregate: it is true when all Ready Tenant Account for this Tenant has TargetedInstanceCreation enabled in its configuration to preserve backwards compatibility. Configure the capability per Provider/per Site via PATCH /tenant/account/{accountId} using siteCapabilities. Disallowing at Provider or Site level would result in no value returned here.

User must have authorization role with TENANT_ADMIN suffix.

get/v2/org/{org}/nico/tenant/current

Response

idstring uuid

Unique ID of the Tenant

orgstring

Name/external ID of Tenant's organization

orgDisplayNamestring nullable

Display name of Tenant's organization

createdstring date-time

Date/time the Tenant was created

updatedstring date-time

Date/time when Tenant was last updated

Example response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "org": "qygdmg8oqik8",
  "orgDisplayName": "Echo Corporation",
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "capabilities": {
    "targetedInstanceCreation": true
  },
  "deprecations": [
    {
      "attribute": "capabilities.targetedInstanceCreation",
      "replacedBy": "tenantAccount.siteCapabilities",
      "takeActionBy": "2026-10-01T00:00:00Z",
      "notice": "'capabilities.targetedInstanceCreation' is being deprecated in favor of 'tenantAccount.siteCapabilities'. Please take action prior to the specified date"
    }
  ]
}