IOrganizationSettingsService
This service provides access to organization settings
export interface IOrganizationSettingsService
Methods
Method | Description |
|---|---|
Deletes active LLM endpoint for the organization. | |
Deletes active LLM provider for the organization. | |
(ALPHA) Deletes AI rate limit override for the organization, reverting to the platform default. | |
Deletes color palette from organization settings returning chart colors to default. | |
(BETA) Deletes the default export template setting from the organization, reverting to the built-in default. | |
(ALPHA) Clears the organization CSV delimiter configuration so the default (comma) is used. | |
(ALPHA) Deletes the geo icon sprite sheet setting from the organization. | |
Deletes theme from organization settings returning workspace styling to default. | |
(ALPHA) Returns the AI rate limit value owned by the organization (without resolving inherited defaults). Returns | |
(ALPHA) Returns the data locale set on the organization (without resolving inherited defaults). Returns | |
(ALPHA) Returns the metadata locale set on the organization (without resolving inherited defaults). Returns | |
Returns effective organization settings with all defaults resolved. | |
Sets active calendars configuration for organization. | |
Set active LLM endpoint for the organization. | |
Set active LLM provider for the organization. | |
(ALPHA) Sets AI rate limit for the organization. | |
Sets alert default | |
Sets attachment size limit sent to email for organization. | |
Sets color palette for organization. | |
(ALPHA) Sets DashboardFiltersApplyMode configuration for organization. | |
Sets date format for organization. | |
(BETA) Sets the default export template applied to slide exports when none is explicitly requested. | |
(ALPHA) Sets enable AI on data setting for organization. | |
(ALPHA) Sets enable drill to URL by default configuration for organization. | |
(ALPHA) Sets enable null joins configuration for organization. | |
(ALPHA) Sets enable partial data results configuration for organization. | |
(ALPHA) Sets enable query tags setting for organization. | |
(ALPHA) Sets whether end users may change the timezone in Analytical Designer and, by default, on dashboards. | |
(ALPHA) Sets the default CSV delimiter for exports in the organization. | |
Sets fiscal calendar for organization. | |
Sets format locale for organization. | |
(ALPHA) Sets the geo icon sprite sheet URL for the organization. | |
Sets locale for organization. | |
Sets the maximum zoom level allowed for geo visualizations in the organization. | |
Sets metadata locale for organization. | |
Sets metric format override for organization. | |
(ALPHA) Sets OpenAI configuration for organization. | |
Set separators for the organization | |
Sets theme for organization. | |
Sets timezone for organization. | |
Sets first day of week for organization. | |
Sets whiteLabeling for organization. |
Method details
IOrganizationSettingsService.deleteActiveLlmEndpoint()method
Deletes active LLM endpoint for the organization.
deleteActiveLlmEndpoint(): Promise<void>;
Returns
Promise<void>
promise
IOrganizationSettingsService.deleteActiveLlmProvider()method
Deletes active LLM provider for the organization.
deleteActiveLlmProvider(): Promise<void>;
Returns
Promise<void>
IOrganizationSettingsService.deleteAiRateLimit()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Deletes AI rate limit override for the organization, reverting to the platform default.
deleteAiRateLimit(): Promise<void>;
Returns
Promise<void>
promise
IOrganizationSettingsService.deleteColorPalette()method
Deletes color palette from organization settings returning chart colors to default.
deleteColorPalette(): Promise<void>;
Returns
Promise<void>
promise
IOrganizationSettingsService.deleteDefaultExportTemplate()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Deletes the default export template setting from the organization, reverting to the built-in default.
deleteDefaultExportTemplate(): Promise<void>;
Returns
Promise<void>
promise
IOrganizationSettingsService.deleteExportCsvCustomDelimiter()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Clears the organization CSV delimiter configuration so the default (comma) is used.
deleteExportCsvCustomDelimiter(): Promise<void>;
Returns
Promise<void>
promise
IOrganizationSettingsService.deleteGeoIconSheet()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Deletes the geo icon sprite sheet setting from the organization.
deleteGeoIconSheet(): Promise<void>;
Returns
Promise<void>
promise
IOrganizationSettingsService.deleteTheme()method
Deletes theme from organization settings returning workspace styling to default.
deleteTheme(): Promise<void>;
Returns
Promise<void>
promise
IOrganizationSettingsService.getAiRateLimit()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Returns the AI rate limit value owned by the organization (without resolving inherited defaults). Returns undefined when the organization has no override.
getAiRateLimit(): Promise<IAiRateLimit | undefined>;
Returns
Promise<IAiRateLimit | undefined>
promise
IOrganizationSettingsService.getDataLocale()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Returns the data locale set on the organization (without resolving inherited defaults). Returns undefined when the organization has none.
getDataLocale(): Promise<string | undefined>;
Returns
Promise<string | undefined>
promise
IOrganizationSettingsService.getMetadataLocale()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Returns the metadata locale set on the organization (without resolving inherited defaults). Returns undefined when the organization has none.
getMetadataLocale(): Promise<string | undefined>;
Returns
Promise<string | undefined>
promise
IOrganizationSettingsService.getSettings()method
Returns effective organization settings with all defaults resolved.
getSettings(): Promise<ISettings>;
Returns
Promise<ISettings>
promise of resolved settings
Remarks
The returned settings include system defaults, not just those directly set at the organization level. User-specific overrides are excluded. User has to have an organization level permission to access them.
IOrganizationSettingsService.setActiveCalendars()method
Sets active calendars configuration for organization.
setActiveCalendars(calendars: IActiveCalendars): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
calendars | configuration for which calendars are enabled and which is the default. |
Returns
Promise<void>
promise
IOrganizationSettingsService.setActiveLlmEndpoint()method
Set active LLM endpoint for the organization.
setActiveLlmEndpoint(endpoint: string): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
endpoint | string | id of the LLM endpoint to set as active for the organization. |
Returns
Promise<void>
promise
IOrganizationSettingsService.setActiveLlmProvider()method
Set active LLM provider for the organization.
setActiveLlmProvider(provider: string, defaultModelId: string): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
provider | string | id of the LLM provider to set as active for the organization. |
defaultModelId | string | id of the default model to use for the provider. |
Returns
Promise<void>
IOrganizationSettingsService.setAiRateLimit()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Sets AI rate limit for the organization.
setAiRateLimit(value: IAiRateLimit): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
value | max interactions and rolling time window for AI chat. |
Returns
Promise<void>
promise
IOrganizationSettingsService.setAlertDefault()method
Sets alert default
setAlertDefault(value: IAlertDefault): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
value | describes parameters for alerting. |
Returns
Promise<void>
promise
IOrganizationSettingsService.setAttachmentSizeLimit()method
Sets attachment size limit sent to email for organization.
setAttachmentSizeLimit(size: number): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
size | number | the size in bytes. |
Returns
Promise<void>
promise
IOrganizationSettingsService.setColorPalette()method
Sets color palette for organization.
setColorPalette(colorPaletteId: string): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
colorPaletteId | string | ID of the color palette to apply to charts in organization. |
Returns
Promise<void>
promise
IOrganizationSettingsService.setDashboardFiltersApplyMode()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Sets DashboardFiltersApplyMode configuration for organization.
setDashboardFiltersApplyMode(dashboardFiltersApplyMode: DashboardFiltersApplyMode): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
dashboardFiltersApplyMode | describes new mode for applying dashboard filters. |
Returns
Promise<void>
promise
IOrganizationSettingsService.setDateFormat()method
Sets date format for organization.
setDateFormat(dateFormat: string): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
dateFormat | string | the format based on the ICU standard, for example: “en-US”, “cs-CZ”, etc. |
Returns
Promise<void>
promise
IOrganizationSettingsService.setDefaultExportTemplate()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Sets the default export template applied to slide exports when none is explicitly requested.
setDefaultExportTemplate(value: IDefaultExportTemplate): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
value | identifier and scope of the export template to use as the default. |
Returns
Promise<void>
promise
IOrganizationSettingsService.setEnableAiOnData()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Sets enable AI on data setting for organization.
setEnableAiOnData(enabled: boolean): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
enabled | boolean | whether to enable sending aggregated data to LLM. |
Returns
Promise<void>
promise
IOrganizationSettingsService.setEnableDrillToUrlByDefault()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Sets enable drill to URL by default configuration for organization.
setEnableDrillToUrlByDefault(enabled: boolean): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
enabled | boolean | whether to enable drill to URL by default for dashboard widgets. |
Returns
Promise<void>
promise
IOrganizationSettingsService.setEnableNullJoins()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Sets enable null joins configuration for organization.
setEnableNullJoins(enabled: boolean): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
enabled | boolean | whether to enable null value matching in SQL joins. |
Returns
Promise<void>
promise
Remarks
When enabled, generated SQL joins coalesce null values before comparing join keys. Workspaces inherit this value unless they override it.
IOrganizationSettingsService.setEnablePartialDataResults()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Sets enable partial data results configuration for organization.
setEnablePartialDataResults(enabled: boolean): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
enabled | boolean | whether to allow partial data results for executions. |
Returns
Promise<void>
promise
Remarks
When enabled, executions that reach a row/column/cell limit return partial data (with limit-break metadata) instead of failing. Workspaces inherit this value unless they override it.
IOrganizationSettingsService.setEnableQueryTags()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Sets enable query tags setting for organization.
setEnableQueryTags(enabled: boolean): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
enabled | boolean | whether to enable query tags for this organization. |
Returns
Promise<void>
promise
IOrganizationSettingsService.setEnableTimezoneChange()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Sets whether end users may change the timezone in Analytical Designer and, by default, on dashboards.
setEnableTimezoneChange(enabled: boolean): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
enabled | boolean | whether end users may change the timezone |
Returns
Promise<void>
promise
IOrganizationSettingsService.setExportCsvCustomDelimiter()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Sets the default CSV delimiter for exports in the organization.
setExportCsvCustomDelimiter(delimiter: string): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
delimiter | string | single character delimiter to use for CSV exports. |
Returns
Promise<void>
promise
IOrganizationSettingsService.setFiscalCalendar()method
Sets fiscal calendar for organization.
setFiscalCalendar(fiscalYear: IFiscalYear): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
fiscalYear | fiscal year configuration including month offset and optional prefixes. |
Returns
Promise<void>
promise
IOrganizationSettingsService.setFormatLocale()method
Sets format locale for organization.
setFormatLocale(locale: string): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
locale | string | IETF BCP 47 Code locale ID, for example “en-US”, “cs-CZ”, etc. |
Returns
Promise<void>
promise
IOrganizationSettingsService.setGeoIconSheet()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Sets the geo icon sprite sheet URL for the organization.
setGeoIconSheet(url: string): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
url | string | URL of the Mapbox sprite sheet (without file extension). |
Returns
Promise<void>
promise
IOrganizationSettingsService.setLocale()method
Sets locale for organization.
setLocale(locale: string): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
locale | string | IETF BCP 47 Code locale ID, for example “en-US”, “cs-CZ”, etc. |
Returns
Promise<void>
promise
IOrganizationSettingsService.setMaxZoomLevel()method
Sets the maximum zoom level allowed for geo visualizations in the organization.
setMaxZoomLevel(level: number | null): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
level | number | null | maximum zoom level, or null to clear the limit. |
Returns
Promise<void>
promise
IOrganizationSettingsService.setMetadataLocale()method
Sets metadata locale for organization.
setMetadataLocale(locale: string): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
locale | string | IETF BCP 47 Code locale ID, for example “en-US”, “cs-CZ”, etc. |
Returns
Promise<void>
promise
IOrganizationSettingsService.setMetricFormatOverride()method
Sets metric format override for organization.
setMetricFormatOverride(override: IMetricFormatOverrideSetting): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
override | mapping of metric types to custom format strings. |
Returns
Promise<void>
promise
IOrganizationSettingsService.setOpenAiConfig()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Sets OpenAI configuration for organization.
setOpenAiConfig(config: IOpenAiConfig): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
config | describes parameters for OpenAI integration. |
Returns
Promise<void>
promise
IOrganizationSettingsService.setSeparators()method
Set separators for the organization
setSeparators(separators: ISeparators): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
separators | separators for the organization |
Returns
Promise<void>
promise
IOrganizationSettingsService.setTheme()method
Sets theme for organization.
setTheme(themeId: string): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
themeId | string | ID of the theme to apply to workspaces in organization. |
Returns
Promise<void>
promise
IOrganizationSettingsService.setTimezone()method
Sets timezone for organization.
setTimezone(timezone: string): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
timezone | string | the value based on IANA time zone database naming convention. for example: “America/Los_Angeles”, etc. |
Returns
Promise<void>
promise
IOrganizationSettingsService.setWeekStart()method
Sets first day of week for organization.
setWeekStart(weekStart: string): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
weekStart | string | “Sunday | “Monday” |
Returns
Promise<void>
promise
IOrganizationSettingsService.setWhiteLabeling()method
Sets whiteLabeling for organization.
setWhiteLabeling(whiteLabeling: IWhiteLabeling): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
whiteLabeling | describes whitelabeling setting for logoUrl, faviconUrl etc. |
Returns
Promise<void>
promise