Written by

Get tenant details

Returns the current tenant state and public settings.

Request

POST

https://api.datalens.tech/rpc/getTenantDetails

Headers

Name

Description

x-dl-api-version

Type: string

API version header.

Const: 3

Example: 3

Responses

200 OK

Response

Body

application/json

{
  "tenantId": "example",
  "orgId": "example",
  "settings": {
    "dataExportProhibited": true,
    "prohibitionPublication": true,
    "workbookFileExportProhibited": true,
    "defaultColorPaletteId": "example",
    "aiAssistantProhibited": true,
    "externalAIProvidersEnabled": true,
    "aiChatHistoryProhibited": true,
    "sharingProhibited": true,
    "newObjectCreatorRole": "admin",
    "defaultSidebarMode": "simplified",
    "autoAssignLicenses": true,
    "autoBuyLicenses": true,
    "autoBuyLicensesLimit": 0.5
  },
  "dlpEnabled": true,
  "foldersEnabled": true
}

Name

Description

dlpEnabled

Type: boolean

Whether DataLens Platform mode is enabled for the tenant.

foldersEnabled

Type: boolean

Whether legacy folder navigation is enabled for the tenant.

orgId

Type: string | null

ID of the organization. Null when the tenant has no organization.

Example: example

settings

Type: object

aiAssistantProhibited	Type: boolean Whether the Neuroanalyst is prohibited for the tenant.
aiChatHistoryProhibited	Type: boolean Whether storing Neuroanalyst chat history is prohibited for the tenant.
autoAssignLicenses	Type: boolean Whether seats are assigned automatically.
autoBuyLicenses	Type: boolean Whether additional seats are purchased automatically.
autoBuyLicensesLimit	Type: number \| null Maximum number of seats that can be purchased automatically.
dataExportProhibited	Type: boolean Whether exporting data is prohibited for the tenant.
defaultColorPaletteId	Type: string ID of the default color palette. Example: `example`
defaultSidebarMode	Type: string Default sidebar display mode. Enum: `simplified`, `full`
externalAIProvidersEnabled	Type: boolean Whether Neuroanalyst may use models hosted outside Yandex Cloud.
newObjectCreatorRole	Type: string Default role assigned to the creator of a new object. Enum: `admin`, `editor`, `none`
prohibitionPublication	Type: boolean Whether entries publication is prohibited for the tenant.
sharingProhibited	Type: boolean Whether creating temporary public links is prohibited for the tenant.
workbookFileExportProhibited	Type: boolean Whether workbooks export is prohibited for the tenant.
[additional]	Type: unknown Example: `null`

Public tenant settings. Additional public settings may be returned.

Example

{
  "dataExportProhibited": true,
  "prohibitionPublication": true,
  "workbookFileExportProhibited": true,
  "defaultColorPaletteId": "example",
  "aiAssistantProhibited": true,
  "externalAIProvidersEnabled": true,
  "aiChatHistoryProhibited": true,
  "sharingProhibited": true,
  "newObjectCreatorRole": "admin",
  "defaultSidebarMode": "simplified",
  "autoAssignLicenses": true,
  "autoBuyLicenses": true,
  "autoBuyLicensesLimit": 0.5
}

tenantId

Type: string

ID of the current DataLens tenant.

Example: example

Get tenant details

RequestRequest

HeadersHeaders

ResponsesResponses

200 OK200 OK

BodyBody

Was the article helpful?

Request

Headers

Responses

200 OK

Body