{"swagger":"2.0","basePath":"/api/v1","produces":["application/json","text/plain","application/zip"],"paths":{"/themes/fonts":{"post":{"summary":"Add custom font","description":"Upload a custom font for use with UI Themes. Requires at least 1 and up to 3 font files for the different font weights (regular, semi-bold and bold). If a custom font with the provided name already exists, it will be overriden. You cannot override system fonts.","consumes":"multipart/form-data","tags":["themes"],"responses":{"200":{"description":"Font was updated","schema":{"properties":{"name":{"type":"string"},"systemFont":{"type":"boolean"}}}},"201":{"description":"Font was added","schema":{"properties":{"name":{"type":"string"},"systemFont":{"type":"boolean"}}}},"400":{"description":"client error"},"403":{"description":"User does not have permission"},"409":{"description":"Conflict - A system font with the same name already exists and cannot be overridden"}},"parameters":[{"in":"formData","name":"name","type":"string","required":true,"description":"The name to be used for this font. If it matches an existing custom font, that font will be overwritten."},{"in":"formData","name":"normal","type":"file","required":true,"description":"A regular version of the font. Accepts .ttf files up to 1 MB"},{"in":"formData","name":"semibold","type":"file","required":false,"description":"A semibold version of the font. Accepts .ttf files up to 1 MB"},{"in":"formData","name":"bold","type":"file","required":false,"description":"A bold version of the font. Accepts .ttf files up to 1 MB"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]},"get":{"summary":"List fonts","description":"Get a list of all installed fonts, both default system fonts and custom fonts","tags":["themes"],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"systemFont":{"type":"boolean"}}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]}},"/themes/fonts/{name}":{"get":{"summary":"Get font by name","description":"Get font properties by font name","tags":["themes"],"responses":{"200":{"description":"success","schema":{"properties":{"name":{"type":"string"},"systemFont":{"type":"boolean"}}}},"403":{"description":"User does not have permission"},"404":{"description":"Font not found"}},"parameters":[{"in":"path","description":"font name","name":"name","required":true,"type":"string"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]},"delete":{"summary":"Delete custom font","description":"Delete a custom font by font name. Note that system fonts cannot be deleted.","tags":["themes"],"responses":{"204":{"description":"Deleted"},"400":{"description":"Client error"},"403":{"description":"User does not have permission"},"404":{"description":"Font not found"},"405":{"description":"Method not allowed - Cannot delete system font"}},"parameters":[{"in":"path","description":"name of font to delete","name":"name","required":true,"type":"string"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]}},"/reporting":{"post":{"consumes":["application/json"],"description":"The **send report** endpoint receives asset info and recipients list and sends an email report. Note: the users and groups in the recipients section must be **shared** to the dashboard.","operationId":"ReportingController_sendReports","parameters":[{"description":"Admin access flag","in":"query","name":"adminAccess","required":false,"type":"boolean"},{"description":"Return full report result object or base one","in":"query","name":"fullReport","required":false,"type":"boolean"},{"description":"An object containing the data needed to send the report. AssetId is the Dashboard ID and the recipients array should contain the user's email/ID and group's ID along with its type. The preferences section describes the content of the email to be sent.","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/ReportObjectDto"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Send report operation was successful","schema":{"$ref":"#/definitions/ReportingResultDto"}},"400":{"description":"Bad request"},"403":{"description":"User does not have permission"},"404":{"description":"Not found"},"422":{"description":"Unprocessable Entity"}},"summary":"Send E-Mail report for an asset","tags":["reporting"]}},"/reporting/dashboard/{dashboardId}/allowed-change-subscription":{"get":{"description":"Retrieves the information, if user can create custom subscription for this dashboard.","operationId":"SubscriptionController_getAllowChangeSubscription","parameters":[{"in":"path","name":"dashboardId","required":true,"type":"string"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Retrieved subscription info successfully","schema":{"$ref":"#/definitions/ResponseUserAllowedToChangeSubscription"}},"403":{"description":"User does not have permission"}},"summary":"Get is user able to change subscription for dashboard","tags":["reporting"]}},"/reporting/dashboard/{dashboardId}/subscription":{"get":{"description":"Retrieves the shared subscription configuration for the specified dashboard.","operationId":"SubscriptionController_getSharedSubscriptionConfiguration","parameters":[{"in":"path","name":"dashboardId","required":true,"type":"string"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Retrieved shared subscription configuration successfully","schema":{"$ref":"#/definitions/ResponseSharedSubscriptionConfigurationDto"}},"403":{"description":"User does not have permission"},"404":{"description":"Subscription not found for the specified dashboard"}},"summary":"Get shared dashboard report subscription","tags":["reporting"]},"post":{"consumes":["application/json"],"description":"Creates a new subscription or updates an existing one for the specified dashboard. Accepts subscription configuration details in the request body.","operationId":"SubscriptionController_createSharedSubscription","parameters":[{"in":"path","name":"dashboardId","required":true,"type":"string"},{"description":"An object containing subscription configuration properties","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CreateSharedSubscriptionConfigurationDto"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}],"produces":["application/json"],"responses":{"201":{"description":"Subscription configuration processed successfully","schema":{"$ref":"#/definitions/ResponseSharedSubscriptionConfigurationDto"}},"400":{"description":"Bad request"},"403":{"description":"User does not have permission"}},"summary":"Create or update a shared dashboard report subscription","tags":["reporting"]}},"/reporting/dashboard/{dashboardId}/user-subscription":{"get":{"description":"Retrieves the user specific subscription configuration for the specified dashboard.","operationId":"SubscriptionController_getUserSubscriptionConfiguration","parameters":[{"in":"path","name":"dashboardId","required":true,"type":"string"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Retrieved user specific subscription configuration successfully","schema":{"$ref":"#/definitions/ResponseUserSubscriptionConfigurationDto"}},"403":{"description":"User does not have permission"},"404":{"description":"User specific subscription not found for the specified dashboard"}},"summary":"Get user specific dashboard report subscription","tags":["reporting"]},"post":{"consumes":["application/json"],"description":"Creates a new user specific subscription or updates an existing one for the specified dashboard. Accepts subscription configuration details in the request body.","operationId":"SubscriptionController_createUserSubscription","parameters":[{"in":"path","name":"dashboardId","required":true,"type":"string"},{"description":"An object containing user subscription configuration properties","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CreateUserSubscriptionConfigurationDto"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}],"produces":["application/json"],"responses":{"201":{"description":"Subscription configuration processed successfully","schema":{"$ref":"#/definitions/ResponseUserSubscriptionConfigurationDto"}},"400":{"description":"Bad request"},"403":{"description":"User does not have permission"}},"summary":"Create or update a user specific dashboard report subscription","tags":["reporting"]}},"/plugins":{"x-swagger-router-controller":"plugins.api.controller.v1","get":{"x-roles-allowed":"tenantAdmin,admin","operationId":"getPlugins","summary":"Return a list of your plug-ins","description":"The **get plugins** endpoint returns a list of plugins with their details\nand provided filtration and ordering.\n<br/>Results can be filtered and ordered by the following parameters.\n","tags":["plugins"],"responses":{"200":{"description":"get plugins success response","schema":{"type":"object","description":"Plugin response model","properties":{"plugins":{"type":"array","items":{"type":"object","description":"Plugin object","properties":{"name":{"description":"plugin name","type":"string"},"version":{"description":"version of plugin","type":["string","number"]},"lastUpdate":{"description":"last time plugin updated","type":"string"},"isEnabled":{"description":"enabled/disabled plugin status","type":"boolean"},"folderName":{"description":"plugin folder name","type":"string"}}}},"count":{"description":"amount of plugins","type":"number"},"queryMetadata":{"type":"object","properties":{"limit":{"description":"limit of items to return","type":"number"},"skip":{"description":"number of items to skip","type":"number"},"search":{"description":"filter by provided string","type":"string"},"orderby":{"description":"order by specific field","type":"string"},"tenantId":{"description":"tenantId field","type":"string"},"desc":{"description":"sort by descending or ascending","type":"boolean"}}}}}},"403":{"description":"User does not have permission"},"404":{"description":"Invalid  parameter.","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"query","name":"tenantId","description":"tenantId field","required":false,"type":"string"},{"in":"query","name":"orderby","description":"Filter by provided field","required":false,"type":"string"},{"in":"query","name":"desc","description":"Order by descending/ascending","required":false,"type":"boolean"},{"in":"query","name":"search","description":"Filter according to provided string","required":false,"type":"string"},{"in":"query","name":"skip","description":"Number of results to skip from the start of the data set. skip is to be used with the `limit` parameter for paging","required":false,"type":"integer","minimum":0},{"in":"query","name":"limit","description":"How many results should be returned. limit is to be used with the `skip` parameter for paging","required":false,"type":"integer","minimum":1},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]},"patch":{"x-permission-type":"admins-only","x-roles-allowed":"tenantAdmin,admin","operationId":"updatePlugins","summary":"Update your plug-in’s metadata","description":"The **patch plugins** endpoint updates the metadata of a plug-in and returns a list of modified plug-ins.\n Metadata for a plug-in includes its filename, directory location, and version details.\n","tags":["plugins"],"responses":{"200":{"description":"all plugins successfully updated.","schema":{"description":"Plugin updated response model","type":"array","items":{"type":"object","description":"Plugin object","properties":{"name":{"description":"plugin name","type":"string"},"version":{"description":"version of plugin","type":["string","number"]},"lastUpdate":{"description":"last time plugin updated","type":"string"},"isEnabled":{"description":"enabled/disabled plugin status","type":"boolean"},"folderName":{"description":"plugin folder name","type":"string"}}}}},"202":{"description":"some plugins successfully updated.","schema":{"description":"Plugin updated response model","type":"array","items":{"type":"object","description":"Plugin object","properties":{"name":{"description":"plugin name","type":"string"},"version":{"description":"version of plugin","type":["string","number"]},"lastUpdate":{"description":"last time plugin updated","type":"string"},"isEnabled":{"description":"enabled/disabled plugin status","type":"boolean"},"folderName":{"description":"plugin folder name","type":"string"}}}}},"403":{"description":"User does not have permission"},"404":{"description":"No plugins updated.","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"query","name":"tenantId","description":"tenantId field","required":false,"type":"string"},{"in":"body","description":"plugins array to be updated.","name":"plugins","required":true,"schema":{"description":"Plugin updated response model","type":"array","items":{"type":"object","description":"Plugin object","properties":{"name":{"description":"plugin name","type":"string"},"version":{"description":"version of plugin","type":["string","number"]},"lastUpdate":{"description":"last time plugin updated","type":"string"},"isEnabled":{"description":"enabled/disabled plugin status","type":"boolean"},"folderName":{"description":"plugin folder name","type":"string"}}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/plugins/get_info":{"x-swagger-router-controller":"plugins.api.controller.v1","get":{"x-permission-type":"authenticate","x-hide":false,"operationId":"getPluginsBuildInfo","summary":"Return the plug-in’s build information","description":"The **get_info** endpoint returns the build information including the JavaScript file name and last build error.","tags":["plugins"],"responses":{"200":{"description":"No response was specified"},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"query","description":"Returns response in JavaScript format or not.","name":"returnFile","required":false,"type":"boolean"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/plugins/import":{"x-swagger-router-controller":"plugins.api.controller.v1","x-permission-type":"admins-only","post":{"consumes":["multipart/form-data"],"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"query","description":"Should the system overwrite the plugin if it's instance already exists in the system.","name":"overwrite","required":false,"type":"boolean","default":false},{"in":"formData","name":"plugins","type":"file","required":true,"description":"Archived (`.zip`) plugin to import."},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"responses":{"200":{"description":"plugin successfully imported","schema":{"type":"string"}},"400":{"description":"- **40001** The imported plugin's file should be a valid `.zip` file\n- **40002** The imported `.zip` file should contain one root folder\n- **40003** Invalid `plugin.json` manifest\n- **40004** The plugin with the same or higher version already exists in the system\n- **40005** The plugin with a higher infra version already exists in the system\n- **40006** Invalid plugin name. The plugin with the same folder name but different plugin name already exists in the system\n- **40007** Invalid plugin identifier provided. Identifier should be provided in pluginFolderName/pluginName format\n- **40008** Invalid plugin with the same id(folderName/pluginName) already exists in the system\n- **40009** Plugin with the same id(folderName/pluginName) already exists in the system. Please, set the `overwrite` parameter to `true` to overwrite\n","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}},"description":"The **import plugin** endpoint receives a `.zip` file containing an exported plugin and adds it to the system. If the plugin already exists, it will be overridden.","tags":["plugins"],"summary":"Import a plugin","operationId":"importPlugin"}},"/plugins/{id}/export":{"x-swagger-router-controller":"plugins.api.controller.v1","get":{"x-permission-type":"admins-only","summary":"Export a plugin","description":"The **export plugin** endpoint returns a `.zip` file containing the specified plugin, that can be imported back into Sisense.\n","tags":["plugins"],"operationId":"exportPlugin","responses":{"200":{"description":"Archived plugin file","schema":{"type":"string"}},"400":{"description":"- **40007** Invalid plugin identifier provided. Identifier should be provided in `pluginFolderName/pluginName` format\n","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"},"404":{"description":"Plugin not found","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"The ID of the plugin to export in `folderName/pluginName` format.","name":"id","required":true,"type":"string","pattern":"^[a-zA-Z0-9_-]+\\/[a-zA-Z0-9_-]+$"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"produces":["application/zip"]}},"/plugins/{id}":{"x-swagger-router-controller":"plugins.api.controller.v1","delete":{"x-permission-type":"admins-only","summary":"Delete a plugin","description":"The **delete plugin** endpoint deletes a plugin with the provided ID.\n","tags":["plugins"],"operationId":"deletePlugin","responses":{"204":{"description":"Delete operation was successful"},"400":{"description":"- **40007** Invalid plugin identifier provided. Identifier should be provided in `pluginFolderName/pluginName` format\n","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"},"404":{"description":"Plugin not found","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"The ID of the plugin to be removed in `folderName/pluginName` format.","name":"id","required":true,"type":"string","pattern":"^[a-zA-Z0-9_-]+\\/[a-zA-Z0-9_-]+$"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/settings/email_server":{"x-swagger-router-controller":"settings.emailServer.controller.v1","x-permission-type":"admins-only","get":{"operationId":"getEmailServer","summary":"Return email server settings","description":"The **email server settings** used for Email Server settings managing.\n","tags":["settings"],"responses":{"200":{"description":"Email server settings","schema":{"type":"object","required":["enable","host","port"],"properties":{"enable":{"type":"boolean","description":"If TRUE enable email server instead of default."},"maxRecipientsPerType":{"type":"integer","description":"Maximum number of recipients per type."},"host":{"type":"string","description":"Hostname or IP address to connect to."},"port":{"type":"integer","description":"Port to connect to."},"secure":{"type":"boolean","default":false,"description":"If TRUE the connection will only use TLS. If false (the default), TLS may still be upgraded to if available via the STARTTLS command."},"ignoreTLS":{"type":"boolean","default":false,"description":"If this is TRUE and secure is FALSE, TLS will not be used (either to connect, or as a STARTTLS connection upgrade command)."},"requireTLS":{"type":"boolean","default":false,"description":"If this is TRUE and secure is FALSE, it forces application to use STARTTLS even if the server does not advertise support for it."},"connectionTimeout":{"type":"integer","minimum":0,"default":10000,"description":"How many milliseconds to wait for the connection to establish."},"greetingTimeout":{"type":"integer","minimum":0,"default":5000,"description":"How many milliseconds to wait for the greeting after connection is established."},"socketTimeout":{"type":"integer","minimum":0,"default":5000,"description":"How many milliseconds of inactivity to allow."},"user":{"type":"string","description":"User name."},"pass":{"type":"string","description":"User password."},"logger":{"type":"boolean","default":false,"description":"If set to true then logs to console. If value is not set or is false then nothing is logged."},"debug":{"type":"boolean","default":false,"description":"If set to true, then logs SMTP traffic, otherwise logs only transaction events."},"customAuthMethod":{"type":"string","description":"Custom authentication method (NTLM)"},"type":{"type":"string","description":"SMTP or Mandrill"},"apiKey":{"type":"string","description":"Mandrill API Key"},"workstation":{"type":"string","description":"NTLM workstation"},"domain":{"type":"string","description":"NTML domain"},"senderName":{"type":"string","description":"Name of sender."},"senderEmail":{"type":"string","description":"Email of sender."}}}},"403":{"description":"User does not have permission"},"404":{"description":"Email server does not set","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]},"post":{"operationId":"addEmailServer","summary":"Add email server settings","description":"The **email server settings** used for Email Server settings managing.\n","tags":["settings"],"responses":{"200":{"description":"Email server settings","schema":{"type":"object","required":["enable","host","port"],"properties":{"enable":{"type":"boolean","description":"If TRUE enable email server instead of default."},"maxRecipientsPerType":{"type":"integer","description":"Maximum number of recipients per type."},"host":{"type":"string","description":"Hostname or IP address to connect to."},"port":{"type":"integer","description":"Port to connect to."},"secure":{"type":"boolean","default":false,"description":"If TRUE the connection will only use TLS. If false (the default), TLS may still be upgraded to if available via the STARTTLS command."},"ignoreTLS":{"type":"boolean","default":false,"description":"If this is TRUE and secure is FALSE, TLS will not be used (either to connect, or as a STARTTLS connection upgrade command)."},"requireTLS":{"type":"boolean","default":false,"description":"If this is TRUE and secure is FALSE, it forces application to use STARTTLS even if the server does not advertise support for it."},"connectionTimeout":{"type":"integer","minimum":0,"default":10000,"description":"How many milliseconds to wait for the connection to establish."},"greetingTimeout":{"type":"integer","minimum":0,"default":5000,"description":"How many milliseconds to wait for the greeting after connection is established."},"socketTimeout":{"type":"integer","minimum":0,"default":5000,"description":"How many milliseconds of inactivity to allow."},"user":{"type":"string","description":"User name."},"pass":{"type":"string","description":"User password."},"logger":{"type":"boolean","default":false,"description":"If set to true then logs to console. If value is not set or is false then nothing is logged."},"debug":{"type":"boolean","default":false,"description":"If set to true, then logs SMTP traffic, otherwise logs only transaction events."},"customAuthMethod":{"type":"string","description":"Custom authentication method (NTLM)"},"type":{"type":"string","description":"SMTP or Mandrill"},"apiKey":{"type":"string","description":"Mandrill API Key"},"workstation":{"type":"string","description":"NTLM workstation"},"domain":{"type":"string","description":"NTML domain"},"senderName":{"type":"string","description":"Name of sender."},"senderEmail":{"type":"string","description":"Email of sender."}}}},"400":{"description":"- **7501** Email server settings already exists\n"},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"Object with the settings of email server","name":"emailServer","required":true,"schema":{"type":"object","required":["enable","host","port"],"properties":{"enable":{"type":"boolean","description":"If TRUE enable email server instead of default."},"maxRecipientsPerType":{"type":"integer","description":"Maximum number of recipients per type."},"host":{"type":"string","description":"Hostname or IP address to connect to."},"port":{"type":"integer","description":"Port to connect to."},"secure":{"type":"boolean","default":false,"description":"If TRUE the connection will only use TLS. If false (the default), TLS may still be upgraded to if available via the STARTTLS command."},"ignoreTLS":{"type":"boolean","default":false,"description":"If this is TRUE and secure is FALSE, TLS will not be used (either to connect, or as a STARTTLS connection upgrade command)."},"requireTLS":{"type":"boolean","default":false,"description":"If this is TRUE and secure is FALSE, it forces application to use STARTTLS even if the server does not advertise support for it."},"connectionTimeout":{"type":"integer","minimum":0,"default":10000,"description":"How many milliseconds to wait for the connection to establish."},"greetingTimeout":{"type":"integer","minimum":0,"default":5000,"description":"How many milliseconds to wait for the greeting after connection is established."},"socketTimeout":{"type":"integer","minimum":0,"default":5000,"description":"How many milliseconds of inactivity to allow."},"user":{"type":"string","description":"User name."},"pass":{"type":"string","description":"User password."},"logger":{"type":"boolean","default":false,"description":"If set to true then logs to console. If value is not set or is false then nothing is logged."},"debug":{"type":"boolean","default":false,"description":"If set to true, then logs SMTP traffic, otherwise logs only transaction events."},"customAuthMethod":{"type":"string","description":"Custom authentication method (NTLM)"},"type":{"type":"string","description":"SMTP or Mandrill"},"apiKey":{"type":"string","description":"Mandrill API Key"},"workstation":{"type":"string","description":"NTLM workstation"},"domain":{"type":"string","description":"NTML domain"},"senderName":{"type":"string","description":"Name of sender."},"senderEmail":{"type":"string","description":"Email of sender."}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]},"patch":{"operationId":"updateEmailServer","summary":"Update email server settings","description":"The **email server settings** used for Email Server settings managing.\n","tags":["settings"],"responses":{"200":{"description":"Email server settings","schema":{"type":"object","required":["enable","host","port"],"properties":{"enable":{"type":"boolean","description":"If TRUE enable email server instead of default."},"maxRecipientsPerType":{"type":"integer","description":"Maximum number of recipients per type."},"host":{"type":"string","description":"Hostname or IP address to connect to."},"port":{"type":"integer","description":"Port to connect to."},"secure":{"type":"boolean","default":false,"description":"If TRUE the connection will only use TLS. If false (the default), TLS may still be upgraded to if available via the STARTTLS command."},"ignoreTLS":{"type":"boolean","default":false,"description":"If this is TRUE and secure is FALSE, TLS will not be used (either to connect, or as a STARTTLS connection upgrade command)."},"requireTLS":{"type":"boolean","default":false,"description":"If this is TRUE and secure is FALSE, it forces application to use STARTTLS even if the server does not advertise support for it."},"connectionTimeout":{"type":"integer","minimum":0,"default":10000,"description":"How many milliseconds to wait for the connection to establish."},"greetingTimeout":{"type":"integer","minimum":0,"default":5000,"description":"How many milliseconds to wait for the greeting after connection is established."},"socketTimeout":{"type":"integer","minimum":0,"default":5000,"description":"How many milliseconds of inactivity to allow."},"user":{"type":"string","description":"User name."},"pass":{"type":"string","description":"User password."},"logger":{"type":"boolean","default":false,"description":"If set to true then logs to console. If value is not set or is false then nothing is logged."},"debug":{"type":"boolean","default":false,"description":"If set to true, then logs SMTP traffic, otherwise logs only transaction events."},"customAuthMethod":{"type":"string","description":"Custom authentication method (NTLM)"},"type":{"type":"string","description":"SMTP or Mandrill"},"apiKey":{"type":"string","description":"Mandrill API Key"},"workstation":{"type":"string","description":"NTLM workstation"},"domain":{"type":"string","description":"NTML domain"},"senderName":{"type":"string","description":"Name of sender."},"senderEmail":{"type":"string","description":"Email of sender."}}}},"400":{"description":"- **7501** Email server settings not found\n"},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"Object with the settings of email server","name":"emailServer","required":true,"schema":{"type":"object","properties":{"enable":{"type":"boolean","description":"If TRUE enable email server instead of default."},"maxRecipientsPerType":{"type":"integer","description":"Maximum number of recipients per type."},"host":{"type":"string","description":"Hostname or IP address to connect to."},"port":{"type":"integer","description":"Port to connect to."},"secure":{"type":"boolean","default":false,"description":"If TRUE the connection will only use TLS. If false (the default), TLS may still be upgraded to if available via the STARTTLS command."},"ignoreTLS":{"type":"boolean","default":false,"description":"If this is TRUE and secure is FALSE, TLS will not be used (either to connect, or as a STARTTLS connection upgrade command)."},"requireTLS":{"type":"boolean","default":false,"description":"If this is TRUE and secure is FALSE, it forces application to use STARTTLS even if the server does not advertise support for it."},"connectionTimeout":{"type":"integer","minimum":0,"default":10000,"description":"How many milliseconds to wait for the connection to establish."},"greetingTimeout":{"type":"integer","minimum":0,"default":5000,"description":"How many milliseconds to wait for the greeting after connection is established."},"socketTimeout":{"type":"integer","minimum":0,"default":5000,"description":"How many milliseconds of inactivity to allow."},"user":{"type":"string","description":"User name."},"pass":{"type":"string","description":"User password."},"logger":{"type":"boolean","default":false,"description":"If set to true then logs to console. If value is not set or is false then nothing is logged."},"debug":{"type":"boolean","default":false,"description":"If set to true, then logs SMTP traffic, otherwise logs only transaction events."},"customAuthMethod":{"type":"string","description":"Custom authentication method (NTLM)"},"type":{"type":"string","description":"SMTP or Mandrill"},"apiKey":{"type":"string","description":"Mandrill API Key"},"workstation":{"type":"string","description":"NTLM workstation"},"domain":{"type":"string","description":"NTML domain"},"senderName":{"type":"string","description":"Name of sender."},"senderEmail":{"type":"string","description":"Email of sender."}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]},"delete":{"operationId":"deleteEmailServer","summary":"Delete email server settings","description":"The **email server settings** used for Email Server settings managing.\n","tags":["settings"],"responses":{"204":{"description":"Delete operation was successfull"},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]}},"/settings/public_settings":{"x-swagger-router-controller":"settings.publicSettings.controller.v1","x-permission-type":"none","get":{"x-skip-auth":true,"operationId":"getPublicSettings","summary":"Return public configuration settings","description":"The **Public Configuration** used for getting public system settings.\n","tags":["settings"],"responses":{"200":{"description":"Public system configuration settings.","schema":{"type":"object","required":["firstday"],"properties":{"firstday":{"type":"string","description":"Name of the first day of week"},"language":{"type":"string","description":"Language for localization"}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]}},"/settings/sso":{"x-swagger-router-controller":"settings.sso.controller.v1","x-permission-type":"admins-only","x-roles-allowed":"tenantAdmin,admin","get":{"operationId":"getSsoSettings","summary":"Returns sso settings.","description":"The **sso settings** used for single sign on configuration.","tags":["settings"],"responses":{"200":{"description":"SSO configuration settings.","schema":{"additionalProperties":false,"type":"object","properties":{"enabled":{"type":"boolean","description":"If SSO is enabled."},"ssoType":{"type":"string","description":"Type of SSO.","default":"jwt"},"userCreationDisabled":{"type":"boolean","description":"This property enable/disable the automatic creation of users through SSO.","default":false},"nonSsoUsersCanChangePassword":{"type":"boolean","description":"This property enable/disable the ability for non-Admins non-SSO users to change their password.","default":false},"nonSsoUsersCanChangePasswordFeatureToggle":{"type":"boolean","description":"This property enable/disable the visibility of nonSsoUsersCanChangePassword on the admin page","default":false},"loginUrl":{"type":"string","description":"This is the URL that Sisense will invoke to attempt remote JWT authentication."},"logoutUrl":{"type":"string","description":"This is the URL that Sisense will return users to after they log out in case of JWT."},"sharedSecret":{"type":"string","description":"Used in the token generation script."},"loginUrlSaml":{"type":"string","description":"This is the URL that Sisense will invoke to attempt remote authentication via SAML."},"logoutUrlSaml":{"type":"string","description":"This is the URL that Sisense will return users to after they log out via SAML."},"idPCert":{"type":"string","description":"This is the certificate of identity provider."},"lowSecurityJwtSso":{"type":"boolean","description":"Allow lower level security by disabling JTI enforcement.","default":false},"emailClaim":{"type":"string","description":"Claim that will be used to retrieve the user's email from the profile object. Default claim is \"email\" for OIDC, \"sub\" for JWT and \"User.Email\" for SAML"},"firstNameClaim":{"type":"string","description":"Claim that will be used to retrieve the user's firstName from the profile object. Default claim is \"firstName\" for OIDC, \"sub for JWT and \"User.firstName\" for SAML"},"lastNameClaim":{"type":"string","description":"Claim that will be used to retrieve the user's lastName from the profile object. Default claim is \"lastName\" for OIDC, \"sub for JWT and \"User.lastName\" for SAML"},"groupClaim":{"type":"string","description":"Claim that will be used to retrieve the list of user's groups from the profile object. Default claim is \"groups\" for JWT/OIDC and \"memberOf\" for SAML"},"themeClaim":{"type":"string","description":"Claim that will be used to retrieve the theme Id of for the user profile object. Default claim is \"themeId\""},"useDefaults":{"type":"boolean","description":"SSO authentication mode (default role and groups vs group to role pairing)","default":true},"defaultRole":{"type":"string","description":"Default role for users in default mode"},"defaultGroups":{"type":"array","description":"Default groups for users in default mode","items":{"type":"string"}},"groupToRolePairing":{"type":"array","description":"Groups to roles pairing list","items":{"type":"object","properties":{"group":{"type":"string","description":"Group id"}}}},"associateWithPairs":{"type":"boolean","description":"Indicates if we need to assign to users all groups that exists in Sisense and in their profile object"},"oidc":{"type":"object","properties":{"issuer":{"type":"string","description":"The server identifier, typically the base URL of the server, using the https scheme"},"authorizationURL":{"type":"string","description":"The authorization URL used by a Relying Party when making a request for a user’s identity"},"tokenURL":{"type":"string","description":"The URL that returns access token, ID token, and refresh token"},"userInfoURL":{"type":"string","description":"The URL that returns information about the currently signed-in user"},"clientID":{"type":"string","description":"Client identifier of the Relying Party of the OpenID Provider"},"clientSecret":{"type":"string","description":"Client secret registered with the OpenID Provider"},"scope":{"type":"string","description":"Specify the scope of the requested authorization (comma-separated values, 'openid' tag are appended automatically)"},"logoutURL":{"type":"string","description":"Logout URL"}}},"saml":{"type":"object","description":"SAML configuration settings","properties":{"issuer":{"type":"string","description":"The SAML issuer identifier","default":"Sisense"},"NameIdPolicy":{"type":"string","description":"The NameID policy format for SAML assertions","default":"urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress"},"PassAuthnContext":{"type":"boolean","description":"Whether to pass authentication context in SAML requests","default":true}}}}}},"403":{"description":"User does not have permission"},"404":{"description":"Name not found","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]},"post":{"operationId":"setSsoSettings","summary":"Set sso settings.","description":"The **sso settings** used for single sign on configuration.","tags":["settings"],"responses":{"200":{"description":"SSO configuration settings.","schema":{"additionalProperties":false,"type":"object","properties":{"enabled":{"type":"boolean","description":"If SSO is enabled."},"ssoType":{"type":"string","description":"Type of SSO.","default":"jwt"},"userCreationDisabled":{"type":"boolean","description":"This property enable/disable the automatic creation of users through SSO.","default":false},"nonSsoUsersCanChangePassword":{"type":"boolean","description":"This property enable/disable the ability for non-Admins non-SSO users to change their password.","default":false},"nonSsoUsersCanChangePasswordFeatureToggle":{"type":"boolean","description":"This property enable/disable the visibility of nonSsoUsersCanChangePassword on the admin page","default":false},"loginUrl":{"type":"string","description":"This is the URL that Sisense will invoke to attempt remote JWT authentication."},"logoutUrl":{"type":"string","description":"This is the URL that Sisense will return users to after they log out in case of JWT."},"sharedSecret":{"type":"string","description":"Used in the token generation script."},"loginUrlSaml":{"type":"string","description":"This is the URL that Sisense will invoke to attempt remote authentication via SAML."},"logoutUrlSaml":{"type":"string","description":"This is the URL that Sisense will return users to after they log out via SAML."},"idPCert":{"type":"string","description":"This is the certificate of identity provider."},"lowSecurityJwtSso":{"type":"boolean","description":"Allow lower level security by disabling JTI enforcement.","default":false},"emailClaim":{"type":"string","description":"Claim that will be used to retrieve the user's email from the profile object. Default claim is \"email\" for OIDC, \"sub\" for JWT and \"User.Email\" for SAML"},"firstNameClaim":{"type":"string","description":"Claim that will be used to retrieve the user's firstName from the profile object. Default claim is \"firstName\" for OIDC, \"sub for JWT and \"User.firstName\" for SAML"},"lastNameClaim":{"type":"string","description":"Claim that will be used to retrieve the user's lastName from the profile object. Default claim is \"lastName\" for OIDC, \"sub for JWT and \"User.lastName\" for SAML"},"groupClaim":{"type":"string","description":"Claim that will be used to retrieve the list of user's groups from the profile object. Default claim is \"groups\" for JWT/OIDC and \"memberOf\" for SAML"},"themeClaim":{"type":"string","description":"Claim that will be used to retrieve the theme Id of for the user profile object. Default claim is \"themeId\""},"useDefaults":{"type":"boolean","description":"SSO authentication mode (default role and groups vs group to role pairing)","default":true},"defaultRole":{"type":"string","description":"Default role for users in default mode"},"defaultGroups":{"type":"array","description":"Default groups for users in default mode","items":{"type":"string"}},"groupToRolePairing":{"type":"array","description":"Groups to roles pairing list","items":{"type":"object","properties":{"group":{"type":"string","description":"Group id"}}}},"associateWithPairs":{"type":"boolean","description":"Indicates if we need to assign to users all groups that exists in Sisense and in their profile object"},"oidc":{"type":"object","properties":{"issuer":{"type":"string","description":"The server identifier, typically the base URL of the server, using the https scheme"},"authorizationURL":{"type":"string","description":"The authorization URL used by a Relying Party when making a request for a user’s identity"},"tokenURL":{"type":"string","description":"The URL that returns access token, ID token, and refresh token"},"userInfoURL":{"type":"string","description":"The URL that returns information about the currently signed-in user"},"clientID":{"type":"string","description":"Client identifier of the Relying Party of the OpenID Provider"},"clientSecret":{"type":"string","description":"Client secret registered with the OpenID Provider"},"scope":{"type":"string","description":"Specify the scope of the requested authorization (comma-separated values, 'openid' tag are appended automatically)"},"logoutURL":{"type":"string","description":"Logout URL"}}},"saml":{"type":"object","description":"SAML configuration settings","properties":{"issuer":{"type":"string","description":"The SAML issuer identifier","default":"Sisense"},"NameIdPolicy":{"type":"string","description":"The NameID policy format for SAML assertions","default":"urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress"},"PassAuthnContext":{"type":"boolean","description":"Whether to pass authentication context in SAML requests","default":true}}}}}},"400":{"description":"Invalid input","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"Object with the sso settings.","name":"sso","required":true,"schema":{"additionalProperties":false,"type":"object","properties":{"enabled":{"type":"boolean","description":"If SSO is enabled."},"ssoType":{"type":"string","description":"Type of SSO.","default":"jwt"},"userCreationDisabled":{"type":"boolean","description":"This property enable/disable the automatic creation of users through SSO.","default":false},"nonSsoUsersCanChangePassword":{"type":"boolean","description":"This property enable/disable the ability for non-Admins non-SSO users to change their password.","default":false},"nonSsoUsersCanChangePasswordFeatureToggle":{"type":"boolean","description":"This property enable/disable the visibility of nonSsoUsersCanChangePassword on the admin page","default":false},"loginUrl":{"type":"string","description":"This is the URL that Sisense will invoke to attempt remote JWT authentication."},"logoutUrl":{"type":"string","description":"This is the URL that Sisense will return users to after they log out in case of JWT."},"sharedSecret":{"type":"string","description":"Used in the token generation script."},"loginUrlSaml":{"type":"string","description":"This is the URL that Sisense will invoke to attempt remote authentication via SAML."},"logoutUrlSaml":{"type":"string","description":"This is the URL that Sisense will return users to after they log out via SAML."},"idPCert":{"type":"string","description":"This is the certificate of identity provider."},"lowSecurityJwtSso":{"type":"boolean","description":"Allow lower level security by disabling JTI enforcement.","default":false},"emailClaim":{"type":"string","description":"Claim that will be used to retrieve the user's email from the profile object. Default claim is \"email\" for OIDC, \"sub\" for JWT and \"User.Email\" for SAML"},"firstNameClaim":{"type":"string","description":"Claim that will be used to retrieve the user's firstName from the profile object. Default claim is \"firstName\" for OIDC, \"sub for JWT and \"User.firstName\" for SAML"},"lastNameClaim":{"type":"string","description":"Claim that will be used to retrieve the user's lastName from the profile object. Default claim is \"lastName\" for OIDC, \"sub for JWT and \"User.lastName\" for SAML"},"groupClaim":{"type":"string","description":"Claim that will be used to retrieve the list of user's groups from the profile object. Default claim is \"groups\" for JWT/OIDC and \"memberOf\" for SAML"},"themeClaim":{"type":"string","description":"Claim that will be used to retrieve the theme Id of for the user profile object. Default claim is \"themeId\""},"useDefaults":{"type":"boolean","description":"SSO authentication mode (default role and groups vs group to role pairing)","default":true},"defaultRole":{"type":"string","description":"Default role for users in default mode"},"defaultGroups":{"type":"array","description":"Default groups for users in default mode","items":{"type":"string"}},"groupToRolePairing":{"type":"array","description":"Groups to roles pairing list","items":{"type":"object","properties":{"group":{"type":"string","description":"Group id"}}}},"associateWithPairs":{"type":"boolean","description":"Indicates if we need to assign to users all groups that exists in Sisense and in their profile object"},"oidc":{"type":"object","properties":{"issuer":{"type":"string","description":"The server identifier, typically the base URL of the server, using the https scheme"},"authorizationURL":{"type":"string","description":"The authorization URL used by a Relying Party when making a request for a user’s identity"},"tokenURL":{"type":"string","description":"The URL that returns access token, ID token, and refresh token"},"userInfoURL":{"type":"string","description":"The URL that returns information about the currently signed-in user"},"clientID":{"type":"string","description":"Client identifier of the Relying Party of the OpenID Provider"},"clientSecret":{"type":"string","description":"Client secret registered with the OpenID Provider"},"scope":{"type":"string","description":"Specify the scope of the requested authorization (comma-separated values, 'openid' tag are appended automatically)"},"logoutURL":{"type":"string","description":"Logout URL"}}},"saml":{"type":"object","description":"SAML configuration settings","properties":{"issuer":{"type":"string","description":"The SAML issuer identifier","default":"Sisense"},"NameIdPolicy":{"type":"string","description":"The NameID policy format for SAML assertions","default":"urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress"},"PassAuthnContext":{"type":"boolean","description":"Whether to pass authentication context in SAML requests","default":true}}}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/settings/system":{"x-swagger-router-controller":"settings.system.controller.v1","x-permission-type":"authenticate","get":{"operationId":"getSystemSettings","summary":"Returns system configuration settings.","description":"The **system settings** used for system settings configuration.\n","tags":["settings"],"responses":{"200":{"description":"System configuration settings.","schema":{"type":"object","properties":{"_id":{"type":"string","description":"ID of config."},"alias":{"type":"string","description":"Web server public address."},"firstday":{"type":"string","description":"First day of the week for date related ElastiCube queries."},"usage":{"type":"object","description":"Usage Analytics feature properties block.","properties":{"enabled":{"type":"boolean","description":"Usage Analytics feature status."},"restoreDashboards":{"type":"boolean","description":"On Usage Analytics feature enabling, system should restore dashboards, by default system restore dashboards on first Usage Analytics feature turn on."},"retentionPeriodDays":{"type":"number","minimum":1,"default":30,"description":"Usage analytics retention period in days"}}},"fiscal":{"type":"object","description":"Fiscal Year.","properties":{"month":{"type":"string","enum":["jan","feb","mar","apr","may","jun","jul","aug","sep","oct","nov","dec"]},"format":{"type":"string"}}},"dashboardAdministration":{"type":"object","description":"Allow admin access for all dashboards","properties":{"enabled":{"type":"boolean"}}},"displayName":{"type":"object","description":"Enable assigning table/column Display Name to be used in Analytics interface. Using Display Name enables renaming tables/columns in data models without disrupting their dependent dashboards and widgets.","properties":{"enabled":{"type":"boolean"},"useNewSearchByDisplayNameApi":{"type":"boolean"}}},"dashboardCoAuthoring":{"type":"object","description":"Allow multiple users or groups to co-own dashboards","properties":{"enabled":{"type":"boolean"},"inactivityLockTimeoutMinutes":{"type":"number","minimum":60,"maximum":525600,"default":240,"description":"Number of minutes of inactivity before a co-authored dashboard lock is automatically released. Minimum 60 (1 hour), Maximum 525600 (1 year)."}}},"sharedFormulas":{"type":"object","description":"Shared Formulas feature properties block.","properties":{"enabled":{"type":"boolean","description":"Shared Formulas feature status."}}},"dataExplore":{"type":"object","description":"Data Explore feature status","properties":{"enabled":{"type":"boolean"}}},"email":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If mails are enabled.","default":true},"senderEmail":{"type":"string","description":"Email of sender."},"senderName":{"type":"string","description":"Name of sender."},"typesOfEmails":{"type":"object","properties":{"aDGroupInvitationEmailEnabled":{"type":"boolean","description":"AD group invitation email toggle. Sent when the user is added to the AD group.","default":true},"accountActivationEmailEnabled":{"type":"boolean","description":"If enabled Sisense will send a new user invitation to the new user.","default":true},"buildAlertCommonEmailEnabled":{"type":"boolean","description":"Build Alert toggle. Sent each time an alert build is triggered.","default":true},"buildFailureAlertEmailEnabled":{"type":"boolean","description":"Build Failure Alert toggle. Sent each time a failed alert build is triggered.","default":true},"buildSuccessAlertEmailEnabled":{"type":"boolean","description":"Build Success Alert toggle. Sent each time a successful alert build is triggered.","default":true},"changeDashboardOwnershipEmailEnabled":{"type":"boolean","description":"Transfer Ownership toggle. Sent to a user who received ownership of a dashboard from another user.","default":true},"dashboardErrorReportBulkFailEmailEnabled":{"type":"boolean","description":"Dashboard Errors Reports toggle. Sent when a dashboard report fails.","default":true},"dashboardErrorReportEmailEnabled":{"type":"boolean","description":"Dashboard Errors Reports toggle. Sent when a dashboard report fails.","default":true},"dashboardReportEmailEnabled":{"type":"boolean","description":"Dashboard Reports toggle. Dashboard scheduled email reports sent when enabled.","default":true},"kpiAlertEmailEnabled":{"type":"boolean","description":"KPI Alert toggle. Sent each time a KPI alert is triggered.","default":true},"newUserInvitationEmailEnabled":{"type":"boolean","description":"New User Invitation toggle. Sent to a new user invited to Sisense.","default":true},"newUserResendInvitationEmailEnabled":{"type":"boolean","description":"New User Invitation resend toggle. Resend to a new user invited to Sisense.","default":true},"resendInvitationEmailEnabled":{"type":"boolean","description":"Password Recovery toggle. Sent to a user who requested a new password.","default":true},"shareDashboardWithGroupEmailEnabled":{"type":"boolean","description":"Share dashboard with a group toggle. Sent an email to the group users.","default":true},"shareDashboardWithNewUserEmailEnabled":{"type":"boolean","description":"Share dashboard with a newly created user toggle.","default":true},"shareDashboardWithUserEmailEnabled":{"type":"boolean","description":"Share dashboard with existing user toggle. Sent to the recipient of a shared dashboard.","default":true},"shareElasticubeEmailEnabled":{"type":"boolean","description":"Share ElastiCube toggle. Sent to the recipient of a newly shared ElastiCube.","default":true},"userCreatedADEmailEnabled":{"type":"boolean","description":"User Created AD toggle. Sent when a user is created in Sisense after being added from Active Directory.","default":true},"userCreatedEmailEnabled":{"type":"boolean","description":"User Created toggle. Sent to a user when a user is created.","default":true}}}}},"webServer":{"type":"object","properties":{"enableSSl":{"type":"boolean","description":"If SSL is enabled."},"cors":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If cors settings is enabled."},"allowedOrigins":{"type":"array","items":{"type":"string"}}}}}},"authentication":{"type":"object","properties":{"domainGroupLogin":{"type":"boolean"},"apiTokenExpiration":{"type":"boolean"}}},"fileManagement":{"description":"Switches the ability to use the file server from the system management","type":"object","properties":{"enabled":{"type":"boolean"}}},"inviteNewUsersOnShare":{"description":"Switches the ability to invite (create) new non-sisense users while sharing a specific dashboard","type":"object","properties":{"enabled":{"type":"boolean"}}},"userActivationLinkExpiration":{"type":"number","minimum":1,"maximum":365,"default":7,"description":"User activation link expiration (days)."},"support":{"description":"Support access control","type":"object","properties":{"enabled":{"type":"boolean","description":"When \"true\", Sisense Support personnel can access your account\n"},"enabledUntil":{"type":"string","description":"Support access is enabled until this date and time, and disabled afterwards.\n"},"duration":{"type":"string","description":"Duration of time support user is turned on for.\n"}}},"newAdminUI":{"type":"object","description":"Set of feature toggles that allows to switch between the new Admin UI and the legacy one.","properties":{"enableNewAdminUI":{"type":"boolean","description":"switch between new Admin UI and the legacy one","default":false},"enableNewGeneralSettingsPage":{"type":"boolean","description":"If enabled will show the new UI for the General Settings page.","default":false},"enableNewLicensePage":{"type":"boolean","description":"If enabled will show the new UI for the License Utilization page.","default":false},"enableNewFeaturesPage":{"type":"boolean","description":"If enabled will show the new UI for the Features Settings page.","default":false},"enableNewSecurityPage":{"type":"boolean","description":"If enabled will show the new UI for the Security Settings page.","default":false},"enableNewSSOPage":{"type":"boolean","description":"If enabled will show the new UI for the SSO Settings page.","default":false},"enableUpgradePage":{"type":"boolean","description":"If enabled will show the Upgrade center page.","default":true},"enableHomePage":{"type":"boolean","description":"If enabled will show the new UI for the Home page.","default":false},"enableUsersPage":{"type":"boolean","description":"If enabled will show the new UI for the Users page.","default":false},"enableNewAdminNavigation":{"type":"boolean","description":"If enabled will show the new UI for the Admin navigation.","default":false},"enableConnectorsManagementPage":{"type":"boolean","description":"If enabled will show the new Connection management page.","default":false}}},"widgets":{"type":"object","properties":{"widgetDesignStyle":{"type":"boolean"}}},"widgetQueryLimit":{"type":"object","properties":{"chart_pie":{"type":"number","default":20000},"chart_column":{"type":"number","default":20000},"chart_bar":{"type":"number","default":20000},"chart_line":{"type":"number","default":20000},"chart_area":{"type":"number","default":20000},"chart_scatter":{"type":"number","default":20000},"chart_polar":{"type":"number","default":20000},"map_scatter":{"type":"number","default":5000},"map_area":{"type":"number","default":5000},"tablewidget":{"type":"number","default":220},"chart_funnel":{"type":"number","default":50},"indicator":{"type":"number","default":50000},"treemap":{"type":"number","default":50000},"heatmap":{"type":"number","default":50000},"sunburst":{"type":"number","default":50000},"chart_boxplot":{"type":"number","default":50000}}}}}},"400":{"description":"System settings are empty","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"},"404":{"description":"Name not found","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]},"post":{"operationId":"setSystemSettings","summary":"Adds or updates system settings.","x-permission-type":"general","x-permission-path":"manage/systemconfig","description":"The **system settings** used for system settings configuration.\n","tags":["settings"],"responses":{"200":{"description":"System configuration settings.","schema":{"type":"object","properties":{"_id":{"type":"string","description":"ID of config."},"alias":{"type":"string","description":"Web server public address."},"firstday":{"type":"string","description":"First day of the week for date related ElastiCube queries."},"usage":{"type":"object","description":"Usage Analytics feature properties block.","properties":{"enabled":{"type":"boolean","description":"Usage Analytics feature status."},"restoreDashboards":{"type":"boolean","description":"On Usage Analytics feature enabling, system should restore dashboards, by default system restore dashboards on first Usage Analytics feature turn on."},"retentionPeriodDays":{"type":"number","minimum":1,"default":30,"description":"Usage analytics retention period in days"}}},"fiscal":{"type":"object","description":"Fiscal Year.","properties":{"month":{"type":"string","enum":["jan","feb","mar","apr","may","jun","jul","aug","sep","oct","nov","dec"]},"format":{"type":"string"}}},"dashboardAdministration":{"type":"object","description":"Allow admin access for all dashboards","properties":{"enabled":{"type":"boolean"}}},"displayName":{"type":"object","description":"Enable assigning table/column Display Name to be used in Analytics interface. Using Display Name enables renaming tables/columns in data models without disrupting their dependent dashboards and widgets.","properties":{"enabled":{"type":"boolean"},"useNewSearchByDisplayNameApi":{"type":"boolean"}}},"dashboardCoAuthoring":{"type":"object","description":"Allow multiple users or groups to co-own dashboards","properties":{"enabled":{"type":"boolean"},"inactivityLockTimeoutMinutes":{"type":"number","minimum":60,"maximum":525600,"default":240,"description":"Number of minutes of inactivity before a co-authored dashboard lock is automatically released. Minimum 60 (1 hour), Maximum 525600 (1 year)."}}},"sharedFormulas":{"type":"object","description":"Shared Formulas feature properties block.","properties":{"enabled":{"type":"boolean","description":"Shared Formulas feature status."}}},"dataExplore":{"type":"object","description":"Data Explore feature status","properties":{"enabled":{"type":"boolean"}}},"email":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If mails are enabled.","default":true},"senderEmail":{"type":"string","description":"Email of sender."},"senderName":{"type":"string","description":"Name of sender."},"typesOfEmails":{"type":"object","properties":{"aDGroupInvitationEmailEnabled":{"type":"boolean","description":"AD group invitation email toggle. Sent when the user is added to the AD group.","default":true},"accountActivationEmailEnabled":{"type":"boolean","description":"If enabled Sisense will send a new user invitation to the new user.","default":true},"buildAlertCommonEmailEnabled":{"type":"boolean","description":"Build Alert toggle. Sent each time an alert build is triggered.","default":true},"buildFailureAlertEmailEnabled":{"type":"boolean","description":"Build Failure Alert toggle. Sent each time a failed alert build is triggered.","default":true},"buildSuccessAlertEmailEnabled":{"type":"boolean","description":"Build Success Alert toggle. Sent each time a successful alert build is triggered.","default":true},"changeDashboardOwnershipEmailEnabled":{"type":"boolean","description":"Transfer Ownership toggle. Sent to a user who received ownership of a dashboard from another user.","default":true},"dashboardErrorReportBulkFailEmailEnabled":{"type":"boolean","description":"Dashboard Errors Reports toggle. Sent when a dashboard report fails.","default":true},"dashboardErrorReportEmailEnabled":{"type":"boolean","description":"Dashboard Errors Reports toggle. Sent when a dashboard report fails.","default":true},"dashboardReportEmailEnabled":{"type":"boolean","description":"Dashboard Reports toggle. Dashboard scheduled email reports sent when enabled.","default":true},"kpiAlertEmailEnabled":{"type":"boolean","description":"KPI Alert toggle. Sent each time a KPI alert is triggered.","default":true},"newUserInvitationEmailEnabled":{"type":"boolean","description":"New User Invitation toggle. Sent to a new user invited to Sisense.","default":true},"newUserResendInvitationEmailEnabled":{"type":"boolean","description":"New User Invitation resend toggle. Resend to a new user invited to Sisense.","default":true},"resendInvitationEmailEnabled":{"type":"boolean","description":"Password Recovery toggle. Sent to a user who requested a new password.","default":true},"shareDashboardWithGroupEmailEnabled":{"type":"boolean","description":"Share dashboard with a group toggle. Sent an email to the group users.","default":true},"shareDashboardWithNewUserEmailEnabled":{"type":"boolean","description":"Share dashboard with a newly created user toggle.","default":true},"shareDashboardWithUserEmailEnabled":{"type":"boolean","description":"Share dashboard with existing user toggle. Sent to the recipient of a shared dashboard.","default":true},"shareElasticubeEmailEnabled":{"type":"boolean","description":"Share ElastiCube toggle. Sent to the recipient of a newly shared ElastiCube.","default":true},"userCreatedADEmailEnabled":{"type":"boolean","description":"User Created AD toggle. Sent when a user is created in Sisense after being added from Active Directory.","default":true},"userCreatedEmailEnabled":{"type":"boolean","description":"User Created toggle. Sent to a user when a user is created.","default":true}}}}},"webServer":{"type":"object","properties":{"enableSSl":{"type":"boolean","description":"If SSL is enabled."},"cors":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If cors settings is enabled."},"allowedOrigins":{"type":"array","items":{"type":"string"}}}}}},"authentication":{"type":"object","properties":{"domainGroupLogin":{"type":"boolean"},"apiTokenExpiration":{"type":"boolean"}}},"fileManagement":{"description":"Switches the ability to use the file server from the system management","type":"object","properties":{"enabled":{"type":"boolean"}}},"inviteNewUsersOnShare":{"description":"Switches the ability to invite (create) new non-sisense users while sharing a specific dashboard","type":"object","properties":{"enabled":{"type":"boolean"}}},"userActivationLinkExpiration":{"type":"number","minimum":1,"maximum":365,"default":7,"description":"User activation link expiration (days)."},"support":{"description":"Support access control","type":"object","properties":{"enabled":{"type":"boolean","description":"When \"true\", Sisense Support personnel can access your account\n"},"enabledUntil":{"type":"string","description":"Support access is enabled until this date and time, and disabled afterwards.\n"},"duration":{"type":"string","description":"Duration of time support user is turned on for.\n"}}},"newAdminUI":{"type":"object","description":"Set of feature toggles that allows to switch between the new Admin UI and the legacy one.","properties":{"enableNewAdminUI":{"type":"boolean","description":"switch between new Admin UI and the legacy one","default":false},"enableNewGeneralSettingsPage":{"type":"boolean","description":"If enabled will show the new UI for the General Settings page.","default":false},"enableNewLicensePage":{"type":"boolean","description":"If enabled will show the new UI for the License Utilization page.","default":false},"enableNewFeaturesPage":{"type":"boolean","description":"If enabled will show the new UI for the Features Settings page.","default":false},"enableNewSecurityPage":{"type":"boolean","description":"If enabled will show the new UI for the Security Settings page.","default":false},"enableNewSSOPage":{"type":"boolean","description":"If enabled will show the new UI for the SSO Settings page.","default":false},"enableUpgradePage":{"type":"boolean","description":"If enabled will show the Upgrade center page.","default":true},"enableHomePage":{"type":"boolean","description":"If enabled will show the new UI for the Home page.","default":false},"enableUsersPage":{"type":"boolean","description":"If enabled will show the new UI for the Users page.","default":false},"enableNewAdminNavigation":{"type":"boolean","description":"If enabled will show the new UI for the Admin navigation.","default":false},"enableConnectorsManagementPage":{"type":"boolean","description":"If enabled will show the new Connection management page.","default":false}}},"widgets":{"type":"object","properties":{"widgetDesignStyle":{"type":"boolean"}}},"widgetQueryLimit":{"type":"object","properties":{"chart_pie":{"type":"number","default":20000},"chart_column":{"type":"number","default":20000},"chart_bar":{"type":"number","default":20000},"chart_line":{"type":"number","default":20000},"chart_area":{"type":"number","default":20000},"chart_scatter":{"type":"number","default":20000},"chart_polar":{"type":"number","default":20000},"map_scatter":{"type":"number","default":5000},"map_area":{"type":"number","default":5000},"tablewidget":{"type":"number","default":220},"chart_funnel":{"type":"number","default":50},"indicator":{"type":"number","default":50000},"treemap":{"type":"number","default":50000},"heatmap":{"type":"number","default":50000},"sunburst":{"type":"number","default":50000},"chart_boxplot":{"type":"number","default":50000}}}}}},"400":{"description":"Invalid input","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"Object with the system settings.","name":"system","required":true,"schema":{"type":"object","properties":{"_id":{"type":"string","description":"ID of config."},"alias":{"type":"string","description":"Web server public address."},"firstday":{"type":"string","description":"First day of the week for date related ElastiCube queries."},"usage":{"type":"object","description":"Usage Analytics feature properties block.","properties":{"enabled":{"type":"boolean","description":"Usage Analytics feature status."},"restoreDashboards":{"type":"boolean","description":"On Usage Analytics feature enabling, system should restore dashboards, by default system restore dashboards on first Usage Analytics feature turn on."},"retentionPeriodDays":{"type":"number","minimum":1,"default":30,"description":"Usage analytics retention period in days"}}},"fiscal":{"type":"object","description":"Fiscal Year.","properties":{"month":{"type":"string","enum":["jan","feb","mar","apr","may","jun","jul","aug","sep","oct","nov","dec"]},"format":{"type":"string"}}},"dashboardAdministration":{"type":"object","description":"Allow admin access for all dashboards","properties":{"enabled":{"type":"boolean"}}},"displayName":{"type":"object","description":"Enable assigning table/column Display Name to be used in Analytics interface. Using Display Name enables renaming tables/columns in data models without disrupting their dependent dashboards and widgets.","properties":{"enabled":{"type":"boolean"},"useNewSearchByDisplayNameApi":{"type":"boolean"}}},"dashboardCoAuthoring":{"type":"object","description":"Allow multiple users or groups to co-own dashboards","properties":{"enabled":{"type":"boolean"},"inactivityLockTimeoutMinutes":{"type":"number","minimum":60,"maximum":525600,"default":240,"description":"Number of minutes of inactivity before a co-authored dashboard lock is automatically released. Minimum 60 (1 hour), Maximum 525600 (1 year)."}}},"sharedFormulas":{"type":"object","description":"Shared Formulas feature properties block.","properties":{"enabled":{"type":"boolean","description":"Shared Formulas feature status."}}},"dataExplore":{"type":"object","description":"Data Explore feature status","properties":{"enabled":{"type":"boolean"}}},"email":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If mails are enabled.","default":true},"senderEmail":{"type":"string","description":"Email of sender."},"senderName":{"type":"string","description":"Name of sender."},"typesOfEmails":{"type":"object","properties":{"aDGroupInvitationEmailEnabled":{"type":"boolean","description":"AD group invitation email toggle. Sent when the user is added to the AD group.","default":true},"accountActivationEmailEnabled":{"type":"boolean","description":"If enabled Sisense will send a new user invitation to the new user.","default":true},"buildAlertCommonEmailEnabled":{"type":"boolean","description":"Build Alert toggle. Sent each time an alert build is triggered.","default":true},"buildFailureAlertEmailEnabled":{"type":"boolean","description":"Build Failure Alert toggle. Sent each time a failed alert build is triggered.","default":true},"buildSuccessAlertEmailEnabled":{"type":"boolean","description":"Build Success Alert toggle. Sent each time a successful alert build is triggered.","default":true},"changeDashboardOwnershipEmailEnabled":{"type":"boolean","description":"Transfer Ownership toggle. Sent to a user who received ownership of a dashboard from another user.","default":true},"dashboardErrorReportBulkFailEmailEnabled":{"type":"boolean","description":"Dashboard Errors Reports toggle. Sent when a dashboard report fails.","default":true},"dashboardErrorReportEmailEnabled":{"type":"boolean","description":"Dashboard Errors Reports toggle. Sent when a dashboard report fails.","default":true},"dashboardReportEmailEnabled":{"type":"boolean","description":"Dashboard Reports toggle. Dashboard scheduled email reports sent when enabled.","default":true},"kpiAlertEmailEnabled":{"type":"boolean","description":"KPI Alert toggle. Sent each time a KPI alert is triggered.","default":true},"newUserInvitationEmailEnabled":{"type":"boolean","description":"New User Invitation toggle. Sent to a new user invited to Sisense.","default":true},"newUserResendInvitationEmailEnabled":{"type":"boolean","description":"New User Invitation resend toggle. Resend to a new user invited to Sisense.","default":true},"resendInvitationEmailEnabled":{"type":"boolean","description":"Password Recovery toggle. Sent to a user who requested a new password.","default":true},"shareDashboardWithGroupEmailEnabled":{"type":"boolean","description":"Share dashboard with a group toggle. Sent an email to the group users.","default":true},"shareDashboardWithNewUserEmailEnabled":{"type":"boolean","description":"Share dashboard with a newly created user toggle.","default":true},"shareDashboardWithUserEmailEnabled":{"type":"boolean","description":"Share dashboard with existing user toggle. Sent to the recipient of a shared dashboard.","default":true},"shareElasticubeEmailEnabled":{"type":"boolean","description":"Share ElastiCube toggle. Sent to the recipient of a newly shared ElastiCube.","default":true},"userCreatedADEmailEnabled":{"type":"boolean","description":"User Created AD toggle. Sent when a user is created in Sisense after being added from Active Directory.","default":true},"userCreatedEmailEnabled":{"type":"boolean","description":"User Created toggle. Sent to a user when a user is created.","default":true}}}}},"webServer":{"type":"object","properties":{"enableSSl":{"type":"boolean","description":"If SSL is enabled."},"cors":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If cors settings is enabled."},"allowedOrigins":{"type":"array","items":{"type":"string"}}}}}},"authentication":{"type":"object","properties":{"domainGroupLogin":{"type":"boolean"},"apiTokenExpiration":{"type":"boolean"}}},"fileManagement":{"description":"Switches the ability to use the file server from the system management","type":"object","properties":{"enabled":{"type":"boolean"}}},"inviteNewUsersOnShare":{"description":"Switches the ability to invite (create) new non-sisense users while sharing a specific dashboard","type":"object","properties":{"enabled":{"type":"boolean"}}},"userActivationLinkExpiration":{"type":"number","minimum":1,"maximum":365,"default":7,"description":"User activation link expiration (days)."},"support":{"description":"Support access control","type":"object","properties":{"enabled":{"type":"boolean","description":"When \"true\", Sisense Support personnel can access your account\n"},"enabledUntil":{"type":"string","description":"Support access is enabled until this date and time, and disabled afterwards.\n"},"duration":{"type":"string","description":"Duration of time support user is turned on for.\n"}}},"newAdminUI":{"type":"object","description":"Set of feature toggles that allows to switch between the new Admin UI and the legacy one.","properties":{"enableNewAdminUI":{"type":"boolean","description":"switch between new Admin UI and the legacy one","default":false},"enableNewGeneralSettingsPage":{"type":"boolean","description":"If enabled will show the new UI for the General Settings page.","default":false},"enableNewLicensePage":{"type":"boolean","description":"If enabled will show the new UI for the License Utilization page.","default":false},"enableNewFeaturesPage":{"type":"boolean","description":"If enabled will show the new UI for the Features Settings page.","default":false},"enableNewSecurityPage":{"type":"boolean","description":"If enabled will show the new UI for the Security Settings page.","default":false},"enableNewSSOPage":{"type":"boolean","description":"If enabled will show the new UI for the SSO Settings page.","default":false},"enableUpgradePage":{"type":"boolean","description":"If enabled will show the Upgrade center page.","default":true},"enableHomePage":{"type":"boolean","description":"If enabled will show the new UI for the Home page.","default":false},"enableUsersPage":{"type":"boolean","description":"If enabled will show the new UI for the Users page.","default":false},"enableNewAdminNavigation":{"type":"boolean","description":"If enabled will show the new UI for the Admin navigation.","default":false},"enableConnectorsManagementPage":{"type":"boolean","description":"If enabled will show the new Connection management page.","default":false}}},"widgets":{"type":"object","properties":{"widgetDesignStyle":{"type":"boolean"}}},"widgetQueryLimit":{"type":"object","properties":{"chart_pie":{"type":"number","default":20000},"chart_column":{"type":"number","default":20000},"chart_bar":{"type":"number","default":20000},"chart_line":{"type":"number","default":20000},"chart_area":{"type":"number","default":20000},"chart_scatter":{"type":"number","default":20000},"chart_polar":{"type":"number","default":20000},"map_scatter":{"type":"number","default":5000},"map_area":{"type":"number","default":5000},"tablewidget":{"type":"number","default":220},"chart_funnel":{"type":"number","default":50},"indicator":{"type":"number","default":50000},"treemap":{"type":"number","default":50000},"heatmap":{"type":"number","default":50000},"sunburst":{"type":"number","default":50000},"chart_boxplot":{"type":"number","default":50000}}}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/settings/globalization":{"x-swagger-router-controller":"settings.globalization.controller.v1","get":{"x-permission-type":"none","operationId":"getGlobalization","summary":"Returns globalization settings","description":"Returns locale settings, including the set locale, and whether autodetect is enabled.","tags":["settings"],"responses":{"200":{"description":"Globalization settings.","schema":{"type":"object","properties":{"language":{"type":"string","description":"Default language for localization."},"localization":{"type":"object","properties":{"default":{"type":"string","description":"Default locale for localization."},"autoDetectEnabled":{"type":"boolean","description":"If language autodetect is enabled."}}}}}},"403":{"description":"User does not have permission"},"404":{"description":"Not configured yet","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]},"post":{"x-permission-type":"admins-only","operationId":"add","summary":"Add globalization settings","description":"You can change the locale or select whether the localization selection is automatically detected or not.","tags":["settings"],"responses":{"200":{"description":"Globalization settings.","schema":{"type":"object","properties":{"language":{"type":"string","description":"Default language for localization."},"localization":{"type":"object","properties":{"default":{"type":"string","description":"Default locale for localization."},"autoDetectEnabled":{"type":"boolean","description":"If language autodetect is enabled."}}}}}},"400":{"description":"Invalid input","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"Object with the globalization settings.","name":"globalization","required":true,"schema":{"type":"object","properties":{"language":{"type":"string","description":"Default language for localization."},"localization":{"type":"object","properties":{"default":{"type":"string","description":"Default locale for localization."},"autoDetectEnabled":{"type":"boolean","description":"If language autodetect is enabled."}}}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]},"put":{"x-permission-type":"admins-only","operationId":"update","summary":"Update globalization settings","description":"You can update the locale or select whether the localization selection is automatically detected or not.","tags":["settings"],"responses":{"200":{"description":"Globalization settings.","schema":{"type":"object","properties":{"language":{"type":"string","description":"Default language for localization."},"localization":{"type":"object","properties":{"default":{"type":"string","description":"Default locale for localization."},"autoDetectEnabled":{"type":"boolean","description":"If language autodetect is enabled."}}}}}},"400":{"description":"Invalid input","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"Object with the globalization settings.","name":"globalization","required":true,"schema":{"type":"object","properties":{"language":{"type":"string","description":"Default language for localization."},"localization":{"type":"object","properties":{"default":{"type":"string","description":"Default locale for localization."},"autoDetectEnabled":{"type":"boolean","description":"If language autodetect is enabled."}}}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]},"delete":{"x-permission-type":"admins-only","operationId":"removeGlobalization","summary":"Delete globalization settings","description":"Deletes globalization settings in your server.","tags":["settings"],"responses":{"204":{"description":"Delete operation was successfull"},"400":{"description":"Invalid input","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"},"404":{"description":"Not configured yet","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/settings/pulse":{"x-swagger-router-controller":"settings.pulse.controller.v1","x-permission-type":"none","get":{"operationId":"getPulseSettings","summary":"Returns pulse settings.","description":"The **pulse settings** used for store pulse page configuration.","tags":["settings"],"responses":{"200":{"description":"Pulse configuration settings.","schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of configuration.","default":"pulse"},"script":{"type":"string","description":"Pulse page extension script.","default":""}}}},"403":{"description":"User does not have permission"},"404":{"description":"Name not found.","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]},"post":{"x-permission-type":"admins-only","operationId":"setPulseSettings","summary":"Set pulse settings.","description":"The **pulse settings** used for store pulse page configuration.","tags":["settings"],"responses":{"200":{"description":"Pulse configuration settings.","schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of configuration.","default":"pulse"},"script":{"type":"string","description":"Pulse page extension script.","default":""}}}},"400":{"description":"Invalid input.","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"Object with the pulse settings.","name":"pulse","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of configuration.","default":"pulse"},"script":{"type":"string","description":"Pulse page extension script.","default":""}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]},"patch":{"x-permission-type":"admins-only","operationId":"patch","summary":"Patch pulse settings.","description":"The **pulse settings** used for store pulse page configuration.","tags":["settings"],"responses":{"200":{"description":"Pulse configuration settings.","schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of configuration.","default":"pulse"},"script":{"type":"string","description":"Pulse page extension script.","default":""}}}},"400":{"description":"Invalid input.","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"Object with the pulse settings.","name":"pulse","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of configuration.","default":"pulse"},"script":{"type":"string","description":"Pulse page extension script.","default":""}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]},"delete":{"x-permission-type":"admins-only","operationId":"removePulseSettings","summary":"Delete pulse settings.","description":"The **pulse settings** used for store pulse page configuration.","tags":["settings"],"responses":{"204":{"description":"Delete operation was successfull."},"400":{"description":"Invalid input.","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/settings/pivot":{"x-swagger-router-controller":"settings.pivot.controller.v1","get":{"x-permission-type":"none","operationId":"getPivotSettings","summary":"Returns pivot settings.","description":"The **pivot settings** used for store pivot configuration.","tags":["settings"],"responses":{"200":{"description":"Pivot configuration settings.","schema":{"type":"object","properties":{"limit":{"type":"integer","description":"Limit of the number of records at the query level.","default":10000,"minimum":0},"columnsLimit":{"type":"integer","description":"Max columns count in pivot.","default":70,"minimum":1},"allowHtml":{"type":"boolean","description":"Allow render html in pivot2 cells","default":false},"distinctTotals":{"type":"object","properties":{"default":{"type":"object","properties":{"value":{"type":"boolean","description":"Allow Distinct Totals by default.","default":false}}},"perMeasure":{"type":"object","properties":{"value":{"type":"boolean","description":"Allow to change Distinct Totals manually on each pivot.","default":false}}}}}}}},"403":{"description":"User does not have permission"},"404":{"description":"Name not found.","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]},"patch":{"x-permission-type":"admins-only","operationId":"patchPivotSettings","summary":"Patch pivot settings.","description":"The **pivot settings** used for store pivot configuration.","tags":["settings"],"responses":{"200":{"description":"Pivot configuration settings.","schema":{"type":"object","properties":{"limit":{"type":"integer","description":"Limit of the number of records at the query level.","default":10000,"minimum":0},"columnsLimit":{"type":"integer","description":"Max columns count in pivot.","default":70,"minimum":1},"allowHtml":{"type":"boolean","description":"Allow render html in pivot2 cells","default":false},"distinctTotals":{"type":"object","properties":{"default":{"type":"object","properties":{"value":{"type":"boolean","description":"Allow Distinct Totals by default.","default":false}}},"perMeasure":{"type":"object","properties":{"value":{"type":"boolean","description":"Allow to change Distinct Totals manually on each pivot.","default":false}}}}}}}},"400":{"description":"Invalid input.","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"Object with the pivot settings.","name":"pivot","required":true,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"Limit of the number of records at the query level.","default":10000,"minimum":0},"columnsLimit":{"type":"integer","description":"Max columns count in pivot.","default":70,"minimum":1},"allowHtml":{"type":"boolean","description":"Allow render html in pivot2 cells","default":false},"distinctTotals":{"type":"object","properties":{"default":{"type":"object","properties":{"value":{"type":"boolean","description":"Allow Distinct Totals by default.","default":false}}},"perMeasure":{"type":"object","properties":{"value":{"type":"boolean","description":"Allow to change Distinct Totals manually on each pivot.","default":false}}}}}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/translations/{lang}":{"x-swagger-router-controller":"translation.controller.v1","x-permission-type":"none","get":{"x-skip-auth":true,"x-middleware":["sanitizePathInQuery"],"operationId":"getLang","summary":"Return a language file","description":"The **get translations/lang** endpoint returns a language file.","tags":["translations"],"produces":["application/json"],"responses":{"200":{"description":"lang file","schema":{"type":"string"}},"403":{"description":"User does not have permission"},"404":{"description":"Language not found","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"The name of the language to be returned.","name":"lang","required":true,"type":"string"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/translations/intl/{lang}":{"x-swagger-router-controller":"translation.controller.v1","x-permission-type":"none","get":{"x-skip-auth":true,"x-middleware":["sanitizePathInQuery"],"operationId":"getIntlLang","summary":"Return a language file","description":"The **get translations/lang** endpoint returns a language file for Sisense shared components.","tags":["translations"],"produces":["application/json"],"responses":{"200":{"description":"lang file","schema":{"type":"string"}},"403":{"description":"User does not have permission"},"404":{"description":"Language not found","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"The name of the language to be returned.","name":"lang","required":true,"type":"string"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/translations":{"x-swagger-router-controller":"translation.controller.v1","x-permission-type":"none","get":{"operationId":"getAllLangs","summary":"Return all supported languages","description":"The **get translations** endpoint returns a list of all your supported languages in Sisense.","tags":["translations"],"responses":{"200":{"description":"all lang file","schema":{"type":"string"}},"403":{"description":"User does not have permission"},"404":{"description":"Language not found","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/settings/login_lockout":{"x-swagger-router-controller":"settings.loginLockout.controller.v1","x-permission-type":"admins-only","get":{"operationId":"get","summary":"Returns Login Lockout settings.","description":"Get current settings for user lockout on failed login attempts\n","tags":["settings"],"responses":{"200":{"description":"Login Lockout configuration settings.","schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is login lockout enabled"},"maxFailedAttempts":{"type":"number","description":"Number of failed attempts to cause lockout"},"failedAttemptsPeriod":{"type":"number","description":"Time period for counting failed attempts (in minutes)"},"lockoutPeriod":{"type":"number","description":"Time period user will be locked out for (in minutes)"}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]},"patch":{"operationId":"patch","x-middleware":["validateLoginLockoutConfig"],"summary":"Updates Login Lockout settings.","description":"Update settings for user lockout on failed login attempts\n","tags":["settings"],"responses":{"200":{"description":"Login Lockout settings.","schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is login lockout enabled"},"maxFailedAttempts":{"type":"number","description":"Number of failed attempts to cause lockout"},"failedAttemptsPeriod":{"type":"number","description":"Time period for counting failed attempts (in minutes)"},"lockoutPeriod":{"type":"number","description":"Time period user will be locked out for (in minutes)"}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"Object with the Login Lockout settings.","name":"loginLockoutSettings","required":true,"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is login lockout enabled"},"maxFailedAttempts":{"type":"number","description":"Number of failed attempts to cause lockout"},"failedAttemptsPeriod":{"type":"number","description":"Time period for counting failed attempts (in minutes)"},"lockoutPeriod":{"type":"number","description":"Time period user will be locked out for (in minutes)"}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/settings/two_factor_auth":{"x-swagger-router-controller":"settings.twoFactorAuth.controller.v1","x-permission-type":"admins-only","get":{"operationId":"get","summary":"Returns Two Factor Authentication settings.","description":"Get current settings for two-factor authentication\n","tags":["settings"],"responses":{"200":{"description":"Two Factor Authentication configuration settings.","schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is two-factor authentication enabled"},"maxAttempts":{"type":"number","description":"Maximum number of 2FA code verification attempts allowed"}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]},"patch":{"operationId":"patch","x-middleware":["validateTwoFactorAuthConfig"],"summary":"Updates Two Factor Authentication settings.","description":"Update settings for two-factor authentication\n","tags":["settings"],"responses":{"200":{"description":"Two Factor Authentication settings.","schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is two-factor authentication enabled"},"maxAttempts":{"type":"number","description":"Maximum number of 2FA code verification attempts allowed"}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"Object with the Two Factor Authentication settings.","name":"twoFactorAuthSettings","required":true,"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is two-factor authentication enabled"},"maxAttempts":{"type":"number","description":"Maximum number of 2FA code verification attempts allowed"}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/settings/infusion":{"x-swagger-router-controller":"settings.infusion.controller.v1","x-permission-type":"admins-only","get":{"operationId":"getInfusionSettings","summary":"Returns infusion settings.","description":"The **infusion settings** used for store infusion page configuration.","tags":["settings"],"responses":{"200":{"description":"Infusion configuration settings.","schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Turns infusion service on or off","default":false},"slack":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is Slack app integration available","default":false},"clientId":{"type":"string","description":"Client ID for Slack app configuration"},"clientSecret":{"type":"string","description":"Client Secret for Slack app configuration"},"signingSecret":{"type":"string","description":"Signing Secret for Slack app configuration"}}},"google":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is Google app integration available","default":false}}},"teams":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is MS Teams app integration available","default":false},"appName":{"type":"string","description":"Microsoft App Name for MS Teams app configuration"},"appId":{"type":"string","description":"Microsoft App ID for MS Teams app configuration"},"botId":{"type":"string","description":"Microsoft Bot ID for MS Teams app configuration"},"botPassword":{"type":"string","description":"Microsoft Bot Password for MS Teams app configuration"}}},"office":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is MS Office365 app integration available","default":false}}}}}},"403":{"description":"User does not have permission"},"404":{"description":"Name not found.","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]},"post":{"x-permission-type":"admins-only","operationId":"setInfusionSettings","summary":"Set infusion settings.","description":"The **infusion settings** used for store infusion page configuration.","tags":["settings"],"responses":{"200":{"description":"Infusion configuration settings.","schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Turns infusion service on or off","default":false},"slack":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is Slack app integration available","default":false},"clientId":{"type":"string","description":"Client ID for Slack app configuration"},"clientSecret":{"type":"string","description":"Client Secret for Slack app configuration"},"signingSecret":{"type":"string","description":"Signing Secret for Slack app configuration"}}},"google":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is Google app integration available","default":false}}},"teams":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is MS Teams app integration available","default":false},"appName":{"type":"string","description":"Microsoft App Name for MS Teams app configuration"},"appId":{"type":"string","description":"Microsoft App ID for MS Teams app configuration"},"botId":{"type":"string","description":"Microsoft Bot ID for MS Teams app configuration"},"botPassword":{"type":"string","description":"Microsoft Bot Password for MS Teams app configuration"}}},"office":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is MS Office365 app integration available","default":false}}}}}},"400":{"description":"Invalid input.","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"Object with the infusion settings.","name":"infusion","required":true,"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Turns infusion service on or off","default":false},"slack":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is Slack app integration available","default":false},"clientId":{"type":"string","description":"Client ID for Slack app configuration"},"clientSecret":{"type":"string","description":"Client Secret for Slack app configuration"},"signingSecret":{"type":"string","description":"Signing Secret for Slack app configuration"}}},"google":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is Google app integration available","default":false}}},"teams":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is MS Teams app integration available","default":false},"appName":{"type":"string","description":"Microsoft App Name for MS Teams app configuration"},"appId":{"type":"string","description":"Microsoft App ID for MS Teams app configuration"},"botId":{"type":"string","description":"Microsoft Bot ID for MS Teams app configuration"},"botPassword":{"type":"string","description":"Microsoft Bot Password for MS Teams app configuration"}}},"office":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is MS Office365 app integration available","default":false}}}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]},"delete":{"x-permission-type":"admins-only","operationId":"removeInfusionSettings","summary":"Delete infusion settings.","description":"The **infusion settings** used for store infusion page configuration.","tags":["settings"],"responses":{"204":{"description":"Delete operation was successfull."},"400":{"description":"Invalid input.","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/user-parameters":{"x-swagger-router-controller":"user-parameters.controller.v1","x-permission-type":"general","get":{"x-permission-path":"user-parameters/read","x-hide":false,"operationId":"listUserParameters","summary":"Get all user parameters variables.","description":"The **get user parameters** endpoint used for getting all variables.","tags":["parameters"],"responses":{"200":{"description":"All user parameters variables.","schema":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","description":"The OID of user-parameter"},"name":{"type":"string","description":"The name of user-parameter"},"displayName":{"type":"string","description":"The displayname of user-parameter on client"},"type":{"type":"string","enum":["string","number","boolean","integer"],"description":"The type of user-parameter, is an enum of string, number, boolean, or integer"},"applicableAreas":{"type":"array","items":{"type":"string","enum":["Connections","Custom Live Queries","Management Console"],"description":"The appliсation area, array of enums"}},"hidden":{"type":"boolean","default":false},"description":{"type":"string","description":"Description of user-parameter"}}}}},"403":{"description":"User does not have permission"},"500":{"description":"- **500** Internal Server Error\n","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"header","description":"The device id.","name":"x-device-id","required":false,"type":"string"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]},"post":{"x-permission-path":"user-parameters/write","x-hide":false,"operationId":"createUserParameter","summary":"Add user parameter variable.","description":"The **add user parameter** endpoint receive variable and used for storing it.","tags":["parameters"],"responses":{"201":{"description":"User parameter variable.","schema":{"type":"object","properties":{"_id":{"type":"string","description":"The OID of user-parameter"},"name":{"type":"string","description":"The name of user-parameter"},"displayName":{"type":"string","description":"The displayname of user-parameter on client"},"type":{"type":"string","enum":["string","number","boolean","integer"],"description":"The type of user-parameter, is an enum of string, number, boolean, or integer"},"applicableAreas":{"type":"array","items":{"type":"string","enum":["Connections","Custom Live Queries","Management Console"],"description":"The appliсation area, array of enums"}},"hidden":{"type":"boolean","default":false},"description":{"type":"string","description":"Description of user-parameter"},"users":{"type":"object","description":"Object of users, where key is user OID","additionalProperties":{"type":"object","required":["contextId","contextType","value"],"properties":{"contextId":{"type":"string","description":"User's OID"},"contextType":{"type":"string","enum":["users"],"description":"Member type"},"value":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"User-parameter value for the user"},"priority":{"type":"integer","description":"Priority of user-parameter for the user"}}},"example":{"5f02edfab456d2002c1b29dc":{"contextId":"5f02edfab456d2002c1b29dc","contextType":"users","value":"user.email@sisense.com","priority":0}}},"groups":{"type":"object","description":"Object of groups, where key is group OID","additionalProperties":{"type":"object","required":["contextId","contextType","value","priority"],"properties":{"contextId":{"type":"string","description":"Group's OID"},"contextType":{"type":"string","enum":["groups"],"description":"Member type"},"value":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"User-parameter value for the group"},"priority":{"type":"integer","description":"Priority of user-parameter for the group"}}},"example":{"5f02edfab456d2002c1b29dc":{"contextId":"5f02edfab456d2002c1b29dc","contextType":"groups","value":"group.email@sisense.com","priority":0}}},"default":{"type":"object","properties":{"contextType":{"type":"string","enum":["default"],"description":"Member type"},"value":{"type":"string","description":"User-parameter value by default"}},"example":{"default":{"contextType":"default","value":"default.email@sisense.com"}}}}}},"400":{"description":"Invalid input.","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"},"500":{"description":"- **500** Internal Server Error\n","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"header","description":"The device id.","name":"x-device-id","required":false,"type":"string"},{"in":"body","description":"User parameter variable object to be added.","name":"User parameter","schema":{"type":"object","required":["name","displayName","type","applicableAreas","hidden"],"properties":{"name":{"type":"string","description":"The name of user-parameter"},"displayName":{"type":"string","description":"The displayname of user-parameter on client"},"type":{"type":"string","enum":["string","number","boolean","integer"],"description":"The type of user-parameter, is an enum of string, number, boolean, or integer"},"applicableAreas":{"type":"array","items":{"type":"string","enum":["Connections","Custom Live Queries","Management Console"],"description":"The appliсation area, array of enums"}},"hidden":{"type":"boolean","default":false},"description":{"type":"string","description":"Description of user-parameter"},"users":{"type":"object","description":"Object of users, where key is user OID","additionalProperties":{"type":"object","required":["contextId","contextType","value"],"properties":{"contextId":{"type":"string","description":"User's OID"},"contextType":{"type":"string","enum":["users"],"description":"Member type"},"value":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"User-parameter value for the user"},"priority":{"type":"integer","description":"Priority of user-parameter for the user"}}},"example":{"5f02edfab456d2002c1b29dc":{"contextId":"5f02edfab456d2002c1b29dc","contextType":"users","value":"user.email@sisense.com","priority":0}}},"groups":{"type":"object","description":"Object of groups, where key is group OID","additionalProperties":{"type":"object","required":["contextId","contextType","value","priority"],"properties":{"contextId":{"type":"string","description":"Group's OID"},"contextType":{"type":"string","enum":["groups"],"description":"Member type"},"value":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"User-parameter value for the group"},"priority":{"type":"integer","description":"Priority of user-parameter for the group"}}},"example":{"5f02edfab456d2002c1b29dc":{"contextId":"5f02edfab456d2002c1b29dc","contextType":"groups","value":"group.email@sisense.com","priority":0}}},"default":{"type":"object","properties":{"contextType":{"type":"string","enum":["default"],"description":"Member type"},"value":{"type":"string","description":"User-parameter value by default"}},"example":{"default":{"contextType":"default","value":"default.email@sisense.com"}}}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]},"delete":{"x-permission-path":"user-parameters/write","x-hide":false,"operationId":"bulkDeleteUserParameters","summary":"Delete selected user parameters","description":"The *delete user parameters* endpoint receives variable ids and deletes these variables in Sisense.\n","tags":["parameters"],"responses":{"204":{"description":"Delete operation was successfull.","schema":{"type":"object","properties":{"deleted":{"type":"array","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"}}}}},"400":{"description":"Invalid input.","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"},"500":{"description":"- **500** Internal Server Error\n","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"header","description":"The device id.","name":"x-device-id","required":false,"type":"string"},{"in":"body","description":"Array of user parameters IDs to delete, separated by a comma (`,`)","required":true,"name":"ids","schema":{"type":"array","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/user-parameters/{id}":{"x-swagger-router-controller":"user-parameters.controller.v1","x-permission-type":"general","get":{"x-permission-path":"user-parameters/read","x-hide":false,"operationId":"getUserParameter","summary":"Get user parameter variable.","description":"The **get user parameter** endpoint used for getting variable by ID.","tags":["parameters"],"responses":{"200":{"description":"User parameter variable.","schema":{"type":"object","properties":{"_id":{"type":"string","description":"The OID of user-parameter"},"name":{"type":"string","description":"The name of user-parameter"},"displayName":{"type":"string","description":"The displayname of user-parameter on client"},"type":{"type":"string","enum":["string","number","boolean","integer"],"description":"The type of user-parameter, is an enum of string, number, boolean, or integer"},"applicableAreas":{"type":"array","items":{"type":"string","enum":["Connections","Custom Live Queries","Management Console"],"description":"The appliсation area, array of enums"}},"hidden":{"type":"boolean","default":false},"description":{"type":"string","description":"Description of user-parameter"},"users":{"type":"object","description":"Object of users, where key is user OID","additionalProperties":{"type":"object","properties":{"contextId":{"type":"string","description":"User's OID"},"contextType":{"type":"string","enum":["users"],"description":"Member type"},"value":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"User-parameter value for the user"},"priority":{"type":"integer","description":"Priority of user-parameter for the user"},"email":{"type":"string","description":"User's email"},"userName":{"type":"string","description":"User's name"}}},"example":{"5f02edfab456d2002c1b29dc":{"contextId":"5f02edfab456d2002c1b29dc","contextType":"users","value":12345,"priority":0,"email":"user.email@sisense.com","userName":"name"}}},"groups":{"type":"object","description":"Object of groups, where key is group OID","additionalProperties":{"type":"object","properties":{"contextId":{"type":"string","description":"Group's OID"},"contextType":{"type":"string","enum":["groups"],"description":"Member type"},"value":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"User-parameter value for the group"},"priority":{"type":"integer","description":"Priority of user-parameter for the group"},"groupName":{"type":"string","description":"Name of the group"}}},"example":{"5f02edfab456d2002c1b29dc":{"contextId":"5f02edfab456d2002c1b29dc","contextType":"groups","value":"group.email@sisense.com","priority":0,"groupName":"Admins"}}},"default":{"type":"object","properties":{"contextType":{"type":"string","enum":["default"],"description":"Member type"},"value":{"type":"string","description":"User-parameter value by default"}},"example":{"default":{"contextType":"default","value":"default.email@sisense.com"}}}}}},"403":{"description":"User does not have permission"},"404":{"description":"User parameter not found.","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}},"500":{"description":"- **500** Internal Server Error\n","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"header","description":"The device id.","name":"x-device-id","required":false,"type":"string"},{"in":"path","description":"The ID of the user parameter to get variable","name":"id","required":true,"type":"string","pattern":"^[0-9a-fA-F]{24}$"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]},"patch":{"x-permission-path":"user-parameters/write","x-hide":false,"operationId":"updateUserParameter","summary":"Update the user parameter variable.","description":"The **update user parameter** endpoint updates the variable with new data.","tags":["parameters"],"responses":{"200":{"description":"User parameter context variable.","schema":{"type":"object","properties":{"_id":{"type":"string","description":"The OID of user-parameter"},"name":{"type":"string","description":"The name of user-parameter"},"displayName":{"type":"string","description":"The displayname of user-parameter on client"},"type":{"type":"string","enum":["string","number","boolean","integer"],"description":"The type of user-parameter, is an enum of string, number, boolean, or integer"},"applicableAreas":{"type":"array","items":{"type":"string","enum":["Connections","Custom Live Queries","Management Console"],"description":"The appliсation area, array of enums"}},"hidden":{"type":"boolean","default":false},"description":{"type":"string","description":"Description of user-parameter"},"users":{"type":"object","description":"Object of users, where key is user OID","additionalProperties":{"type":"object","required":["contextId","contextType","value"],"properties":{"contextId":{"type":"string","description":"User's OID"},"contextType":{"type":"string","enum":["users"],"description":"Member type"},"value":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"User-parameter value for the user"},"priority":{"type":"integer","description":"Priority of user-parameter for the user"}}},"example":{"5f02edfab456d2002c1b29dc":{"contextId":"5f02edfab456d2002c1b29dc","contextType":"users","value":"user.email@sisense.com","priority":0}}},"groups":{"type":"object","description":"Object of groups, where key is group OID","additionalProperties":{"type":"object","required":["contextId","contextType","value","priority"],"properties":{"contextId":{"type":"string","description":"Group's OID"},"contextType":{"type":"string","enum":["groups"],"description":"Member type"},"value":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"User-parameter value for the group"},"priority":{"type":"integer","description":"Priority of user-parameter for the group"}}},"example":{"5f02edfab456d2002c1b29dc":{"contextId":"5f02edfab456d2002c1b29dc","contextType":"groups","value":"group.email@sisense.com","priority":0}}},"default":{"type":"object","properties":{"contextType":{"type":"string","enum":["default"],"description":"Member type"},"value":{"type":"string","description":"User-parameter value by default"}},"example":{"default":{"contextType":"default","value":"default.email@sisense.com"}}}}}},"400":{"description":"Invalid input.","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"},"404":{"description":"User parameter not found.","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}},"500":{"description":"- **500** Internal Server Error\n","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"header","description":"The device id.","name":"x-device-id","required":false,"type":"string"},{"in":"path","description":"The ID of the user parameter to be updated variable","name":"id","required":true,"type":"string","pattern":"^[0-9a-fA-F]{24}$"},{"in":"body","description":"User parameter object to be added.","name":"User parameter","schema":{"type":"object","required":["name","displayName","type","applicableAreas","hidden"],"properties":{"name":{"type":"string","description":"The name of user-parameter"},"displayName":{"type":"string","description":"The displayname of user-parameter on client"},"type":{"type":"string","enum":["string","number","boolean","integer"],"description":"The type of user-parameter, is an enum of string, number, boolean, or integer"},"applicableAreas":{"type":"array","items":{"type":"string","enum":["Connections","Custom Live Queries","Management Console"],"description":"The appliсation area, array of enums"}},"hidden":{"type":"boolean","default":false},"description":{"type":"string","description":"Description of user-parameter"},"users":{"type":"object","description":"Object of users, where key is user OID","additionalProperties":{"type":"object","required":["contextId","contextType","value"],"properties":{"contextId":{"type":"string","description":"User's OID"},"contextType":{"type":"string","enum":["users"],"description":"Member type"},"value":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"User-parameter value for the user"},"priority":{"type":"integer","description":"Priority of user-parameter for the user"}}},"example":{"5f02edfab456d2002c1b29dc":{"contextId":"5f02edfab456d2002c1b29dc","contextType":"users","value":"user.email@sisense.com","priority":0}}},"groups":{"type":"object","description":"Object of groups, where key is group OID","additionalProperties":{"type":"object","required":["contextId","contextType","value","priority"],"properties":{"contextId":{"type":"string","description":"Group's OID"},"contextType":{"type":"string","enum":["groups"],"description":"Member type"},"value":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"User-parameter value for the group"},"priority":{"type":"integer","description":"Priority of user-parameter for the group"}}},"example":{"5f02edfab456d2002c1b29dc":{"contextId":"5f02edfab456d2002c1b29dc","contextType":"groups","value":"group.email@sisense.com","priority":0}}},"default":{"type":"object","properties":{"contextType":{"type":"string","enum":["default"],"description":"Member type"},"value":{"type":"string","description":"User-parameter value by default"}},"example":{"default":{"contextType":"default","value":"default.email@sisense.com"}}}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]},"delete":{"x-permission-path":"user-parameters/write","x-hide":false,"operationId":"deleteUserParameter","summary":"Delete user parameter variable.","description":"The **delete user parameter** endpoint deletes the variable.","tags":["parameters"],"responses":{"204":{"description":"Delete operation was successfull."},"400":{"description":"Invalid input.","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"},"404":{"description":"User parameter not found.","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}},"500":{"description":"- **500** Internal Server Error\n","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"header","description":"The device id.","name":"x-device-id","required":false,"type":"string"},{"in":"path","description":"The ID of the user parameter variable to be deleted","name":"id","required":true,"type":"string","pattern":"^[0-9a-fA-F]{24}$"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/user-parameters/{id}/values":{"x-swagger-router-controller":"user-parameters.controller.v1","x-permission-type":"general","post":{"x-permission-path":"user-parameters/write","x-hide":false,"operationId":"bulkUpdateUserParameters","summary":"Update parameter values","description":"Add, update or remove one or more assigned values.\nThis endpoint operates as a non-atomic `json-patch`, receiving a list of instructions. Each instruction will be executed in sequence, and any failed instructions will be specified in the response.\n**Group priority:** As users can belong to multiple groups, when assigning parameter values to a group you must also specify a `priority` that will be used to choose which value to apply in such cases.\n","tags":["parameters"],"responses":{"200":{"description":"OK.","schema":{"type":"object","properties":{"changed":{"type":"array","description":"A list of successful operations","items":{"type":"object","required":["op","path"],"properties":{"op":{"type":"string","description":"Operation type to be performed","enum":["add","update","remove"],"example":"update"},"path":{"type":"string","description":"The object to perform the operation on. The root defines the value assignment type: `/users`, `/groups` or `/default`. The ID must be specified for `/users` and `/groups`.\n","pattern":"^\\/users\\/[0-9a-fA-F]{24}$|^\\/groups\\/[0-9a-fA-F]{24}$|^\\/default$","example":"/users/61f16367832227001b55e9eb"},"value":{"type":"object","properties":{"value":{"type":["string","number","boolean","object","array","null"],"description":"User parameter value to be assigned. Can be `string` or `number`","example":"administrator"},"priority":{"type":"integer","description":"Priority of user parameter value for a given group. Must be provided for `/groups` value","example":5}}}}}},"errors":{"type":"array","description":"A list of failed operations","items":{"type":"object","properties":{"op":{"type":"string","description":"Operation type to be performed","enum":["add","update","remove"],"example":"update"},"path":{"type":"string","description":"The object to perform the operation on. The root defines the value assignment type: `/users`, `/groups` or `/default`. The ID must be specified for `/users` and `/groups`.\n","pattern":"^\\/users\\/[0-9a-fA-F]{24}$|^\\/groups\\/[0-9a-fA-F]{24}$|^\\/default$","example":"/users/61f16367832227001b55e9eb"},"error":{"type":"object","properties":{"message":{"type":"string","description":"Error message","example":"Cannot perform 'update' operation at the non-existing path"}}}}}}}}},"403":{"description":"User does not have permission"},"404":{"description":"User parameter not found.","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}},"413":{"description":"Payload Too Large.","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"500":{"description":"- **500** Internal Server Error\n","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"parameters":[{"in":"path","description":"The ID of the user parameter to update values for","name":"id","required":true,"type":"string","pattern":"^[0-9a-fA-F]{24}$"},{"in":"body","description":"User parameter assigned values to be modified","name":"values","schema":{"type":"array","description":"User parameter assigned values to be modified","items":{"type":"object","required":["op","path"],"properties":{"op":{"type":"string","description":"Operation type to be performed","enum":["add","update","remove"],"example":"update"},"path":{"type":"string","description":"The object to perform the operation on. The root defines the value assignment type: `/users`, `/groups` or `/default`. The ID must be specified for `/users` and `/groups`.\n","pattern":"^\\/users\\/[0-9a-fA-F]{24}$|^\\/groups\\/[0-9a-fA-F]{24}$|^\\/default$","example":"/users/61f16367832227001b55e9eb"},"value":{"type":"object","properties":{"value":{"type":["string","number","boolean","object","array","null"],"description":"User parameter value to be assigned. Can be `string` or `number`","example":"administrator"},"priority":{"type":"integer","description":"Priority of user parameter value for a given group. Must be provided for `/groups` value","example":5}}}}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]}},"/feature-access":{"x-swagger-router-controller":"feature-access.controller.v1","x-permission-type":"admins-only","x-roles-allowed":"tenantAdmin","get":{"operationId":"getFeatureAccess","summary":"Get feature-access settings for the active tenant.","description":"Returns `features` — every managed feature's master switch, entitled flag and the groups\nit is granted to, for the ACTIVE tenant (from context; no tenant param). The system view\nof which tenants may manage each feature is a separate endpoint:\nGET /feature-access/entitlements.\n","tags":["feature-access"],"responses":{"200":{"description":"Feature-access settings.","schema":{"type":"object","description":"The active tenant's management view.","properties":{"features":{"type":"array","items":{"type":"object","description":"A feature's management view for the active tenant.","properties":{"feature":{"type":"string"},"entitled":{"type":"boolean"},"accessors":{"type":"object","description":"The groups that may use the feature in this tenant (empty = off).","properties":{"groups":{"type":"array","items":{"type":"string"}}}}}}}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]}},"/feature-access/entitlements":{"x-swagger-router-controller":"feature-access.controller.v1","x-permission-type":"admins-only","get":{"x-mt-visible":true,"operationId":"getFeatureEntitlements","summary":"Get which tenants may manage each feature.","description":"Returns `entitlements` — every managed feature with its deployment master switch and the\ntenants allowed to manage it. Cross-tenant, so system tenant only.\n","tags":["feature-access"],"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"responses":{"200":{"description":"The system entitlements view.","schema":{"type":"object","description":"The system view of which tenants may manage each feature.","properties":{"entitlements":{"type":"array","items":{"type":"object","description":"A feature and the tenants allowed to manage it (system entitlements view).","properties":{"feature":{"type":"string"},"entitledTenants":{"type":"array","items":{"type":"string"}}}}}}}},"403":{"description":"User does not have permission"}}}},"/feature-access/{feature}/entitlements":{"x-swagger-router-controller":"feature-access.controller.v1","x-permission-type":"admins-only","put":{"x-mt-visible":true,"operationId":"setEntitlementsFeatureAccess","summary":"Set which tenants may manage a feature.","description":"Replaces the entitlement allowlist for a feature — the full set of tenants allowed to\nmanage it. System tenant only. Each NEWLY entitled tenant also gets its built-in Admins\ngroup granted access to the feature (best-effort, additive); tenant admins can remove or\nextend that grant via the accessors endpoint.\n","tags":["feature-access"],"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"name":"feature","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"type":"object","required":["tenantIds"],"properties":{"tenantIds":{"type":"array","items":{"type":"string"},"description":"Full set of tenants allowed to manage the feature (replaces the current set)."}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"responses":{"200":{"description":"Updated entitlements."},"400":{"description":"Invalid input","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}}}},"/feature-access/{feature}/accessors":{"x-swagger-router-controller":"feature-access.controller.v1","x-permission-type":"admins-only","x-roles-allowed":"tenantAdmin","put":{"operationId":"setAccessorsFeatureAccess","summary":"Set which groups use a feature within a tenant.","description":"Replaces a tenant's group allowlist for a feature. Send `all: true` to grant every group\nthe tenant has at the time of the call (expanded server-side, a snapshot), or `groupIds`\nfor an explicit set. The tenant must be entitled first. A tenant admin manages their own\ntenant; a system admin manages another tenant by using that tenant's active context.\n","tags":["feature-access"],"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"name":"feature","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"type":"object","description":"Which groups use the feature in the active tenant. Send EITHER `all: true` OR `groupIds`; both are optional and neither/empty means off. If both are sent, `all` wins.","properties":{"all":{"type":"boolean","description":"Grant to every group the tenant has AT THE TIME OF THE CALL. Expanded server-side into the same per-group grants an explicit list produces, so it is a snapshot: groups created afterwards are not granted until this is saved again."},"groupIds":{"type":"array","items":{"type":"string"},"description":"Groups that may use the feature (replaces the current set)."}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"responses":{"200":{"description":"Updated accessors.","schema":{"type":"object","description":"The resulting group allowlist. Note there is no stored \"whole tenant\" state to read back: `all` echoes what was REQUESTED, and `groups` is the per-group snapshot it expanded to.","properties":{"feature":{"type":"string"},"all":{"type":"boolean","description":"Whether this request asked for every current group (request metadata, not durable state). A group created after this call is not granted."},"groups":{"type":"array","items":{"type":"string"},"description":"The groups granted the feature after the write."}}}},"400":{"description":"Invalid input","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}}}},"/budget-store/tenants/{tenantId}":{"x-swagger-router-controller":"budget-store.controller.v1","x-permission-type":"admins-only","get":{"x-roles-allowed":"tenantAdmin","operationId":"getTenantBudget","summary":"Get a tenant's AI credit budget.","description":"Returns the tenant's credit limit. For `llmScope: managed` (the default), `creditLimit: 0`\nmeans no credit has ever been allocated to this tenant — there is no uncapped/unlimited\nstate. For `llmScope: byok` (SNS-135240), an unallocated tenant instead reads as\n`creditLimit: null` (unlimited — nothing capping it yet).\n\nA system administrator may read any tenant; a tenant administrator may read only its own\ntenant, because that limit is the pool its group budgets are allocated out of. Any other\ntenant is 403. Setting a tenant's limit, and listing every tenant's, remain system-only.\n","tags":["budget-store"],"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"name":"tenantId","in":"path","required":true,"type":"string"},{"name":"llmScope","in":"query","description":"Which budget to read (SNS-135240) — `managed` (consumption-service credits, the default) or `byok` (customer-owned-key token budgets).","required":false,"type":"string","enum":["managed","byok"],"default":"managed"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"responses":{"200":{"description":"The tenant's budget.","schema":{"type":"object","description":"A scope's budget. For `llmScope: managed`, `creditLimit: 0` (with no `updatedBy`/`updatedAt`) means no credit has ever been allocated to this scope — there is no uncapped/unlimited state for managed. For `llmScope: byok` (SNS-135240), an unallocated scope instead reads as `creditLimit: null` (unlimited, not enforced).","properties":{"scopeType":{"type":"string","enum":["tenant","group"]},"scopeId":{"type":"string"},"llmScope":{"type":"string","enum":["managed","byok"],"description":"Which budget this is (SNS-135240) — echoes the request's `llmScope` param."},"tenantId":{"type":"string"},"creditLimit":{"type":["number","null"],"description":"The allocated credit limit. Always present. For managed, always a finite number >= 0 (0 when unallocated). For BYOK, null when unallocated (unlimited), otherwise >= 0."},"updatedBy":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":["string","null"],"description":"The scope's display name. Only present on the list endpoints (GET /budget-store/tenants, GET /budget-store/groups) — those are the only views that join against identity for it. `null` when identity no longer has a record of the scope (e.g. a deleted group/tenant that still has a budget document or feature-access row)."}}}},"400":{"description":"Invalid tenantId","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}}},"put":{"x-mt-visible":true,"operationId":"setTenantBudget","summary":"Set a tenant's AI credit limit.","description":"Sets (or replaces) the tenant's credit limit, effective immediately. Not a monthly or\nrecurring value. System tenant only.\n\nRule 1 (SNS-133920): on a managed deployment, an increase above the environment's own\ncredit pool is rejected (422). A decrease is always allowed, even from an already-over-cap\nstate. Not enforced on-prem (no consumption-service to check against).\n\nRule 2 (SNS-133920): a decrease re-aligns every group of this tenant that now exceeds the\nnew cap, clamping it down to the new cap. Best-effort — a failure here does not fail this\nwrite.\n\n`llmScope` query param (SNS-135240): `managed` (the default) or `byok` — sets which budget\nthis write targets.\n","tags":["budget-store"],"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"name":"tenantId","in":"path","required":true,"type":"string"},{"name":"llmScope","in":"query","description":"Which budget to set (SNS-135240) — `managed` (consumption-service credits, the default) or `byok` (customer-owned-key token budgets).","required":false,"type":"string","enum":["managed","byok"],"default":"managed"},{"in":"body","name":"body","required":true,"schema":{"type":"object","required":["creditLimit"],"properties":{"creditLimit":{"type":"number","minimum":0,"description":"The credit limit for this scope. Must be a finite number >= 0. Not a monthly/recurring value — it stays exactly what it was set to until changed again, effective immediately."}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"responses":{"200":{"description":"The updated budget.","schema":{"type":"object","description":"A scope's budget. For `llmScope: managed`, `creditLimit: 0` (with no `updatedBy`/`updatedAt`) means no credit has ever been allocated to this scope — there is no uncapped/unlimited state for managed. For `llmScope: byok` (SNS-135240), an unallocated scope instead reads as `creditLimit: null` (unlimited, not enforced).","properties":{"scopeType":{"type":"string","enum":["tenant","group"]},"scopeId":{"type":"string"},"llmScope":{"type":"string","enum":["managed","byok"],"description":"Which budget this is (SNS-135240) — echoes the request's `llmScope` param."},"tenantId":{"type":"string"},"creditLimit":{"type":["number","null"],"description":"The allocated credit limit. Always present. For managed, always a finite number >= 0 (0 when unallocated). For BYOK, null when unallocated (unlimited), otherwise >= 0."},"updatedBy":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":["string","null"],"description":"The scope's display name. Only present on the list endpoints (GET /budget-store/tenants, GET /budget-store/groups) — those are the only views that join against identity for it. `null` when identity no longer has a record of the scope (e.g. a deleted group/tenant that still has a budget document or feature-access row)."}}}},"400":{"description":"Invalid input","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"},"422":{"description":"creditLimit would exceed the environment's credit pool (Rule 1).","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"subErrors":{"type":"array","items":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}}}]}}}}}},"delete":{"x-mt-visible":true,"operationId":"deleteTenantBudget","summary":"Revert a tenant's budget to unallocated (0 credits for managed, unlimited for BYOK).","description":"Removes the tenant's budget document. System tenant only. `llmScope` query param\n(SNS-135240): `managed` (the default) or `byok`.\n","tags":["budget-store"],"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"name":"tenantId","in":"path","required":true,"type":"string"},{"name":"llmScope","in":"query","description":"Which budget to revert (SNS-135240) — `managed` (consumption-service credits, the default) or `byok` (customer-owned-key token budgets).","required":false,"type":"string","enum":["managed","byok"],"default":"managed"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"responses":{"200":{"description":"The scope that was reverted to unallocated.","schema":{"type":"object","properties":{"scopeType":{"type":"string","enum":["tenant","group"]},"scopeId":{"type":"string"}}}},"400":{"description":"Invalid tenantId","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}}}},"/budget-store/tenants":{"x-swagger-router-controller":"budget-store.controller.v1","x-permission-type":"admins-only","get":{"operationId":"listTenantBudgets","summary":"List every tenant's AI credit budget in the deployment.","description":"System tenant only. A tenant appears if it has an actual allocation, OR if it's entitled to\nat least one CREDIT-CONSUMING feature in the feature-access catalog (shown at 0 credits) —\nnot literally every tenant in the deployment. A tenant with neither is dropped entirely, not\nshown with a 0-credit entry. Includes each tenant's display name.\n\nEntitlement to Search alone does NOT qualify a tenant for this list — Search doesn't draw on\nthe AI credit pool the way the catalog's other features do, so there is nothing there to\nallocate credit for.\n\n`llmScope` query param (SNS-135240): `managed` (the default) or `byok`. For `byok`, an\nunallocated-but-entitled tenant is lazily seeded at the environment's current live balance\n(SNS-134743 redesign) before this list is built — it is not shown as unlimited unless the\nenvironment itself currently has no quota.\n","tags":["budget-store"],"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"name":"llmScope","in":"query","description":"Which budget to list (SNS-135240) — `managed` (consumption-service credits, the default) or `byok` (customer-owned-key token budgets).","required":false,"type":"string","enum":["managed","byok"],"default":"managed"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"responses":{"200":{"description":"Every tenant's budget.","schema":{"type":"object","properties":{"budgets":{"type":"array","items":{"type":"object","description":"A scope's budget. For `llmScope: managed`, `creditLimit: 0` (with no `updatedBy`/`updatedAt`) means no credit has ever been allocated to this scope — there is no uncapped/unlimited state for managed. For `llmScope: byok` (SNS-135240), an unallocated scope instead reads as `creditLimit: null` (unlimited, not enforced).","properties":{"scopeType":{"type":"string","enum":["tenant","group"]},"scopeId":{"type":"string"},"llmScope":{"type":"string","enum":["managed","byok"],"description":"Which budget this is (SNS-135240) — echoes the request's `llmScope` param."},"tenantId":{"type":"string"},"creditLimit":{"type":["number","null"],"description":"The allocated credit limit. Always present. For managed, always a finite number >= 0 (0 when unallocated). For BYOK, null when unallocated (unlimited), otherwise >= 0."},"updatedBy":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":["string","null"],"description":"The scope's display name. Only present on the list endpoints (GET /budget-store/tenants, GET /budget-store/groups) — those are the only views that join against identity for it. `null` when identity no longer has a record of the scope (e.g. a deleted group/tenant that still has a budget document or feature-access row)."}}}}}}},"403":{"description":"User does not have permission"}}},"put":{"x-mt-visible":true,"operationId":"setTenantBudgets","summary":"Set many tenants' AI credit limits in one call.","description":"Bulk allocation: sets each listed tenant's credit limit to its own value, in one round\ntrip. System tenant only. PARTIAL SUCCESS — an entry that fails validation, or Rule 1\n(SNS-133920, exceeds the environment's credit pool on a managed deployment), is reported in\n`failed` rather than failing the whole call; entries that were fine still write, and each\nstill triggers Rule 2's group re-alignment on a decrease.\n\n`llmScope` query param (SNS-135240): `managed` (the default) or `byok` — applies to every\nentry in the batch.\n","tags":["budget-store"],"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"name":"llmScope","in":"query","description":"Which budget to set (SNS-135240) — `managed` (consumption-service credits, the default) or `byok` (customer-owned-key token budgets).","required":false,"type":"string","enum":["managed","byok"],"default":"managed"},{"in":"body","name":"body","required":true,"schema":{"type":"object","required":["budgets"],"properties":{"budgets":{"type":"array","items":{"type":"object","required":["tenantId","creditLimit"],"properties":{"tenantId":{"type":"string"},"creditLimit":{"type":"number","minimum":0}}}}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"responses":{"200":{"description":"Which entries were written and which failed, and why.","schema":{"type":"object","description":"Partial success: entries that failed validation/ownership are reported in `failed` rather than aborting the whole call, so the entries that were fine still get written.","properties":{"succeeded":{"type":"array","items":{"type":"object","description":"A scope's budget. For `llmScope: managed`, `creditLimit: 0` (with no `updatedBy`/`updatedAt`) means no credit has ever been allocated to this scope — there is no uncapped/unlimited state for managed. For `llmScope: byok` (SNS-135240), an unallocated scope instead reads as `creditLimit: null` (unlimited, not enforced).","properties":{"scopeType":{"type":"string","enum":["tenant","group"]},"scopeId":{"type":"string"},"llmScope":{"type":"string","enum":["managed","byok"],"description":"Which budget this is (SNS-135240) — echoes the request's `llmScope` param."},"tenantId":{"type":"string"},"creditLimit":{"type":["number","null"],"description":"The allocated credit limit. Always present. For managed, always a finite number >= 0 (0 when unallocated). For BYOK, null when unallocated (unlimited), otherwise >= 0."},"updatedBy":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":["string","null"],"description":"The scope's display name. Only present on the list endpoints (GET /budget-store/tenants, GET /budget-store/groups) — those are the only views that join against identity for it. `null` when identity no longer has a record of the scope (e.g. a deleted group/tenant that still has a budget document or feature-access row)."}}}},"failed":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id (tenantId or groupId, matching the request) that failed."},"reason":{"type":"string"}}}}}}},"400":{"description":"Invalid input","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}}},"delete":{"x-mt-visible":true,"operationId":"deleteTenantBudgets","summary":"Revert many tenants to unallocated (0 credits for managed, unlimited for BYOK) in one call.","description":"System tenant only. `llmScope` query param (SNS-135240): `managed` (the default) or `byok`.\nPARTIAL SUCCESS — see `setTenantBudgets`.\n","tags":["budget-store"],"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"name":"llmScope","in":"query","description":"Which budget to revert (SNS-135240) — `managed` (consumption-service credits, the default) or `byok` (customer-owned-key token budgets).","required":false,"type":"string","enum":["managed","byok"],"default":"managed"},{"in":"body","name":"body","required":true,"schema":{"type":"object","required":["tenantIds"],"properties":{"tenantIds":{"type":"array","items":{"type":"string"}}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"responses":{"200":{"description":"Which tenants were reverted and which failed, and why.","schema":{"type":"object","description":"Partial success — see bulkSetResult.","properties":{"succeeded":{"type":"array","items":{"type":"object","properties":{"scopeType":{"type":"string","enum":["tenant","group"]},"scopeId":{"type":"string"}}}},"failed":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id (tenantId or groupId, matching the request) that failed."},"reason":{"type":"string"}}}}}}},"400":{"description":"Invalid input","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}}}},"/budget-store/groups":{"x-swagger-router-controller":"budget-store.controller.v1","x-permission-type":"admins-only","x-roles-allowed":"tenantAdmin","get":{"operationId":"listGroupBudgets","summary":"List the active tenant's group budgets.","description":"A group appears if it has an actual allocation, OR if at least one CREDIT-CONSUMING feature\nin the feature-access catalog is enabled for it (shown at 0 credits) — not every group the\ntenant has. A group with neither is dropped entirely, not shown with a 0-credit entry.\nIncludes each group's display name.\n\nA group enabled for Search alone does NOT qualify for this list — Search doesn't draw on the\nAI credit pool the way the catalog's other features do, so there is nothing there to\nallocate credit for.\n\n`llmScope` query param (SNS-135240): `managed` (the default) or `byok`. For `byok`, an\nunallocated-but-entitled group is shown with `creditLimit: null` (unlimited) instead of 0.\n","tags":["budget-store"],"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"name":"llmScope","in":"query","description":"Which budget to list (SNS-135240) — `managed` (consumption-service credits, the default) or `byok` (customer-owned-key token budgets).","required":false,"type":"string","enum":["managed","byok"],"default":"managed"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"responses":{"200":{"description":"The active tenant's group budgets.","schema":{"type":"object","properties":{"budgets":{"type":"array","items":{"type":"object","description":"A scope's budget. For `llmScope: managed`, `creditLimit: 0` (with no `updatedBy`/`updatedAt`) means no credit has ever been allocated to this scope — there is no uncapped/unlimited state for managed. For `llmScope: byok` (SNS-135240), an unallocated scope instead reads as `creditLimit: null` (unlimited, not enforced).","properties":{"scopeType":{"type":"string","enum":["tenant","group"]},"scopeId":{"type":"string"},"llmScope":{"type":"string","enum":["managed","byok"],"description":"Which budget this is (SNS-135240) — echoes the request's `llmScope` param."},"tenantId":{"type":"string"},"creditLimit":{"type":["number","null"],"description":"The allocated credit limit. Always present. For managed, always a finite number >= 0 (0 when unallocated). For BYOK, null when unallocated (unlimited), otherwise >= 0."},"updatedBy":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":["string","null"],"description":"The scope's display name. Only present on the list endpoints (GET /budget-store/tenants, GET /budget-store/groups) — those are the only views that join against identity for it. `null` when identity no longer has a record of the scope (e.g. a deleted group/tenant that still has a budget document or feature-access row)."}}}}}}},"403":{"description":"User does not have permission"}}},"put":{"operationId":"setGroupBudgets","summary":"Set many of the active tenant's groups' AI credit limits in one call.","description":"Bulk allocation: sets each listed group's credit limit to its own value, in one round trip.\nEvery group must belong to the active tenant. PARTIAL SUCCESS — an entry that fails\nvalidation, ownership, or Rule 1 (SNS-133920, exceeds the owning tenant's own creditLimit)\nis reported in `failed` rather than failing the whole call; entries that were fine still\nwrite.\n\n`llmScope` query param (SNS-135240): `managed` (the default) or `byok` — applies to every\nentry in the batch.\n","tags":["budget-store"],"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"name":"llmScope","in":"query","description":"Which budget to set (SNS-135240) — `managed` (consumption-service credits, the default) or `byok` (customer-owned-key token budgets).","required":false,"type":"string","enum":["managed","byok"],"default":"managed"},{"in":"body","name":"body","required":true,"schema":{"type":"object","required":["budgets"],"properties":{"budgets":{"type":"array","items":{"type":"object","required":["groupId","creditLimit"],"properties":{"groupId":{"type":"string"},"creditLimit":{"type":"number","minimum":0}}}}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"responses":{"200":{"description":"Which entries were written and which failed, and why.","schema":{"type":"object","description":"Partial success: entries that failed validation/ownership are reported in `failed` rather than aborting the whole call, so the entries that were fine still get written.","properties":{"succeeded":{"type":"array","items":{"type":"object","description":"A scope's budget. For `llmScope: managed`, `creditLimit: 0` (with no `updatedBy`/`updatedAt`) means no credit has ever been allocated to this scope — there is no uncapped/unlimited state for managed. For `llmScope: byok` (SNS-135240), an unallocated scope instead reads as `creditLimit: null` (unlimited, not enforced).","properties":{"scopeType":{"type":"string","enum":["tenant","group"]},"scopeId":{"type":"string"},"llmScope":{"type":"string","enum":["managed","byok"],"description":"Which budget this is (SNS-135240) — echoes the request's `llmScope` param."},"tenantId":{"type":"string"},"creditLimit":{"type":["number","null"],"description":"The allocated credit limit. Always present. For managed, always a finite number >= 0 (0 when unallocated). For BYOK, null when unallocated (unlimited), otherwise >= 0."},"updatedBy":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":["string","null"],"description":"The scope's display name. Only present on the list endpoints (GET /budget-store/tenants, GET /budget-store/groups) — those are the only views that join against identity for it. `null` when identity no longer has a record of the scope (e.g. a deleted group/tenant that still has a budget document or feature-access row)."}}}},"failed":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id (tenantId or groupId, matching the request) that failed."},"reason":{"type":"string"}}}}}}},"400":{"description":"Invalid input","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}}},"delete":{"operationId":"deleteGroupBudgets","summary":"Revert many of the active tenant's groups to unallocated (0 credits for managed, unlimited for BYOK) in one call.","description":"Every group must belong to the active tenant. `llmScope` query param (SNS-135240): `managed`\n(the default) or `byok`. PARTIAL SUCCESS — see `setGroupBudgets`.\n","tags":["budget-store"],"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"name":"llmScope","in":"query","description":"Which budget to revert (SNS-135240) — `managed` (consumption-service credits, the default) or `byok` (customer-owned-key token budgets).","required":false,"type":"string","enum":["managed","byok"],"default":"managed"},{"in":"body","name":"body","required":true,"schema":{"type":"object","required":["groupIds"],"properties":{"groupIds":{"type":"array","items":{"type":"string"}}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"responses":{"200":{"description":"Which groups were reverted and which failed, and why.","schema":{"type":"object","description":"Partial success — see bulkSetResult.","properties":{"succeeded":{"type":"array","items":{"type":"object","properties":{"scopeType":{"type":"string","enum":["tenant","group"]},"scopeId":{"type":"string"}}}},"failed":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id (tenantId or groupId, matching the request) that failed."},"reason":{"type":"string"}}}}}}},"400":{"description":"Invalid input","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}}}},"/budget-store/groups/{groupId}":{"x-swagger-router-controller":"budget-store.controller.v1","x-permission-type":"admins-only","x-roles-allowed":"tenantAdmin","get":{"operationId":"getGroupBudget","summary":"Get a group's AI credit budget.","description":"Returns the group's credit limit. The group must belong to the active tenant. For\n`llmScope: managed` (the default), `creditLimit: 0` means no credit has ever been allocated\nto this group. For `llmScope: byok` (SNS-135240), an unallocated group instead reads as\n`creditLimit: null` (unlimited).\n","tags":["budget-store"],"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"name":"groupId","in":"path","required":true,"type":"string"},{"name":"llmScope","in":"query","description":"Which budget to read (SNS-135240) — `managed` (consumption-service credits, the default) or `byok` (customer-owned-key token budgets).","required":false,"type":"string","enum":["managed","byok"],"default":"managed"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"responses":{"200":{"description":"The group's budget.","schema":{"type":"object","description":"A scope's budget. For `llmScope: managed`, `creditLimit: 0` (with no `updatedBy`/`updatedAt`) means no credit has ever been allocated to this scope — there is no uncapped/unlimited state for managed. For `llmScope: byok` (SNS-135240), an unallocated scope instead reads as `creditLimit: null` (unlimited, not enforced).","properties":{"scopeType":{"type":"string","enum":["tenant","group"]},"scopeId":{"type":"string"},"llmScope":{"type":"string","enum":["managed","byok"],"description":"Which budget this is (SNS-135240) — echoes the request's `llmScope` param."},"tenantId":{"type":"string"},"creditLimit":{"type":["number","null"],"description":"The allocated credit limit. Always present. For managed, always a finite number >= 0 (0 when unallocated). For BYOK, null when unallocated (unlimited), otherwise >= 0."},"updatedBy":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":["string","null"],"description":"The scope's display name. Only present on the list endpoints (GET /budget-store/tenants, GET /budget-store/groups) — those are the only views that join against identity for it. `null` when identity no longer has a record of the scope (e.g. a deleted group/tenant that still has a budget document or feature-access row)."}}}},"400":{"description":"Invalid groupId","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}}},"put":{"operationId":"setGroupBudget","summary":"Set a group's AI credit limit.","description":"Sets (or replaces) the group's credit limit, effective immediately. The group must belong\nto the active tenant. A tenant admin manages their own tenant's groups; a system admin\nmanages another tenant's groups — including the system tenant's own groups — by using that\ntenant's active context.\n\nRule 1 (SNS-133920): an increase above the owning tenant's own creditLimit is rejected\n(422). A decrease is always allowed, even from an already-over-cap state.\n\n`llmScope` query param (SNS-135240): `managed` (the default) or `byok` — sets which budget\nthis write targets.\n","tags":["budget-store"],"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"name":"groupId","in":"path","required":true,"type":"string"},{"name":"llmScope","in":"query","description":"Which budget to set (SNS-135240) — `managed` (consumption-service credits, the default) or `byok` (customer-owned-key token budgets).","required":false,"type":"string","enum":["managed","byok"],"default":"managed"},{"in":"body","name":"body","required":true,"schema":{"type":"object","required":["creditLimit"],"properties":{"creditLimit":{"type":"number","minimum":0,"description":"The credit limit for this scope. Must be a finite number >= 0. Not a monthly/recurring value — it stays exactly what it was set to until changed again, effective immediately."}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"responses":{"200":{"description":"The updated budget.","schema":{"type":"object","description":"A scope's budget. For `llmScope: managed`, `creditLimit: 0` (with no `updatedBy`/`updatedAt`) means no credit has ever been allocated to this scope — there is no uncapped/unlimited state for managed. For `llmScope: byok` (SNS-135240), an unallocated scope instead reads as `creditLimit: null` (unlimited, not enforced).","properties":{"scopeType":{"type":"string","enum":["tenant","group"]},"scopeId":{"type":"string"},"llmScope":{"type":"string","enum":["managed","byok"],"description":"Which budget this is (SNS-135240) — echoes the request's `llmScope` param."},"tenantId":{"type":"string"},"creditLimit":{"type":["number","null"],"description":"The allocated credit limit. Always present. For managed, always a finite number >= 0 (0 when unallocated). For BYOK, null when unallocated (unlimited), otherwise >= 0."},"updatedBy":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":["string","null"],"description":"The scope's display name. Only present on the list endpoints (GET /budget-store/tenants, GET /budget-store/groups) — those are the only views that join against identity for it. `null` when identity no longer has a record of the scope (e.g. a deleted group/tenant that still has a budget document or feature-access row)."}}}},"400":{"description":"Invalid input","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"},"422":{"description":"creditLimit would exceed the owning tenant's own budget (Rule 1).","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"subErrors":{"type":"array","items":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}}}]}}}}}},"delete":{"operationId":"deleteGroupBudget","summary":"Revert a group's budget to unallocated (0 credits for managed, unlimited for BYOK).","description":"Removes the group's budget document. `llmScope` query param (SNS-135240): `managed` (the\ndefault) or `byok`.\n","tags":["budget-store"],"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"name":"groupId","in":"path","required":true,"type":"string"},{"name":"llmScope","in":"query","description":"Which budget to revert (SNS-135240) — `managed` (consumption-service credits, the default) or `byok` (customer-owned-key token budgets).","required":false,"type":"string","enum":["managed","byok"],"default":"managed"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"responses":{"200":{"description":"The scope that was reverted to unallocated.","schema":{"type":"object","properties":{"scopeType":{"type":"string","enum":["tenant","group"]},"scopeId":{"type":"string"}}}},"400":{"description":"Invalid groupId","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}}}},"/budget-store/byok/quota":{"x-swagger-router-controller":"budget-store.controller.v1","x-permission-type":"admins-only","put":{"x-mt-visible":true,"operationId":"setByokQuota","summary":"Set or clear the deployment's BYOK token quota.","description":"System tenant only. Body: `{ quotaLimit, featureModelType }`. `quotaLimit` is nullable\n(`null` sets/clears back to unlimited); `featureModelType` (`sisense_managed`/`customer_byok`)\nis the System Admin's provider choice, required and forwarded to grant-service. The Enablement\npage save and the Token Allocation page make the exact same call (SNS-134743 redesign).\n\nDelegates to grant-service, which owns deciding how the quota is applied to\nconsumption-service (always a rebalance; grant-service has no separate grant call), the same\nway it already does for Sisense-managed credits. This service no longer stores the quota or\ntracks a billing cycle — read the current balance from consumption-service's\n`GET api/v1/credits/get-balance`, same as managed.\n\nA grant-service failure fails this request outright, with nothing to roll back. A failure\nAFTER grant-service acknowledges the request (e.g. while clearing BYOK tenant/group budgets\nbelow) also fails this request — grant-service acknowledging the request is not the same as\nconsumption-service's live balance already reflecting the new quota.\nWhen the quota moves to unlimited (`quotaLimit: null`), every existing BYOK tenant/group\nbudget document is cleared so none of them keep a stale cap from before. When a real quota is\nset, every tenant/group entitled to a credit-consuming AI feature with no BYOK document of\nits own is seeded at the new quota, and any tenant that already exceeds it is clamped down\n(cascading to its own groups) — both best-effort, a failure in either does not fail this\nwrite.\n","tags":["budget-store"],"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","name":"body","required":true,"schema":{"type":"object","required":["quotaLimit","featureModelType"],"properties":{"quotaLimit":{"type":["number","null"],"description":"The BYOK token quota to allocate, or null to clear it back to unlimited."},"featureModelType":{"type":"string","enum":["sisense_managed","customer_byok"],"description":"The System Admin's AI provider choice, sent on from the Enablement page save and forwarded to grant-service so it knows which provider this rebalance is for."}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"responses":{"200":{"description":"The quota that was applied.","schema":{"type":"object","description":"The quota just applied to the deployment's BYOK token pool (SNS-134743 redesign) — an echo of the request, not a read of any stored state (this service no longer stores the quota; read the live balance from consumption-service's `get-balance` instead, same as managed).","properties":{"llmScope":{"type":"string","enum":["byok"]},"quotaLimit":{"type":["number","null"],"description":"The BYOK token quota just applied. null means unlimited."},"featureModelType":{"type":"string","enum":["sisense_managed","customer_byok"],"description":"The provider choice echoed back from the request."}}}},"400":{"description":"Invalid input","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"},"500":{"description":"grant-service did not acknowledge the request, or a failure happened after it did (e.g. clearing BYOK tenant/group budgets when the quota moves to unlimited) — an acknowledgment from grant-service may already have happened even though this request failed, but that is not the same as consumption-service's live balance already reflecting the new quota.","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}}}},"/users":{"x-swagger-router-controller":"users.controller.v1","get":{"x-permission-type":"general","x-permission-path":"manage/users/get","x-roles-allowed":"tenantAdmin,admin","operationId":"getUsers","summary":"Get users","description":"The **get users** endpoint returns a list of users with their details.\n<br/>Results can be filtered by parameters such as username and email.\n<br/><br/>The expandable fields for the user object are `groups`, `adgroups` and `role`.\n","tags":["users"],"responses":{"200":{"description":"An array of users","schema":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"email":{"type":"string","pattern":"^(([^<>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z\\-0-9]{2,})|([a-zA-Z\\-0-9]+))$"},"userName":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleId":{"type":"string"},"active":{"type":"boolean"},"groups":{"type":"array","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"}},"adgroups":{"type":"array","items":{"type":"string","pattern":"^\\[\\d{1,3}(?:,\\d{1,3}){27}\\]$"}},"activeDirectory":{"type":"boolean"},"principalName":{"type":"string"},"objectSid":{"type":"string"},"uSNChanged":{"type":"string"},"dn":{"type":"string"},"preferences":{"type":"object","properties":{"localeId":{"type":["string","null"]},"language":{"type":["string","null"]}}},"uiSettings":{"type":"object"},"created":{"type":"string","format":"date-time"},"lastLogin":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"},"ldapDomainId":{"type":"string"},"pendingExpiration":{"type":"string","format":"date-time"},"createdSso":{"type":"string"},"requireTwoFactorAuth":{"type":"boolean","default":false,"description":"Whether two-factor authentication is required for this user. If not provided, defaults to false for new users."}}}}},"403":{"description":"User does not have permission"},"404":{"description":"Invalid expand parameter.","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"query","description":"Search query to filter by","name":"search","required":false,"type":"string"},{"in":"query","description":"Username to filter by","name":"userName","required":false,"type":"string"},{"in":"query","description":"Email to filter by","name":"email","required":false,"type":"string","pattern":"^(([^<>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z\\-0-9]{2,})|([a-zA-Z\\-0-9]+))$"},{"in":"query","description":"First name to filter by","name":"firstName","required":false,"type":"string"},{"in":"query","description":"Last name to filter by","name":"lastName","required":false,"type":"string"},{"in":"query","description":"Role ID to filter by","name":"roleId","required":false,"type":"string","pattern":"^[0-9a-fA-F]{24}$"},{"in":"query","description":"Group ID to filter by","name":"groupId","required":false,"type":"string","pattern":"(^[0-9a-fA-F]{24}$|^[Nn][Uu][Ll]{2}$)"},{"in":"query","description":"User state to filter by - `true` for active users, `false` for inactive users","name":"active","required":false,"type":"boolean"},{"in":"query","description":"User origin to filter by - `ad` for active directory or `sisense`","name":"origin","required":false,"type":"string","enum":["ad","sisense"]},{"in":"query","description":"Enter a tenantId to return only users from specified tenant.","name":"tenantId","required":false,"type":"string","pattern":"^[0-9a-fA-F]{24}$"},{"in":"query","description":"Array of user IDs to get, separated by a comma (`,`) and without spaces","name":"ids","required":false,"type":"array","collectionFormat":"csv","items":{"type":"string"}},{"name":"fields","in":"query","description":"Whitelist of fields to return for each document. fields Can also define which fields to exclude by prefixing field names with `-`","required":false,"type":"string"},{"name":"sort","in":"query","description":"Field by which the results should be sorted. Ascending by default, descending if prefixed by `-`","required":false,"type":"string"},{"name":"skip","in":"query","description":"Number of results to skip from the start of the data set. skip is to be used with the `limit` parameter for paging","required":false,"type":"integer","minimum":0},{"name":"limit","in":"query","description":"How many results should be returned. limit is to be used with the `skip` parameter for paging","required":false,"type":"integer","minimum":1},{"name":"expand","in":"query","description":"List of fields that should be expanded (substitures their IDs with actual objects). May be nested using the `resource.subResource` format","required":false,"type":"string"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]},"post":{"x-permission-type":"general","x-permission-path":"manage/users/add","x-middleware":["attachTenantIdToEntitiesWithUserTenant"],"x-roles-allowed":"tenantAdmin,admin","operationId":"addUser","summary":"Add a new user","description":"The *add user* endpoint receives a new user object and creates that user in Sisense, returning the created object.\n<br/>If a user with the same username or email exists, it will return an error.\n","tags":["users"],"responses":{"201":{"description":"No response was specified","schema":{"type":"object","properties":{"_id":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"email":{"type":"string","pattern":"^(([^<>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z\\-0-9]{2,})|([a-zA-Z\\-0-9]+))$"},"userName":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleId":{"type":"string"},"active":{"type":"boolean"},"groups":{"type":"array","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"}},"adgroups":{"type":"array","items":{"type":"string","pattern":"^\\[\\d{1,3}(?:,\\d{1,3}){27}\\]$"}},"activeDirectory":{"type":"boolean"},"principalName":{"type":"string"},"objectSid":{"type":"string"},"uSNChanged":{"type":"string"},"dn":{"type":"string"},"preferences":{"type":"object","properties":{"localeId":{"type":["string","null"]},"language":{"type":["string","null"]}}},"uiSettings":{"type":"object"},"created":{"type":"string","format":"date-time"},"lastLogin":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"},"ldapDomainId":{"type":"string"},"pendingExpiration":{"type":"string","format":"date-time"},"createdSso":{"type":"string"},"requireTwoFactorAuth":{"type":"boolean","default":false,"description":"Whether two-factor authentication is required for this user. If not provided, defaults to false for new users."}}}},"400":{"description":"- **2003** Mandatory fields are missing.\n- **2004** The user already exists.\n- **2006** Multiple super-users are not allowed.\n- **2007** Cannot add user because the license has been exceeded.\n- **2009** Mandatory fields cannot be empty.\n","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"},"404":{"description":"Role not found."},"422":{"description":"- **601** Invalid object ID.\n","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"Basic user object (in `JSON` notation) to be added","name":"user","required":true,"schema":{"type":"object","properties":{"email":{"type":"string","pattern":"^(([^<>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z\\-0-9]{2,})|([a-zA-Z\\-0-9]+))$"},"userName":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"groups":{"type":"array","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"}},"preferences":{"type":"object","properties":{"localeId":{"type":["string","null"]}}},"uiSettings":{"type":"object"},"requireTwoFactorAuth":{"type":"boolean","default":false,"description":"Whether two-factor authentication is required for this user. If not provided, defaults to false for new users."}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/users/ad":{"x-swagger-router-controller":"users.controller.v1","post":{"x-permission-type":"general","x-permission-path":"manage/users/add","x-middleware":["attachTenantIdToEntitiesWithUserTenant"],"x-roles-allowed":"tenantAdmin,admin","operationId":"addAdUser","summary":"Add a new Active Directory user","description":"The **add Active Directory user** endpoint receives an Active Directory user object, retrieves the user's details from Active Directory and adds it to the application.","tags":["users"],"responses":{"201":{"description":"No response was specified","schema":{"type":"object","properties":{"_id":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"email":{"type":"string","pattern":"^(([^<>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z\\-0-9]{2,})|([a-zA-Z\\-0-9]+))$"},"userName":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleId":{"type":"string"},"active":{"type":"boolean"},"groups":{"type":"array","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"}},"adgroups":{"type":"array","items":{"type":"string","pattern":"^\\[\\d{1,3}(?:,\\d{1,3}){27}\\]$"}},"activeDirectory":{"type":"boolean"},"principalName":{"type":"string"},"objectSid":{"type":"string"},"uSNChanged":{"type":"string"},"dn":{"type":"string"},"preferences":{"type":"object","properties":{"localeId":{"type":["string","null"]},"language":{"type":["string","null"]}}},"uiSettings":{"type":"object"},"created":{"type":"string","format":"date-time"},"lastLogin":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"},"ldapDomainId":{"type":"string"},"pendingExpiration":{"type":"string","format":"date-time"},"createdSso":{"type":"string"},"requireTwoFactorAuth":{"type":"boolean","default":false,"description":"Whether two-factor authentication is required for this user. If not provided, defaults to false for new users."}}}},"400":{"description":"- **2004** The user already exists.\n- **2006** Multiple super-users are not allowed.\n- **2007** Cannot add user because the license has been exceeded.\n- **2008** Cannot add a user that does not have a principal name in Active Directory.\n- **2009** Mandatory fields cannot be empty.\n","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"},"404":{"description":"Role not found.","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}},"422":{"description":"- **601** Invalid object ID.\n- **2003** Mandatory fields are missing.\n","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"Active Directory user object to be added","name":"adUser","required":true,"schema":{"type":"object","required":["userName","ldapDomainId"],"properties":{"userName":{"type":"string"},"ldapDomainId":{"type":"string"},"roleId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"groups":{"type":"array","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"}},"objectSid":{"type":"string","pattern":"^\\[\\d{1,3}(?:,\\d{1,3}){27}\\]$"},"preferences":{"type":"object","properties":{"localeId":{"type":["string","null"]}}},"uiSettings":{"type":"object"}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/users/bulk":{"x-swagger-router-controller":"users.controller.v1","post":{"x-permission-type":"general","x-permission-path":"manage/users/add","x-middleware":["attachTenantIdToEntitiesWithUserTenant"],"x-roles-allowed":"tenantAdmin,admin","operationId":"addUsers","summary":"Add several users at once","description":"The **bulk add** endpoint allows adding multiple users at once, by receiving an array of user objects whose structure is alike to the single **add user** endpoint.","tags":["users"],"responses":{"201":{"description":"No response was specified","schema":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","pattern":"^(([^<>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z\\-0-9]{2,})|([a-zA-Z\\-0-9]+))$"},"userName":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"groups":{"type":"array","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"}},"preferences":{"type":"object","properties":{"localeId":{"type":["string","null"]}}},"uiSettings":{"type":"object"},"requireTwoFactorAuth":{"type":"boolean","default":false,"description":"Whether two-factor authentication is required for this user. If not provided, defaults to false for new users."}}}}},"400":{"description":"- **2002** Invalid Users format. Users must be passed as an array.\n- **2004** One or more of the given users already exists.\n- **2005** The given users contain duplicates.\n- **2006** Multiple super-users are not allowed.\n- **2007** Cannot add user because the license has been exceeded.\n- **2009** Mandatory fields cannot be empty.\n","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"},"404":{"description":"Role not found.","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}},"422":{"description":"- **601** Invalid object ID.\n- **2003** Mandatory fields are missing.\n","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"A collection of basic user objects (in `JSON` notation) to be added","name":"users","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","pattern":"^(([^<>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z\\-0-9]{2,})|([a-zA-Z\\-0-9]+))$"},"userName":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"groups":{"type":"array","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"}},"preferences":{"type":"object","properties":{"localeId":{"type":["string","null"]}}},"uiSettings":{"type":"object"},"requireTwoFactorAuth":{"type":"boolean","default":false,"description":"Whether two-factor authentication is required for this user. If not provided, defaults to false for new users."}}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]},"patch":{"x-permission-type":"general","x-permission-path":"manage/users/modify","x-middleware":["attachTenantIdToEntitiesWithUserTenant"],"x-roles-allowed":"tenantAdmin,admin","operationId":"bulkUpdateUsers","summary":"Update several users at once","description":"Perform a partial update to multiple users at once. This endpoint works the same way as the `PATCH` operation for a single user, but receives an array of `JSON` objects, each with an `_id` and any fields that should be updated.","tags":["users"],"responses":{"200":{"description":"A collection of updated Users","schema":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","pattern":"^(([^<>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z\\-0-9]{2,})|([a-zA-Z\\-0-9]+))$"},"userName":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"groups":{"type":"array","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"}},"preferences":{"type":"object","properties":{"localeId":{"type":["string","null"]}}},"uiSettings":{"type":"object"},"requireTwoFactorAuth":{"type":"boolean","default":false,"description":"Whether two-factor authentication is required for this user. If not provided, defaults to false for new users."}}}}},"400":{"description":"- **2002** Invalid Users format. Users must be passed as an array.\n- **2005** The given users contain duplicates.\n- **2006** Multiple super-users are not allowed.\n- **2009** Mandatory fields cannot be empty.\n","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"},"422":{"description":"- **601** Invalid object ID.\n- **2003** Mandatory fields are missing.\n","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"Array of basic user objects (in `JSON` notation) to be updated","name":"users","required":true,"schema":{"type":"array","items":{"type":"object","required":["_id"],"properties":{"_id":{"type":"string"},"email":{"type":"string","pattern":"^(([^<>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z\\-0-9]{2,})|([a-zA-Z\\-0-9]+))$"},"userName":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"groups":{"type":"array","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"}},"preferences":{"type":"object","properties":{"localeId":{"type":["string","null"]}}},"uiSettings":{"type":"object"},"requireTwoFactorAuth":{"type":"boolean","default":false,"description":"Whether two-factor authentication is required for this user. If not provided, defaults to false for new users."}}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]},"delete":{"x-permission-type":"general","x-permission-path":"manage/users/remove","x-roles-allowed":"tenantAdmin,admin","operationId":"deleteUsers","summary":"Delete users","description":"The *delete users* endpoint receives users' ids and deletes these users in Sisense.\n<br/>If a user with the specified id is not exists, it will return an error.\n","tags":["users"],"responses":{"204":{"description":"No response was specified"},"400":{"description":"- **2011** A super-user cannot be deleted.\n"},"403":{"description":"User does not have permission"},"404":{"description":"- **2001** One or more users not found.\n"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"query","description":"Array of user IDs to get, separated by a comma (`,`) and without spaces","name":"ids","required":false,"type":"array","collectionFormat":"csv","items":{"type":"string"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/users/ad/bulk":{"x-swagger-router-controller":"users.controller.v1","post":{"x-permission-type":"general","x-permission-path":"manage/users/add","x-middleware":["attachTenantIdToEntitiesWithUserTenant"],"x-roles-allowed":"tenantAdmin,admin","operationId":"addAdUsers","summary":"Bulk add Active Directory users","description":"The **bulk add Active Directory user** endpoint receives an array of Active Directory user objects, retrieves the user's details from Active Directory and adds it to the application.","tags":["users"],"responses":{"201":{"description":"No response was specified","schema":{"type":"array","items":{"type":"object","required":["userName","ldapDomainId"],"properties":{"userName":{"type":"string"},"ldapDomainId":{"type":"string"},"roleId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"groups":{"type":"array","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"}},"objectSid":{"type":"string","pattern":"^\\[\\d{1,3}(?:,\\d{1,3}){27}\\]$"},"preferences":{"type":"object","properties":{"localeId":{"type":["string","null"]}}},"uiSettings":{"type":"object"}}}}},"400":{"description":"- **2002** Invalid Users format. Users must be passed as an array.\n- **2004** One or more of the given users already exists.\n- **2005** The given users contain duplicates.\n- **2006** Multiple super-users are not allowed.\n- **2007** Cannot add users because the license has been exceeded.\n- **2008** Cannot add a user that does not have a principal name in Active Directory.\n- **2009** Mandatory fields cannot be empty.\n","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"},"404":{"description":"Role not found.","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}},"422":{"description":"- **601** Invalid object ID.\n- **2003** Mandatory fields are missing.\n","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"Array of Active Directory user objects to be added","name":"adUsers","required":true,"schema":{"type":"array","items":{"type":"object","required":["userName","ldapDomainId"],"properties":{"userName":{"type":"string"},"ldapDomainId":{"type":"string"},"roleId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"groups":{"type":"array","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"}},"objectSid":{"type":"string","pattern":"^\\[\\d{1,3}(?:,\\d{1,3}){27}\\]$"},"preferences":{"type":"object","properties":{"localeId":{"type":["string","null"]}}},"uiSettings":{"type":"object"}}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/users/{id}":{"x-swagger-router-controller":"users.controller.v1","get":{"x-permission-type":"general","x-permission-path":"manage/users/get","x-roles-allowed":"tenantAdmin,admin","operationId":"getUser","summary":"Get a specific user","description":"The **get user by ID** endpoint retrieves a specific user object corresponding to the provided ID.<br/><br/>The expandable fields for the user object are `groups`, `adgroups` and `role`.","tags":["users"],"responses":{"200":{"description":"user","schema":{"type":"object","properties":{"_id":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"email":{"type":"string","pattern":"^(([^<>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z\\-0-9]{2,})|([a-zA-Z\\-0-9]+))$"},"userName":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleId":{"type":"string"},"active":{"type":"boolean"},"groups":{"type":"array","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"}},"adgroups":{"type":"array","items":{"type":"string","pattern":"^\\[\\d{1,3}(?:,\\d{1,3}){27}\\]$"}},"activeDirectory":{"type":"boolean"},"principalName":{"type":"string"},"objectSid":{"type":"string"},"uSNChanged":{"type":"string"},"dn":{"type":"string"},"preferences":{"type":"object","properties":{"localeId":{"type":["string","null"]},"language":{"type":["string","null"]}}},"uiSettings":{"type":"object"},"created":{"type":"string","format":"date-time"},"lastLogin":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"},"ldapDomainId":{"type":"string"},"pendingExpiration":{"type":"string","format":"date-time"},"createdSso":{"type":"string"},"requireTwoFactorAuth":{"type":"boolean","default":false,"description":"Whether two-factor authentication is required for this user. If not provided, defaults to false for new users."}}}},"403":{"description":"User does not have permission"},"404":{"description":"- **202** Invalid expand parameter.\n- **2001** User not found.\n","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"The ID of the user to get","name":"id","required":true,"type":"string","pattern":"^[0-9a-fA-F]{24}$"},{"name":"fields","in":"query","description":"Whitelist of fields to return for each document. fields Can also define which fields to exclude by prefixing field names with `-`","required":false,"type":"string"},{"name":"expand","in":"query","description":"List of fields that should be expanded (substitures their IDs with actual objects). May be nested using the `resource.subResource` format","required":false,"type":"string"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]},"patch":{"x-permission-type":"general","x-permission-path":"manage/users/modify","x-roles-allowed":"tenantAdmin,admin","operationId":"updateUser","summary":"Update a user","description":"The *update user* endpoint receives a user id and what fields to update, returning the updated object.\n<br/>If a user with the specified id is not exists, it will return an error.\n","tags":["users"],"responses":{"200":{"description":"user","schema":{"type":"object","properties":{"_id":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"email":{"type":"string","pattern":"^(([^<>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z\\-0-9]{2,})|([a-zA-Z\\-0-9]+))$"},"userName":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleId":{"type":"string"},"active":{"type":"boolean"},"groups":{"type":"array","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"}},"adgroups":{"type":"array","items":{"type":"string","pattern":"^\\[\\d{1,3}(?:,\\d{1,3}){27}\\]$"}},"activeDirectory":{"type":"boolean"},"principalName":{"type":"string"},"objectSid":{"type":"string"},"uSNChanged":{"type":"string"},"dn":{"type":"string"},"preferences":{"type":"object","properties":{"localeId":{"type":["string","null"]},"language":{"type":["string","null"]}}},"uiSettings":{"type":"object"},"created":{"type":"string","format":"date-time"},"lastLogin":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"},"ldapDomainId":{"type":"string"},"pendingExpiration":{"type":"string","format":"date-time"},"createdSso":{"type":"string"},"requireTwoFactorAuth":{"type":"boolean","default":false,"description":"Whether two-factor authentication is required for this user. If not provided, defaults to false for new users."}}}},"403":{"description":"User does not have permission"},"404":{"description":"- **2001** User not found.\n"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"The ID of the user to update","name":"id","required":true,"type":"string","pattern":"^[0-9a-fA-F]{24}$"},{"in":"body","description":"Partial user object (in `JSON` notation) containing the fields to update","name":"user","required":true,"schema":{"type":"object","properties":{"email":{"type":"string","pattern":"^(([^<>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z\\-0-9]{2,})|([a-zA-Z\\-0-9]+))$"},"userName":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"groups":{"type":"array","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"}},"preferences":{"type":"object","properties":{"localeId":{"type":["string","null"]}}},"uiSettings":{"type":"object"},"requireTwoFactorAuth":{"type":"boolean","default":false,"description":"Whether two-factor authentication is required for this user. If not provided, defaults to false for new users."}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]},"delete":{"x-permission-type":"general","x-permission-path":"manage/users/remove","x-roles-allowed":"tenantAdmin,admin","operationId":"deleteUser","summary":"Delete a user","description":"The *delete user* endpoint receives a user id and deletes that user in Sisense, returning the deleted object.\n<br/>If a user with the specified id is not exists, it will return an error.\n","tags":["users"],"responses":{"204":{"description":"No response was specified"},"400":{"description":"- **2011** A super-user cannot be deleted.\n"},"403":{"description":"User does not have permission"},"404":{"description":"- **2001** User not found.\n"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"The ID of the user to delete","name":"id","required":true,"type":"string","pattern":"^[0-9a-fA-F]{24}$"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/groups":{"x-swagger-router-controller":"groups.controller.v1","get":{"x-roles-allowed":"tenantAdmin,admin","x-permission-type":"general","x-permission-path":"manage/groups/get","operationId":"getGroups","summary":"Get groups","description":"The **get groups** endpoint returns a list of user groups with their details.<br/>The results can be filtered by different parameters such as group name or origin.<br/><br/>The expandable fields for the group object are `users` and `role`.","tags":["groups"],"responses":{"200":{"description":"An array of groups","schema":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"language":{"type":"string"},"mail":{"type":"string"},"ad":{"type":"boolean"},"roleId":{"type":"string","pattern":"(^[0-9a-fA-F]{24}$|^[Nn][Uu][Ll]{2}$)"},"defaultRole":{"type":"string"},"objectSid":{"type":"string","pattern":"^\\[\\d{1,3}(?:,\\d{1,3}){27}\\]$"},"dn":{"type":"string"},"uSNChanged":{"type":"string"},"created":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"themeId":{"type":"string"},"excludeFromSharing":{"type":"boolean","default":false}}}}},"403":{"description":"User does not have permission"},"404":{"description":"resource not found","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}}},"parameters":[{"in":"query","description":"Group name to filter by","name":"name","required":false,"type":"string"},{"in":"query","description":"Group email to filter by","name":"mail","required":false,"type":"string","pattern":"^(([^<>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z\\-0-9]{2,})|([a-zA-Z\\-0-9]+))$"},{"in":"query","description":"Group role ID to filter by","name":"roleId","required":false,"type":"string","pattern":"(^[0-9a-fA-F]{24}$|^[Nn][Uu][Ll]{2}$)"},{"in":"query","description":"Group origin to filter by (`ad` or `sisense`)","name":"origin","required":false,"type":"string","enum":["ad","sisense"]},{"in":"query","description":"Enter a tenantId to return only groups from specified tenant.","name":"tenantId","required":false,"type":"string"},{"in":"query","description":"Group IDs to filter by, separated by a comma (`,`) and without spaces","name":"ids","required":false,"type":"array","collectionFormat":"csv","items":{"type":"string"}},{"name":"fields","in":"query","description":"Whitelist of fields to return for each document. fields Can also define which fields to exclude by prefixing field names with `-`","required":false,"type":"string"},{"name":"sort","in":"query","description":"Field by which the results should be sorted. Ascending by default, descending if prefixed by `-`","required":false,"type":"string"},{"name":"skip","in":"query","description":"Number of results to skip from the start of the data set. skip is to be used with the `limit` parameter for paging","required":false,"type":"integer","minimum":0},{"name":"limit","in":"query","description":"How many results should be returned. limit is to be used with the `skip` parameter for paging","required":false,"type":"integer","minimum":1},{"name":"expand","in":"query","description":"List of fields that should be expanded (substitures their IDs with actual objects). May be nested using the `resource.subResource` format","required":false,"type":"string"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]},"post":{"x-roles-allowed":"tenantAdmin,admin","x-permission-type":"general","x-permission-path":"manage/groups/add","operationId":"addGroup","x-middleware":["attachTenantIdToEntitiesWithUserTenant"],"summary":"Add a new group","description":"The *add group* endpoint receives a new group object and creates that group in Sisense, returning the created object.\n<br/>If a group with the same name exists, it will return an error.\n","tags":["groups"],"responses":{"201":{"description":"No response was specified","schema":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"language":{"type":"string"},"mail":{"type":"string"},"ad":{"type":"boolean"},"roleId":{"type":"string","pattern":"(^[0-9a-fA-F]{24}$|^[Nn][Uu][Ll]{2}$)"},"defaultRole":{"type":"string"},"objectSid":{"type":"string","pattern":"^\\[\\d{1,3}(?:,\\d{1,3}){27}\\]$"},"dn":{"type":"string"},"uSNChanged":{"type":"string"},"created":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"themeId":{"type":"string"},"excludeFromSharing":{"type":"boolean","default":false}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"Basic group object (in `JSON` notation) to be added","name":"group","required":true,"schema":{"type":"object","properties":{"name":{"type":"string"},"excludeFromSharing":{"type":"boolean","default":false}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/groups/ad":{"x-swagger-router-controller":"groups.controller.v1","post":{"x-roles-allowed":"tenantAdmin,admin","x-permission-type":"general","x-permission-path":"manage/groups/add","operationId":"addAdGroup","x-middleware":["attachTenantIdToEntitiesWithUserTenant"],"summary":"Add a new Active Directory group","description":"The **add Active Directory group** endpoint receives an Active Directory groups object, retrieves the group's details from Active Directory and adds it to the application.","tags":["groups"],"responses":{"201":{"description":"No response was specified","schema":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"language":{"type":"string"},"mail":{"type":"string"},"ad":{"type":"boolean"},"roleId":{"type":"string","pattern":"(^[0-9a-fA-F]{24}$|^[Nn][Uu][Ll]{2}$)"},"defaultRole":{"type":"string"},"objectSid":{"type":"string","pattern":"^\\[\\d{1,3}(?:,\\d{1,3}){27}\\]$"},"dn":{"type":"string"},"uSNChanged":{"type":"string"},"created":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"themeId":{"type":"string"},"excludeFromSharing":{"type":"boolean","default":false}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"Active Directory group object to be added","name":"adGroup","required":true,"schema":{"type":"object","properties":{"name":{"type":"string"},"cn":{"type":"string"},"roleId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"objectSid":{"type":"string","pattern":"^\\[\\d{1,3}(?:,\\d{1,3}){27}\\]$"},"dn":{"type":"string"}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/groups/bulk":{"x-swagger-router-controller":"groups.controller.v1","post":{"x-roles-allowed":"tenantAdmin,admin","x-permission-type":"general","x-permission-path":"manage/groups/add","operationId":"addGroups","x-middleware":["attachTenantIdToEntitiesWithUserTenant"],"summary":"Add several groups at once","description":"The **bulk add** endpoint allows adding multiple groups at once, by receiving an array of group objects whose structure is alike to the single **add group** endpoint.","tags":["groups"],"responses":{"201":{"description":"No response was specified","schema":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"language":{"type":"string"},"mail":{"type":"string"},"ad":{"type":"boolean"},"roleId":{"type":"string","pattern":"(^[0-9a-fA-F]{24}$|^[Nn][Uu][Ll]{2}$)"},"defaultRole":{"type":"string"},"objectSid":{"type":"string","pattern":"^\\[\\d{1,3}(?:,\\d{1,3}){27}\\]$"},"dn":{"type":"string"},"uSNChanged":{"type":"string"},"created":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"themeId":{"type":"string"},"excludeFromSharing":{"type":"boolean","default":false}}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"A collection of basic group objects (in `JSON` notation) to be added","name":"groups","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"excludeFromSharing":{"type":"boolean","default":false}}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/groups/ad/bulk":{"x-swagger-router-controller":"groups.controller.v1","post":{"x-roles-allowed":"tenantAdmin,admin","x-permission-type":"general","x-permission-path":"manage/groups/add","operationId":"addAdGroups","x-middleware":["attachTenantIdToEntitiesWithUserTenant"],"summary":"Bulk add Active Directory groups","description":"The **bulk add Active Directory group** endpoint receives an array of Active Directory group objects, retrieves the group's details from Active Directory and adds it to the application.","tags":["groups"],"responses":{"201":{"description":"No response was specified","schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"cn":{"type":"string"},"roleId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"objectSid":{"type":"string","pattern":"^\\[\\d{1,3}(?:,\\d{1,3}){27}\\]$"},"dn":{"type":"string"}}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"Array of Active Directory user objects to be added","name":"adGroups","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"cn":{"type":"string"},"roleId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"objectSid":{"type":"string","pattern":"^\\[\\d{1,3}(?:,\\d{1,3}){27}\\]$"},"dn":{"type":"string"}}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/groups/count":{"x-swagger-router-controller":"groups.controller.v1","get":{"x-roles-allowed":"tenantAdmin,admin","x-permission-type":"general","x-permission-path":"manage/groups/get","operationId":"getGroupsCount","summary":"Get groups count","description":"The **get groups count** endpoint returns the amount of user groups matching the given filters.<br/>When no filter is given it returns the amount of all the groups the requesting user is allowed to see.","tags":["groups"],"responses":{"200":{"description":"Groups count","schema":{"type":"object","properties":{"count":{"type":"integer","description":"amount of groups matching the requested filters"}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"query","description":"Group name to filter by","name":"name","required":false,"type":"string"},{"in":"query","description":"Group email to filter by","name":"mail","required":false,"type":"string","pattern":"^(([^<>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z\\-0-9]{2,})|([a-zA-Z\\-0-9]+))$"},{"in":"query","description":"Group role ID to filter by","name":"roleId","required":false,"type":"string","pattern":"(^[0-9a-fA-F]{24}$|^[Nn][Uu][Ll]{2}$)"},{"in":"query","description":"Group origin to filter by (`ad` or `sisense`)","name":"origin","required":false,"type":"string","enum":["ad","sisense"]},{"in":"query","description":"Enter a tenantId to count only groups from specified tenant.","name":"tenantId","required":false,"type":"string"},{"in":"query","description":"Group IDs to filter by, separated by a comma (`,`) and without spaces","name":"ids","required":false,"type":"array","collectionFormat":"csv","items":{"type":"string"}},{"in":"query","description":"Exclude the groups that cannot be granted feature access — the system-wide `everyone` (\"All users in system\") and the per-tenant `tenantEveryone` (\"Everyone\"). Its one caller is the Feature Management picker, which drops the same two from the list client-side, so the total matches the rows it shows.","name":"excludeDerivedGroups","required":false,"type":"boolean"},{"in":"query","description":"Count only the groups whose name contains this term, case-insensitively — the same matching the v0.9 groups list applies to its `search` parameter, so the count agrees with those results. Split on `;` to pass several terms; a group counts if any term matches.","name":"search","required":false,"type":"string"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]}},"/groups/{id}":{"x-swagger-router-controller":"groups.controller.v1","get":{"x-roles-allowed":"tenantAdmin,admin","x-permission-type":"general","x-permission-path":"manage/groups/get","operationId":"getGroup","summary":"Get a specific group","description":"The **get  group by id** endpoint returns the details of the user group corresponding to the `id` parameter.<br/><br/>The expandable fields for the group object are `users` and `role`.","tags":["groups"],"responses":{"200":{"description":"Group details","schema":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"language":{"type":"string"},"mail":{"type":"string"},"ad":{"type":"boolean"},"roleId":{"type":"string","pattern":"(^[0-9a-fA-F]{24}$|^[Nn][Uu][Ll]{2}$)"},"defaultRole":{"type":"string"},"objectSid":{"type":"string","pattern":"^\\[\\d{1,3}(?:,\\d{1,3}){27}\\]$"},"dn":{"type":"string"},"uSNChanged":{"type":"string"},"created":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"themeId":{"type":"string"},"excludeFromSharing":{"type":"boolean","default":false}}}},"403":{"description":"User does not have permission"},"404":{"description":"resource not found","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}}},"parameters":[{"in":"path","description":"The ID of the group to get.","name":"id","required":true,"type":"string","pattern":"^[0-9a-fA-F]{24}$"},{"name":"fields","in":"query","description":"Whitelist of fields to return for each document. fields Can also define which fields to exclude by prefixing field names with `-`","required":false,"type":"string"},{"name":"expand","in":"query","description":"List of fields that should be expanded (substitures their IDs with actual objects). May be nested using the `resource.subResource` format","required":false,"type":"string"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]},"delete":{"x-roles-allowed":"tenantAdmin,admin","x-permission-type":"general","x-permission-path":"manage/groups/remove","operationId":"removeGroup","summary":"Delete a specific group","description":"The **delete group by id** endpoint removes the group corresponding to the `id` parameter.","tags":["groups"],"responses":{"204":{"description":"Delete operation was successfull"},"403":{"description":"User does not have permission"},"404":{"description":"resource not found","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"The ID of the group to remove.","name":"id","required":true,"type":"string","pattern":"^[0-9a-fA-F]{24}$"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/groups/reassign-themes":{"x-swagger-router-controller":"groups.controller.v1","post":{"x-permission-type":"admins-only","operationId":"reassignTheme","summary":"Reassign themes","description":"Reassign all groups assigned to the old theme (`from`) to the new theme (`to`)","tags":["groups"],"responses":{"200":{"description":"Update info (how much groups were affected)","schema":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string","description":"old theme object id (oid)"},"to":{"type":"string","description":"new theme object id (oid)"},"affectedGroups":{"type":"integer","description":"amount of affected groups"}}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","name":"themes","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","example":"themeOid","description":"old theme object id (oid)"},"to":{"type":"string","example":"themeOid","pattern":"^[0-9a-fA-F]{24}$","description":"new theme object id (oid)"}}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/account/begin_reset_password":{"x-swagger-router-controller":"account.controller.v1","x-permission-type":"noAuthentication","post":{"x-skip-auth":true,"operationId":"beginResetPassword","summary":"Begin reset password process","description":"The **begin reset password** endpoint is the starting point for the password reset process.\nIt generates a temporary *password reset token* for the user associated with the provided email address and sends a password reset email to him.\n","responses":{"204":{"description":"email successfuly sent"},"403":{"description":"User does not have permission"},"404":{"description":"invalid email","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"tags":["account"],"parameters":[{"in":"body","description":"identity of the user who's password to reset","name":"identityObject","required":true,"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string"},"tenant":{"type":"string"}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]}},"/account/reset_password/{token}":{"x-swagger-router-controller":"account.controller.v1","x-permission-type":"noAuthentication","get":{"x-skip-auth":true,"operationId":"getUserNameForResetPassword","summary":"Validate password reset token","description":"The **validate password reset token** endpoint receives the temporary _password reset token_ generated by `begin_reset_password`\nand either returns the username of the user who's password will be reset, or an error if the token is invalid, for example if it was already used.\n","responses":{"200":{"description":"Reset token is valid","schema":{"type":"object","required":["userName"],"properties":{"userName":{"type":"string"}}}},"403":{"description":"User does not have permission"},"404":{"description":"Reset token is invalid","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"tags":["account"],"parameters":[{"in":"path","description":"The temporary password reset token","name":"token","required":true,"type":"string"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]},"post":{"x-skip-auth":true,"responses":{"204":{"description":"Password was reset successfuly"},"403":{"description":"User does not have permission"},"404":{"description":"Reset token is invalid","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"tags":["account"],"operationId":"resetPassword","summary":"Finalize password reset","description":"The **reset password** endpoint receives the *reset password token* and a new password and updates the user's password accordingly.","parameters":[{"in":"path","description":"The temporary password reset token","name":"token","required":true,"type":"string"},{"in":"body","description":"The new password","name":"passwordObject","required":true,"schema":{"type":"object","required":["password"],"properties":{"password":{"type":"string"}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]}},"/account/change_password":{"x-swagger-router-controller":"account.controller.v1","x-permission-type":"none","post":{"responses":{"204":{"description":"Password was changed successfuly"},"403":{"description":"User does not have permission"},"404":{"description":"invalid password","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"tags":["account"],"operationId":"changePassword","summary":"Change password","description":"The **change password** endpoint updates user's password.","parameters":[{"in":"body","description":"The current password","name":"passwordsObject","required":true,"schema":{"type":"object","required":["currentPassword","newPassword"],"properties":{"currentPassword":{"type":"string"},"newPassword":{"type":"string"}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]}},"/account/activate/{token}":{"x-swagger-router-controller":"account.controller.v1","x-permission-type":"noAuthentication","get":{"x-skip-auth":true,"responses":{"200":{"description":"Token validated","schema":{"type":"object","required":["userName"],"properties":{"userName":{"type":"string"}}}},"403":{"description":"User does not have permission"},"404":{"description":"Provided token is invalid","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"summary":"Validate activation token","description":"The **validate activation token** endpoint receives the temporary _activation token_ generated by `begin_activate`\nand either returns the username and language of the user to be activated, or an error if the token is invalid,\nfor example if it was already used. Note, that language is selected by language startegy: user's language,\ngroup's language, admin selected language, default Sisense language\n","tags":["account"],"operationId":"getUserDataForActivation","parameters":[{"in":"path","description":"The user's activation token.","name":"token","required":true,"type":"string"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]},"post":{"x-skip-auth":true,"responses":{"204":{"description":"User activated successfully"},"403":{"description":"User does not have permission"},"404":{"description":"Invalid activation token","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"description":"The **activate** endpoint receives the *activation token* and a new password and updates the user's password accordingly.","tags":["account"],"summary":"Activate user","operationId":"activateUser","parameters":[{"in":"path","description":"The user's activation token.","name":"token","required":true,"type":"string"},{"in":"body","description":"The new password","name":"passwordObject","required":true,"schema":{"type":"object","required":["password"],"properties":{"password":{"type":"string"}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]}},"/account/begin_activate":{"x-swagger-router-controller":"account.controller.v1","post":{"x-permission-type":"general","x-permission-path":"manage/users/add","responses":{"204":{"description":"email successfuly sent"},"403":{"description":"User does not have permission"},"404":{"description":"invalid email","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"summary":"Begin user activation","description":"The **begin activation** endpoint is the starting point for the user activation process.\nIt generates a temporary *activation token* for the user associated with the provided email address and sends an activation email to him.\n","tags":["account"],"operationId":"beginActivate","parameters":[{"in":"body","description":"Email of the user to activate","name":"emailObj","required":true,"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","pattern":"^(([^<>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z\\-0-9]{2,})|([a-zA-Z\\-0-9]+))$"}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]}},"/account/begin_activate_bulk":{"x-swagger-router-controller":"account.controller.v1","post":{"x-permission-type":"general","x-permission-path":"manage/users/add","responses":{"204":{"description":"email successfuly sent"},"403":{"description":"User does not have permission"},"404":{"description":"invalid email","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"tags":["account"],"summary":"Bulk begin user activation","description":"The **bulk begin activation** endpoint is the starting point for the user activation process when activating multiple users.\nIt generates a temporary *activation token* for the users associated with the provided email addresses and sends an activation email to them.\n","operationId":"beginActivateBulk","parameters":[{"in":"body","description":"The list of emails of users to activate","name":"emailList","required":true,"schema":{"type":"array","items":{"type":"string","pattern":"^(([^<>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z\\-0-9]{2,})|([a-zA-Z\\-0-9]+))$"}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]}},"/account/get_license_info":{"x-swagger-router-controller":"account.controller.v1","x-permission-type":"admins-only","x-roles-allowed":"admin,super,tenantAdmin","get":{"responses":{"200":{"description":"success","schema":{"type":"object","properties":{"bigData":{"type":"boolean"},"expirationDate":{"type":"string"},"highAvailability":{"type":"boolean"},"inUseAdmins":{"type":"integer"},"inUseDesigners":{"type":"integer"},"inUseViewers":{"type":"integer"},"maxAdmins":{"type":"integer"},"maxDesigners":{"type":"integer"},"maxViewers":{"type":"integer"},"macine":{"type":"string"},"trial":{"type":"boolean"}}}},"403":{"description":"User does not have permission"}},"summary":"License Information","description":"Gets the License information\n","tags":["account"],"operationId":"getLicenseInfo","parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]}},"/account/set_new_license":{"x-swagger-router-controller":"account.controller.v1","x-permission-type":"admins-only","post":{"responses":{"200":{"description":"success","schema":{"type":"object","properties":{"bigData":{"type":"boolean"},"expirationDate":{"type":"string"},"highAvailability":{"type":"boolean"},"inUseAdmins":{"type":"integer"},"inUseDesigners":{"type":"integer"},"inUseViewers":{"type":"integer"},"maxAdmins":{"type":"integer"},"maxDesigners":{"type":"integer"},"maxViewers":{"type":"integer"},"macine":{"type":"string"},"trial":{"type":"boolean"}}}},"400":{"description":"Missing arguments","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"401":{"description":"Invalid credentials","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}},"summary":"License Information","description":"Sets a new license\n","tags":["account"],"operationId":"setNewLicense","parameters":[{"in":"body","description":"Set license credentials","name":"credentials","required":true,"schema":{"type":"object"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]}},"/account/set_offline_license":{"x-swagger-router-controller":"account.controller.v1","x-permission-type":"admins-only","post":{"responses":{"200":{"description":"success","schema":{"type":"object","properties":{"bigData":{"type":"boolean"},"expirationDate":{"type":"string"},"highAvailability":{"type":"boolean"},"inUseAdmins":{"type":"integer"},"inUseDesigners":{"type":"integer"},"inUseViewers":{"type":"integer"},"maxAdmins":{"type":"integer"},"maxDesigners":{"type":"integer"},"maxViewers":{"type":"integer"},"macine":{"type":"string"},"trial":{"type":"boolean"}}}},"400":{"description":"Missing arguments","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"401":{"description":"Invalid credentials","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}},"summary":"License Information","description":"Sets a new license\n","tags":["account"],"operationId":"setOfflineLicense","parameters":[{"in":"body","description":"Set offline license credentials","name":"credentials","required":true,"schema":{"type":"object"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]}},"/account/lockout_status/{user_id}":{"x-swagger-router-controller":"account.controller.v1","x-permission-type":"admins-only","x-roles-allowed":"tenantAdmin,admin","get":{"operationId":"getLockoutStatus","parameters":[{"in":"path","description":"Get user account status info","name":"user_id","required":true,"type":"string"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"object","properties":{"blocked":{"type":"boolean"},"blockedUntil":{"type":"string"}}}},"403":{"description":"User does not have permission"},"404":{"description":"invalid user id","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}}}},"/account/remove_lockout/{user_id}":{"x-swagger-router-controller":"account.controller.v1","x-permission-type":"admins-only","post":{"operationId":"unblockUser","parameters":[{"in":"path","description":"Unblocks user account","name":"user_id","required":true,"type":"string"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}],"responses":{"204":{"description":"success"},"403":{"description":"User does not have permission"},"404":{"description":"invalid user id","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}}}},"/authentication/login":{"x-swagger-router-controller":"authentication.controller.v1","x-permission-type":"noAuthentication","post":{"consumes":["application/x-www-form-urlencoded","application/json"],"responses":{"200":{"description":"Authentication token","schema":{"type":"object","required":["success","message","access_token","profile"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"access_token":{"type":"string"},"profile":{"type":"object"}}}},"401":{"description":"Unathorized: Invalid credentials. Wrong username, password or tenant name.","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}},"summary":"Authenticate","description":"Authenticates the provided user credentials and returns a user API token.\n","tags":["authentication"],"operationId":"login","parameters":[{"in":"header","description":"The device id.","name":"x-device-id","required":false,"type":"string"},{"in":"formData","description":"User's username or email","name":"username","required":true,"type":"string"},{"in":"formData","description":"User's password in plain text","name":"password","required":true,"type":"string"},{"in":"formData","description":"Tenant name in plain text (if multitenancy is enabled)","name":"tenant","required":false,"type":"string"},{"in":"formData","description":"User's locale, as ISO language code (See [table](http://www.lingoes.net/en/translator/langcode.htm))","name":"localeId","required":false,"type":"string"},{"in":"formData","description":"When true, generates a short-lived opaque bootstrap code stored server-side (returned as bootstrapCode) for use with the support-session GET redirect flow","name":"bootstrapMode","required":false,"type":"boolean"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/authentication/logout":{"x-swagger-router-controller":"authentication.controller.v1","x-permission-type":"none","get":{"responses":{"200":{"description":"Log out was perfomed successfully. The API token has been revoked."},"401":{"description":"Unauthorized: Invalid API token.","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}},"summary":"Revoke my session token","description":"Revokes the current user's session token. This operation will log you out.","tags":["authentication"],"operationId":"logout","parameters":[{"in":"header","description":"The device id.","name":"x-device-id","required":false,"type":"string"},{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"query","description":"Specific Device ID who's token to revoke. If not provided, the user's API token will be revoked.","name":"targetDevice","required":false,"type":"string"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/authentication/logout_all":{"x-swagger-router-controller":"authentication.controller.v1","x-permission-type":"none","get":{"responses":{"204":{"description":"Logout all was performed successfully. All user's tokens have been revoked."},"401":{"description":"Unauthorized: Invalid API token.","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}},"summary":"Revoke all my tokens","description":"Revoke's all of the current user's tokens, including SSO. This operation will log you out.","tags":["authentication"],"operationId":"logoutAll","parameters":[{"in":"header","description":"The device id.","name":"x-device-id","required":false,"type":"string"},{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/authentication/admin/logout_all_users":{"x-swagger-router-controller":"authentication.controller.v1","x-permission-type":"admins-only","post":{"responses":{"204":{"description":"Logout all was performed successfully. All user's tokens have been revoked."},"401":{"description":"Unauthorized: Invalid API token.","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}},"summary":"Revoke all user tokens","description":"Revokes all types of tokens for ALL USERS. This operation will log out all users.","tags":["authentication"],"operationId":"logoutAllUsers","parameters":[{"in":"header","description":"The device id.","name":"x-device-id","required":false,"type":"string"},{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"empty object.","name":"empty","required":false,"schema":{"type":"object"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/authentication/admin/logout":{"x-swagger-router-controller":"authentication.controller.v1","x-permission-type":"admins-only","x-roles-allowed":"tenantAdmin,admin","get":{"responses":{"204":{"description":"Tokens revoked successfuly"},"401":{"description":"Invalid token","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}},"description":"Revokes a specified user's session token, logging them out.","tags":["authentication"],"summary":"Revoke a user's session token","operationId":"logoutUsers","parameters":[{"in":"header","description":"The device id.","name":"x-device-id","required":false,"type":"string"},{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"query","description":"User IDs who's tokens to revoke, separated by a comma (`,`) and without spaces","name":"users","required":true,"type":"array","collectionFormat":"csv","items":{"type":"string"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/authentication/admin/tokens/{tokenType}":{"x-swagger-router-controller":"authentication.controller.v1","x-permission-type":"admins-only","delete":{"responses":{"204":{"description":"API token revoked successfuly"},"401":{"description":"Invalid token","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}},"description":"Revokes a specific token type for the specified user.","tags":["authentication"],"summary":"Revoke a user's specific token","operationId":"revokeTokens","parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"Token type to revoke","name":"tokenType","required":true,"type":"string","enum":["api","odbc","sso"]},{"in":"query","description":"User IDs who's tokens to revoke, separated by a comma (`,`) and without spaces","name":"users","required":true,"type":"array","collectionFormat":"csv","items":{"type":"string"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/authentication/server_access":{"x-swagger-router-controller":"authentication.controller.v1","get":{"x-permission-type":"admins-only","operationId":"getAllServersAccess","summary":"Get a list of trusted servers","description":"The **get all servers access** endpoint returns a list of trusted servers that can copy dashboards to your server.","tags":["authentication"],"responses":{"200":{"description":"An array of trusted servers"},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]},"post":{"x-permission-type":"admins-only","operationId":"addServerAccess","summary":"Add a trusted server","description":"The **add server access** endpoint add trusted server.","tags":["authentication"],"responses":{"200":{"description":"The added server"},"400":{"description":"Server Already Exists","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"The server object (in `JSON` notation) to be added to the Trusted Server list.","name":"serverAccess","required":true,"schema":{"type":"object","required":["serverName"],"properties":{"serverName":{"type":"string"},"name":{"type":"string"}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/authentication/server_access/{id}":{"x-swagger-router-controller":"authentication.controller.v1","patch":{"x-permission-type":"admins-only","operationId":"editServerAccess","summary":"Edit a trusted server","description":"The **patch servers access** endpoint edits a trusted server by its ID. You can revtrive the ID throught the **get servers access** endpoint.","tags":["authentication"],"responses":{"200":{"description":"No response was specified"},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"The ID if the trusted server.","name":"id","required":true,"type":"string"},{"in":"body","description":"The server object (in `JSON` notation) to be edited in the Trusted Server list.","name":"serverAccess","required":true,"schema":{"type":"object","required":["serverName"],"properties":{"serverName":{"type":"string"},"name":{"type":"string"}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]},"delete":{"x-permission-type":"admins-only","operationId":"deleteServerAccess","summary":"Remove a trusted server's access","description":"The **delete servers access** endpoint removes a trusted server from the Trusted Server Access list.","tags":["authentication"],"responses":{"200":{"description":"No response was specified"},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"The ID of the trusted server.","name":"id","required":true,"type":"string"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/authentication/tokens/api":{"x-swagger-router-controller":"authentication.controller.v1","x-permission-type":"authenticate","get":{"responses":{"200":{"description":"API token successfully retrieved","schema":{"type":"object","properties":{"token":{"type":"string","description":"API token"},"notification":{"type":"string","description":"expiration token notification"}}}},"401":{"description":"Unauthorized","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"},"500":{"description":"Server error"}},"summary":"Get API token","description":"Get the current user's API token","operationId":"getApiToken","tags":["authentication"],"parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]}},"/authentication/tokens/api/renew":{"x-swagger-router-controller":"authentication.controller.v1","x-permission-type":"authenticate","post":{"responses":{"200":{"description":"API token successfully renewed","schema":{"type":"object","properties":{"token":{"type":"string","description":"API token"},"notification":{"type":"string","description":"expiration token notification"}}}},"401":{"description":"Unauthorized","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"},"500":{"description":"Server error"}},"summary":"Renew API token","description":"Revoke the current user's API token and generate a new one","operationId":"renewApiToken","parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"tags":["authentication"]}},"/authentication/sessions":{"x-swagger-router-controller":"authentication.controller.v1","get":{"x-permission-type":"authenticate","operationId":"getUserSessions","summary":"Get current user sessions","description":"Get list of all active sessions for the current user","tags":["authentication"],"responses":{"200":{"description":"list of active sessions","schema":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"string","description":"current user Id"}}}}},"401":{"description":"Unauthorized","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]}},"/oauth/{service}/auth":{"x-swagger-router-controller":"oauth.controller.v1","post":{"x-permission-type":"data-admins-only","operationId":"authService","summary":"Returns tokens needed for oauth","description":"The **authorize** endpoint returns tokens for specific client code.\n","produces":["application/json"],"tags":["oauth"],"responses":{"200":{"description":"Tokens","schema":{"type":"object"}},"403":{"description":"User does not have permission"},"404":{"description":"Api not found.","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"The name of service","name":"service","required":true,"type":"string"},{"in":"body","description":"contains code and redirectUri parameters.","name":"body","required":true,"schema":{"type":"object","properties":{"code":{"type":"string"},"redirectUri":{"type":"string"}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/oauth/{service}/login_uri":{"x-swagger-router-controller":"oauth.controller.v1","get":{"x-permission-type":"admins-only","operationId":"getLoginUri","summary":"Returns basic redirect url for OAuth login endpoint","description":"The **get login uri** endpoint returns uri for service login without redirect_uri param. It should be generated at client side.\n","produces":["application/json"],"tags":["oauth"],"responses":{"200":{"description":"url","schema":{"type":"object"}},"403":{"description":"User does not have permission"},"404":{"description":"Api not found.","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"The name of service","name":"service","required":true,"type":"string"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/ldap_domains":{"x-swagger-router-controller":"ldapDomains.controller.v1","get":{"x-permission-type":"general","x-permission-path":"manage/activedirectory","x-roles-allowed":"tenantAdmin,admin","operationId":"getLdapDomains","summary":"Get LDAP domains","description":"The **get LDAP domains** endpoint returns a list of ldapDomains with their details.\n<br/>Results can be filtered by parameters such as name and enabled.\n<br/><br/>The expandable field for the LDAP domain object is `users`.\n","tags":["ldap domains"],"responses":{"200":{"description":"An array of LDAP domains","schema":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"enabled":{"type":"boolean"},"url":{"type":"string"},"baseDN":{"type":"string"},"username":{"type":"string"},"name":{"type":"string"},"syncUsn":{"type":"string"},"syncActive":{"type":"boolean"},"forceSyncEnabled":{"type":"boolean"},"syncInterval":{"type":"integer"},"sslEnabled":{"type":"boolean"}}}}},"403":{"description":"User does not have permission"},"404":{"description":"Invalid expand parameter.","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"query","description":"name to filter the LDAP domains returned by","name":"name","required":false,"type":"string"},{"in":"query","description":"Filter LDAP domains according to their status enabled or disabled","name":"enabled","required":false,"type":"boolean"},{"in":"query","description":"Array of LDAP domains IDs to get, separated by a comma (`,`) and without spaces","name":"ids","required":false,"type":"array","collectionFormat":"csv","items":{"type":"string"}},{"name":"fields","in":"query","description":"Whitelist of fields to return for each document. fields Can also define which fields to exclude by prefixing field names with `-`","required":false,"type":"string"},{"name":"sort","in":"query","description":"Field by which the results should be sorted. Ascending by default, descending if prefixed by `-`","required":false,"type":"string"},{"name":"skip","in":"query","description":"Number of results to skip from the start of the data set. skip is to be used with the `limit` parameter for paging","required":false,"type":"integer","minimum":0},{"name":"limit","in":"query","description":"How many results should be returned. limit is to be used with the `skip` parameter for paging","required":false,"type":"integer","minimum":1},{"name":"expand","in":"query","description":"List of fields that should be expanded (substitures their IDs with actual objects). May be nested using the `resource.subResource` format","required":false,"type":"string"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]},"post":{"x-permission-type":"general","x-permission-path":"manage/activedirectory","x-roles-allowed":"tenantAdmin,admin","operationId":"addLdapDomain","x-middleware":["attachTenantIdToEntitiesWithUserTenant"],"summary":"Add a new LDAP Domain","description":"The *add LDAP Domain* endpoint receives a new LDAP Domain object and creates that domain in Sisense, returning the created object.\n<br/>If a domain with the same name or baseDN exists, Sisense returns an error.\n","tags":["ldap domains"],"responses":{"201":{"description":"No response was specified","schema":{"type":"object","properties":{"_id":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"enabled":{"type":"boolean"},"url":{"type":"string"},"baseDN":{"type":"string"},"username":{"type":"string"},"name":{"type":"string"},"syncUsn":{"type":"string"},"syncActive":{"type":"boolean"},"forceSyncEnabled":{"type":"boolean"},"syncInterval":{"type":"integer"},"sslEnabled":{"type":"boolean"}}}},"400":{"description":"- **2004** The user already exists.\n- **2006** Multiple super-users are not allowed.\n- **2007** Cannot add user because the license has been exceeded.\n- **2009** Mandatory fields cannot be empty.\n","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"},"422":{"description":"- **601** Invalid object ID.\n- **2003** Mandatory fields are missing.\n","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"Basic LDAP domain object (in `JSON` notation) to be added","name":"ldapDomain","required":true,"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"url":{"type":"string","pattern":"^ldap|ldaps\\:\\/\\/.+"},"baseDN":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"name":{"type":"string"},"syncActive":{"type":"boolean"},"syncInterval":{"type":"integer"},"forceSyncEnabled":{"type":"boolean"},"sslEnabled":{"type":"boolean"},"pfxCertificate":{"type":"string"},"pfxKey":{"type":"string"}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/ldap_domains/{id}":{"x-swagger-router-controller":"ldapDomains.controller.v1","get":{"x-permission-type":"general","x-permission-path":"manage/activedirectory","x-roles-allowed":"tenantAdmin,admin","operationId":"getLdapDomain","summary":"Get a specific LDAP domain","description":"The **get LDAP domain by ID** endpoint retrieves a specific LDAP domain object corresponding to the provided ID.<br/><br/>The expandable fields for the LDAP domain object is `users`.","tags":["ldap domains"],"responses":{"200":{"description":"LDAP domain","schema":{"type":"object","properties":{"_id":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"enabled":{"type":"boolean"},"url":{"type":"string"},"baseDN":{"type":"string"},"username":{"type":"string"},"name":{"type":"string"},"syncUsn":{"type":"string"},"syncActive":{"type":"boolean"},"forceSyncEnabled":{"type":"boolean"},"syncInterval":{"type":"integer"},"sslEnabled":{"type":"boolean"}}}},"403":{"description":"User does not have permission"},"404":{"description":"- **202** Invalid expand parameter.\n- **22001** LDAP domain not found.\n","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"The ID of the LDAP domain to get","name":"id","required":true,"type":"string","pattern":"^[0-9a-fA-F]{24}$"},{"name":"fields","in":"query","description":"Whitelist of fields to return for each document. fields Can also define which fields to exclude by prefixing field names with `-`","required":false,"type":"string"},{"name":"expand","in":"query","description":"List of fields that should be expanded (substitures their IDs with actual objects). May be nested using the `resource.subResource` format","required":false,"type":"string"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]},"patch":{"x-permission-type":"general","x-permission-path":"manage/activedirectory","x-roles-allowed":"tenantAdmin,admin","operationId":"updateLdapDomain","summary":"Update a LDAP Domain","description":"The *update LDAP Domain* endpoint receives a domain id and what fields to update, returning the updated object.\n<br/>If a domain with the specified id is not exists, Sisense returns an error.\n","tags":["ldap domains"],"responses":{"200":{"description":"LDAP Domain","schema":{"type":"object","properties":{"_id":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"enabled":{"type":"boolean"},"url":{"type":"string"},"baseDN":{"type":"string"},"username":{"type":"string"},"name":{"type":"string"},"syncUsn":{"type":"string"},"syncActive":{"type":"boolean"},"forceSyncEnabled":{"type":"boolean"},"syncInterval":{"type":"integer"},"sslEnabled":{"type":"boolean"}}}},"403":{"description":"User does not have permission"},"404":{"description":"- **2001** User not found.\n"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"The ID of the domain to update","name":"id","required":true,"type":"string","pattern":"^[0-9a-fA-F]{24}$"},{"in":"body","description":"Partial LDAP Domain object (in `JSON` notation) containing the fields to update","name":"ldapDomain","required":true,"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"url":{"type":"string","pattern":"^ldap|ldaps\\:\\/\\/.+"},"baseDN":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"name":{"type":"string"},"syncActive":{"type":"boolean"},"syncInterval":{"type":"integer"},"forceSyncEnabled":{"type":"boolean"},"sslEnabled":{"type":"boolean"},"pfxCertificate":{"type":"string"},"pfxKey":{"type":"string"}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/ldap_domains/bulk":{"x-swagger-router-controller":"ldapDomains.controller.v1","delete":{"x-permission-type":"general","x-permission-path":"manage/activedirectory","x-roles-allowed":"tenantAdmin,admin","operationId":"deleteLdapDomains","summary":"Delete LDAP Domains","description":"The *delete LDAP Domains* endpoint receives a list of domain IDs and deletes these domains in Sisense.\n<br/>If a domain with the specified id does not exists, Sisense returns an error.\n","tags":["ldap domains"],"responses":{"204":{"description":"No response was specified"},"403":{"description":"User does not have permission"},"404":{"description":"- **22001** One or more LDAP domains were not found.\n"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"query","description":"Array of LDAP domain IDs to delete, separated by a comma (`,`) and without spaces","name":"ids","required":false,"type":"array","collectionFormat":"csv","items":{"type":"string"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/ldap_domains/test":{"x-swagger-router-controller":"ldapDomains.controller.v1","post":{"x-permission-type":"general","x-permission-path":"manage/activedirectory","x-roles-allowed":"tenantAdmin,admin","operationId":"testLdapDomain","summary":"Test LDAP domain","description":"The *test LDAP Domain* endpoint receives an LDAP Domain object and tests it against the LDAP server.\n<br/>If the LDAP server is not responding / wrong cradentails were sent, Sisense will return an error.\n","tags":["ldap domains"],"responses":{"204":{"description":"No response was specified"},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"Basic LDAP domain object (in `JSON` notation) to be tested","name":"ldapDomain","required":true,"schema":{"type":"object","properties":{"_id":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"url":{"type":"string","pattern":"^ldap|ldaps\\:\\/\\/.+"},"baseDN":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"sslEnabled":{"type":"boolean"},"pfxCertificate":{"type":"string"},"pfxKey":{"type":"string"}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/ldap_domains/{id}/sync":{"x-swagger-router-controller":"ldapDomains.controller.v1","post":{"x-permission-type":"general","x-permission-path":"manage/activedirectory","x-roles-allowed":"tenantAdmin,admin","operationId":"syncLdapDomain","summary":"Sync LDAP domain","description":"The *sync LDAP Domain* endpoint receives an LDAP Domain ID and synchronize it against the LDAP server.\n<br/>If a the LDAP server is not responding, Sisense will return an error.\n","tags":["ldap domains"],"responses":{"204":{"description":"No response was specified"},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"The ID of the domain to update","name":"id","required":true,"type":"string","pattern":"^[0-9a-fA-F]{24}$"},{"in":"query","description":"should wait","name":"wait","required":false,"type":"boolean"},{"in":"body","description":"other parameters for the synchronization request","name":"ldapDomainSync","required":false,"schema":{"type":"object","properties":{"force":{"description":"indicates if to sync all the changes from the Active Directory server since it was created","type":"boolean","default":false},"gnames":{"description":"groups to sync","type":"array","uniqueItems":true,"default":[],"items":{"type":"string"}},"unames":{"description":"users to sync","type":"array","uniqueItems":true,"default":[],"items":{"type":"string"}}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/tenants":{"x-swagger-router-controller":"tenants.controller.v1","x-permission-type":"admins-only","get":{"x-mt-visible":true,"operationId":"getTenants","summary":"Get tenants","description":"The **get tenants** endpoint returns a list of tenatns.","tags":["tenants"],"responses":{"200":{"description":"An array of tenants","schema":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"name":{"type":"string"},"default":{"type":"boolean"},"shouldCreateSamples":{"type":"boolean"},"defaultDataGroupId":{"type":"string"}}}}},"403":{"description":"User does not have permission"},"404":{"description":"Not found.","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"query","description":"Enter a search query to return results matching the query. You can add multiple search values separated by a comma delimiter ','","name":"search","required":false,"type":"string"},{"in":"query","description":"Limits the result set to a defined number of results.","name":"limit","required":false,"type":"integer","format":"int32"},{"in":"query","description":"Defines how many items to skip before returning the results.","name":"skip","required":false,"type":"integer","format":"int32"},{"in":"query","description":"Orders the results by field name. You can add multiple sort fields separated by a comma delimiter ','","name":"orderby","required":false,"type":"string"},{"in":"query","description":"Defines the order of the results. True returns results in a descending order.","name":"desc","required":false,"type":"boolean","enum":[false,true]},{"in":"query","description":"Tenants info with users, groups, dashboards, roles count.","name":"tenantsInfo","required":false,"type":"boolean","enum":[false,true]},{"in":"query","description":"Tenant IDs to filter by, separated by a comma (`,`) and without spaces","name":"ids","required":false,"type":"array","collectionFormat":"csv","items":{"type":"string"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]},"post":{"x-mt-visible":true,"operationId":"addTenant","summary":"Add new Tenant","description":"The *add tenant* endpoint receives a new tenant object and creates that tenant in Sisense, returning the created object.\n<br/>If a tenant with the same name exists, it will return an error.\n","tags":["tenants"],"responses":{"201":{"description":"No response was specified","schema":{"type":"object","properties":{"_id":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"name":{"type":"string"},"default":{"type":"boolean"},"shouldCreateSamples":{"type":"boolean"},"defaultDataGroupId":{"type":"string"}}}},"400":{"description":"- **3002** The tenant already exists.\n","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"},"404":{"description":"Not found.","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}},"422":{"description":"- **3003** Mandatory fields are missing.\n","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"Basic tenant object (in `JSON` notation) to be added","name":"tenant","required":true,"schema":{"type":"object","required":["name","email","license"],"properties":{"name":{"type":"string"},"email":{"type":"string","pattern":"^(([^<>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z\\-0-9]{2,})|([a-zA-Z\\-0-9]+))$"},"password":{"type":"string"},"shouldCreateSamples":{"type":"boolean"},"defaultDataGroupId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"isExistingUser":{"type":"boolean"},"tenantDomainNames":{"type":"array","items":{"type":"string"}},"license":{"type":"object","properties":{"admins":{"type":"integer"},"contributors":{"type":"integer"},"consumers":{"type":"integer"}}}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/tenants/count":{"x-swagger-router-controller":"tenants.controller.v1","x-permission-type":"admins-only","get":{"x-mt-visible":true,"operationId":"getTenantsCount","summary":"Get Tenants count","description":"Total tenants count","tags":["tenants"],"responses":{"200":{"description":"Tenants count","schema":{"type":"object","properties":{"count":{"type":"integer"}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"query","description":"Enter a search query to return count of results matching the query","name":"search","required":false,"type":"string"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/tenants/{id}":{"x-swagger-router-controller":"tenants.controller.v1","x-permission-type":"admins-only","get":{"x-mt-visible":true,"operationId":"getTenant","summary":"Get a specific tenant","description":"The **get tenant by ID** endpoint retrieves a specific tenant object corresponding to the provided ID.","tags":["tenants"],"responses":{"200":{"description":"Tenant","schema":{"type":"object","properties":{"_id":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"name":{"type":"string"},"default":{"type":"boolean"},"shouldCreateSamples":{"type":"boolean"},"defaultDataGroupId":{"type":"string"}}}},"403":{"description":"User does not have permission"},"404":{"description":"Not found.","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"The ID of the tenant to get","name":"id","required":true,"type":"string","pattern":"^[0-9a-fA-F]{24}$"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]},"delete":{"x-mt-visible":true,"operationId":"deleteTenant","summary":"Delete tenant from system","description":"The *delete tenant* endpoint receives a tenant id and deletes that tenant in Sisense, returning the deleted object.\n<br/>If a tenant with the specified id is not exists, it will return an error.\n","tags":["tenants"],"responses":{"204":{"description":"No response was specified"},"400":{"description":"- **3004** A default tenant cannot be deleted.\n- **3005** Tenant have users/groups and cannot be deleted\n"},"403":{"description":"User does not have permission"},"404":{"description":"- **3001** Tenant not found.\n"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"The ID of the tenant to delete","name":"id","required":true,"type":"string","pattern":"^[0-9a-fA-F]{24}$"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]},"patch":{"x-mt-visible":true,"operationId":"updateTenant","summary":"Update a Tenant","description":"The *edit tenant* endpoint receives an object with the fields to be edited. The api will return the updated\ntenant object.\n","tags":["tenants"],"responses":{"200":{"description":"Tenant","schema":{"type":"object","properties":{"_id":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"name":{"type":"string"},"default":{"type":"boolean"},"shouldCreateSamples":{"type":"boolean"},"defaultDataGroupId":{"type":"string"}}}},"400":{"description":"- **3002** The tenant does not exist.\n- **3006** A default tenant cannot be updated\n","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"},"404":{"description":"Not found.","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}},"422":{"description":"- **3003** Mandatory fields are missing.\n","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"The ID of the tenant to update","name":"id","required":true,"type":"string","pattern":"^[0-9a-fA-F]{24}$"},{"in":"body","description":"Basic tenant object (in `JSON` notation) to be added","name":"tenant","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"Example_Tenant"},"disabled":{"type":"boolean","example":true},"shouldCreateSamples":{"type":"boolean","example":false},"defaultDataGroupId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","example":"1a2b3c4d-5e6f-7a8b-9c10-d11e12f13a14"}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/tenants_system":{"x-swagger-router-controller":"tenants.controller.v1","x-permission-type":"admins-only","get":{"x-mt-visible":true,"operationId":"getSystemTenant","summary":"Get System Tenant","description":"The **System Default Tenant* in the system.","tags":["tenants"],"responses":{"200":{"description":"Tenant","schema":{"type":"object","properties":{"_id":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"name":{"type":"string"},"default":{"type":"boolean"},"shouldCreateSamples":{"type":"boolean"},"defaultDataGroupId":{"type":"string"}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]}},"/wat/generate":{"x-swagger-router-controller":"tokenAuth.controller.v1","post":{"x-hide":false,"x-permission-type":"admins-only","operationId":"generateWebAccessToken","summary":"Generate Web Access Token","description":"Generate new token which includes claims reflecting the desired configuration of your business use case\n","tags":["web-access-tokens"],"responses":{"200":{"description":"Generated Web Access Token.","schema":{"type":"string"}},"400":{"description":"Bad Request","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"},"422":{"description":"Unprocessable Entity","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"subErrors":{"type":"array","items":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}}}]}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"Basic Web Access Token configuration","name":"watConfiguration","required":true,"schema":{"type":"object","required":["header","payload","secret"],"properties":{"header":{"type":"object","description":"Includes type of token, encryption and compression algorithms, and unique identifier of the token configuration - kid.\nCheck [Using Web Access Tokens - Securing Users](https://documentation.sisense.com/docs/using-web-access-token) to see the exact list of required properties and their accepted values\n","properties":{"typ":{"description":"Defines the type of the token. The value must be `JWT`, as the only one supported at the moment.","example":"JWT"},"kid":{"description":"Key ID value of the created token configuration.","example":"6194f6b0326fd7003600126e"},"alg":{"description":"Encryption algorithm of the Content Encryption Key (CEK). The value must be `RSA-OAEP-256`, as the only one supported at the moment.","example":"RSA-OAEP-256"},"enc":{"description":"Encryption algorithm for the JWT claims. The value must be `A128GCM`, as the only one supported at the moment.","example":"A128GCM"},"zip":{"description":"Compression algorithm. The value must be `DEF` as the only one supported at the moment.","example":"DEF"}}},"payload":{"type":"object","description":"Consist of claims which are the statements defining end user’s permissions and experience of interacting with the assets.\nCheck [Using Web Access Tokens - Securing Users](https://documentation.sisense.com/docs/using-web-access-token) to see list of supported claims.\n","properties":{"sub":{"description":"ID of the Sisense user on behalf of whom the access is granted","example":"6128c62ea23e09002c411453"},"nbf":{"description":"Time before which the JWT MUST NOT be accepted for processing","example":1612707042},"exp":{"description":"Expiration time on, or after which, the JWT MUST NOT be accepted for processing","example":1757326503},"thm":{"description":"String identifies session UI theme id.","example":"61f72cb3867f3f001bec0002"},"lng":{"description":"Language of the Sisense interface","example":"fr-FR"},"grants":{"description":"Parental structure claim for permissions. Permission claims entered outside of “grants” are ignored","properties":{"res":{"description":"Specifies the list of dashboards that are allowed to be accessed via the Web Access Token","example":["dashboards/5fe9ea09c3106c002ca11273","dashboards/6127726ffd984a0036529a7d"]},"prm":{"description":"Specifies end-user permissions for the Web Access Token environment within the scope of the `Viewer` role level. Available options are `filter` and `export`.","example":["filter","export"]},"flt":{"description":"Specifies filters that should be applied to the asset in a Web Access Token-based environment.","example":[]},"acl":{"description":"Data security that should be applied to the end user","example":[]}}}}},"secret":{"type":"string","description":"Is a signature used to encrypt token’s data and protect from changing its content","example":"-----BEGIN PUBLIC KEY-----MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtT5bUIL6A9wxChGWgUdqBwkvRNPcGvMZyxlDdRKlAhvtsKkxU0aKyyvdzDXh0OTrde1L4wqTsEs+5ASZDVzcJ7wFCN8w9owaJHOgmGgKrspTWIHXRIf+3sttIkTPFy5fDsaAkR7lYOe4LFJhhCpoZKf3+B433xZUgIaxMmC+WzgiPWw0b0K4wfBGnm55NkpoFUd2BvkeDxlvVei5aX8g+sBGKePurI6jOKtgct0PQFJNCcAtH4qYbaP0zPOWAGnHB9d4F2gIm4HgKkS+SxRtJNv4pUTHYMgAGj9mbpi36vwbpxUzY0UZW9mM9lpraIXDTYFeRXkNUEO2VLQ/NSu8DQIDAQAB-----END PUBLIC KEY-----"}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/wat/validate":{"x-swagger-router-controller":"tokenAuth.controller.v1","post":{"x-permission-type":"admins-only","operationId":"testWebAccessToken","summary":"Test Web Access Token","description":"Validate generated token towards structural, logical, and data requirements.\nAt data level, the `thm` claim is not checked against existing UI themes.\n","tags":["web-access-tokens"],"responses":{"200":{"description":"Validation results.","schema":{"type":"object","properties":{"isValid":{"type":"boolean","description":"Indicates whether token passed validation for all specified levels","example":true},"structure":{"type":"object","properties":{"executed":{"type":"boolean","description":"Indicates whether level's validation was executed","example":true},"isValid":{"type":"boolean","description":"Indicates whether token passed level's validation","example":true},"errors":{"type":"array","description":"Level's validation errors","example":[],"items":{"type":"string"}}}},"logic":{"type":"object","properties":{"executed":{"type":"boolean","description":"Indicates whether level's validation was executed","example":true},"isValid":{"type":"boolean","description":"Indicates whether token passed level's validation","example":true},"errors":{"type":"array","description":"Level's validation errors","example":[],"items":{"type":"string"}}}},"data":{"type":"object","properties":{"executed":{"type":"boolean","description":"Indicates whether level's validation was executed","example":true},"isValid":{"type":"boolean","description":"Indicates whether token passed level's validation","example":true},"errors":{"type":"array","description":"Level's validation errors","example":[],"items":{"type":"string"}}}}}}},"400":{"description":"Bad Request","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}},"403":{"description":"User does not have permission"},"422":{"description":"Unprocessable Entity","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"subErrors":{"type":"array","items":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}}}]}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"Web Access Token payload to test with","name":"testWat","required":true,"schema":{"type":"object","required":["wat"],"properties":{"wat":{"type":"string","description":"Web Access Token to test","example":"eyJhbGciOiJSU0EtT0FFUC0yNTYiLCJ6aXAiOiJERUYiLCJlbmMiOiJBMTI4R0NNIiwia2lkIjoiNjE2NmNhODliZTAzYjcwMDM3MjI3ZjVkIn0.HJmbC7dHTZv9SMEOJcgbJGupUG2AC5AU7beM7gqwpmG8gweg6bmuUM8tKzopBaGUPS4wtTctG2gV7vGgGTHoZwC7vbH0V9Q93d35EEQkf8ZdA3ZJNDbSdbU9_Wh9PngmucxyNDFAKDVtKXkIADnRlbPiTwGEkj4csSmlFj-8VZm_AHEkZsnz6C8wDSS6dM6_n8DlWHbxQZahmiySIxCltDiIUXLzQB1Pk5Fq3R4zDzYoU0KBbq4a2t3xWY8TQu6U3Sl5w-th6xCD92NHu5dScVntqBpLLjm0XmgKRxus_EV8W3yb3IdR0jYvSOPrj-stGSoBNFrhGbIOqoYwmQRFWQ.Fi7gVwzvAn_PeOE2.cEiJB0EvlpciGRB5DAay23DSsSE-Z2S5uXJ6eUzK1QM5FOuSsOtVa9Ro9YRWhFjSeUJCj83nv4YjTwYG1yeBvQ.spPUTdhW5z5u2TgKepOG4w"},"validationLevel":{"type":"string","enum":["structure","logic","data"],"default":"data","description":"Specifies the testing level for the selected Web Access Token","example":"logic"}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/export/dashboards/{dashboardId}/pdf":{"x-swagger-router-controller":"exporting.swagger.controller.v1","x-permission-type":"asset","x-asset-prop-path":"swagger.params.dashboardId","post":{"x-permission-path":"dashboards/export_pdf","tags":["exporting"],"produces":["application/pdf"],"responses":{"200":{"description":"PDF file","schema":{"type":"string"}},"403":{"description":"User does not have permission"},"422":{"description":"Request parameters are not valid","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"},"logref":{"type":"string"}}},{"type":"object","properties":{"subErrors":{"type":"array","items":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"},"logref":{"type":"string"}}}}}}}}]}}}},"500":{"description":"Internal Server Error","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"},"logref":{"type":"string"}}}}}}},"summary":"Get a dashboard as .pdf file","description":"The **export dashboard to `.pdf`** endpoint returns the requested dashboard rendered as a `.pdf` document file.\n<br/>It can be configured to export PDFs of different paper sizes, orientation, as well as to include or exclude certain parts (such as dashboard filters).\n<br/>Note that dashboards rendered this way have a different layout to dashboards displayed in the application, and can be either the **as is** layout (the reporting layout) or the **feed** layout which puts each widget in it's own line.\n","operationId":"exportDashboardAsPdfByHttp","parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"The ID of the dashboard to export","name":"dashboardId","required":true,"type":"string","pattern":"^[0-9a-fA-F]{24}$"},{"in":"query","description":"If dashboard is in shared mode","name":"sharedMode","required":false,"type":"boolean"},{"in":"body","description":"The configuration body for exporting","name":"body","required":true,"schema":{"type":"object","required":["params"],"properties":{"params":{"type":"object","required":["paperFormat","paperOrientation"],"properties":{"paperFormat":{"description":"What paper format should be used while rendering the dashboard","default":"A4","type":"string","enum":["A0","A1","A2","A3","A4","A5","LEGAL","LETTER","TABLOID"]},"paperOrientation":{"description":"What paper orientation should be used while rendering the dashboard","type":"string","enum":["portrait","landscape"]},"preview":{"description":"Should use a new 'preview' (pixel perfect) layout","type":"boolean"},"elasticubeBuiltValue":{"description":"Elasticube last build time (for *preview* layout)","type":"string"},"layout":{"description":"What layout should be used while rendering the dashboard, *as is* or *feed* (for non-preview layout)","type":"string","enum":["asis","feed"]},"showDashboardTitle":{"description":"Sets visibility of dashboard title on the resulting PDF (for non-preview layout)","type":"boolean","default":true},"showDashboardFilters":{"description":"Sets visibility of dashboard filters on the resulting PDF (for non-preview layout)","type":"boolean","default":true},"showDatasourceInfo":{"description":"Sets visibility of dashboard datasource info on the resulting PDF (for non-preview layout)","type":"boolean","default":true},"customDashboardFilters":{"description":"Dashboard filters for exporting (override existing filters)","type":"array","items":{"type":"object","properties":{"instanceid":{"type":"string"},"isCascading":{"type":"boolean"},"jaql":{"type":"object","properties":{"dim":{"type":"string"},"datatype":{"type":"string"},"title":{"type":"string"},"level":{"type":"string"}}},"levels":{"type":"array","items":{}},"model":{"type":"object"}}}},"customWidgetsFilters":{"description":"Widgets filters","type":"array","items":{"type":"object","properties":{"widgetId":{"type":"string"},"filters":{"type":"array","items":{"type":"object","properties":{"jaql":{"type":"object","properties":{"table":{"type":"string"},"column":{"type":"string"},"dim":{"type":"string"},"datatype":{"type":"string"},"merged":{"type":"boolean"},"title":{"type":"string"},"collapsed":{"type":"boolean"},"datasource":{"type":"object","properties":{"fullname":{"type":"string"},"id":{"type":"string"},"address":{"type":"string"},"database":{"type":"string"},"title":{"type":"string"},"live":{"type":"boolean"}}},"filter":{"type":"object"}}}}}}}}},"userId":{"description":"Id of the user to get dashboard for (only for admins)","type":"string"}}}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/export/dashboards/{dashboardId}/png":{"x-swagger-router-controller":"exporting.swagger.controller.v1","x-permission-type":"asset","x-asset-prop-path":"swagger.params.dashboardId","post":{"x-permission-path":"dashboards/export_image","tags":["exporting"],"produces":["image/png"],"responses":{"200":{"description":"Image file","schema":{"type":"string"}},"403":{"description":"User does not have permission"},"422":{"description":"Request parameters are not valid","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"},"logref":{"type":"string"}}},{"type":"object","properties":{"subErrors":{"type":"array","items":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"},"logref":{"type":"string"}}}}}}}}]}}}},"500":{"description":"Internal Server Error","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"},"logref":{"type":"string"}}}}}}},"summary":"Get a dashboard as .png image","description":"The **export dashboard to `.png`** endpoint returns the requested dashboard rendered as a `.png` image file.\n<br/>It can be configured to export images of different width, and to include or exclude certain parts (such as dashboard filters).\n<br/>Note that dashboards rendered this way have a different layout to dashboards displayed in the application, called the reporting layout.\n","operationId":"exportDashboardAsPngByHttp","parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"The ID of the dashboard to export","name":"dashboardId","required":true,"type":"string","pattern":"^[0-9a-fA-F]{24}$"},{"in":"query","description":"If dashboard is in shared mode","name":"sharedMode","required":false,"type":"boolean"},{"in":"body","description":"The configuration body for exporting","name":"body","required":true,"schema":{"type":"object","required":["params"],"properties":{"params":{"type":"object","required":["width"],"properties":{"width":{"description":"Render width in pixels","type":"integer","default":1000},"layout":{"description":"What layout should be used while rendering the dashboard, *as is* or *feed*","type":"string","default":"asis","enum":["asis","feed"]},"showDashboardTitle":{"description":"Sets visibility of dashboard title on the resulting PDF","type":"boolean","default":true},"showDashboardFilters":{"description":"Sets visibility of dashboard filters on the resulting PDF","type":"boolean","default":true},"showDatasourceInfo":{"description":"Sets visibility of dashboard datasource info on the resulting PDF","type":"boolean","default":true}}}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/export/dashboards/{dashboardId}/widgets/{widgetId}/pdf":{"x-swagger-router-controller":"exporting.swagger.controller.v1","x-permission-type":"asset","x-asset-prop-path":"swagger.params.dashboardId","post":{"x-permission-path":"widgets/export_pdf","tags":["exporting"],"produces":["application/pdf"],"responses":{"200":{"description":"Pdf file","schema":{"type":"string"}},"403":{"description":"User does not have permission"},"422":{"description":"Request parameters are not valid","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"},"logref":{"type":"string"}}},{"type":"object","properties":{"subErrors":{"type":"array","items":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"},"logref":{"type":"string"}}}}}}}}]}}}},"500":{"description":"Internal Server Error","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"},"logref":{"type":"string"}}}}}}},"summary":"Get a widget as .pdf file","description":"The **export widget to `.pdf`** endpoind returns the requested widget from dashboard rendered as a `.pdf` document file.\n","operationId":"exportWidgetAsPdfByHttp","parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"The ID of the dashboard with target widget","name":"dashboardId","required":true,"type":"string","pattern":"^[0-9a-fA-F]{24}$"},{"in":"path","description":"The ID of widget to export","name":"widgetId","required":true,"type":"string","pattern":"^[0-9a-fA-F]{24}$"},{"in":"query","description":"If dashboard is in shared mode","name":"sharedMode","required":false,"type":"boolean"},{"in":"body","description":"The configuration body for exporting","name":"body","required":true,"schema":{"type":"object","required":["params"],"properties":{"params":{"type":"object","required":["paperFormat","paperOrientation"],"properties":{"paperFormat":{"description":"What paper format should be used while rendering the widget","default":"A4","type":"string","enum":["A0","A1","A2","A3","A4","A5","LEGAL","LETTER","TABLOID"]},"paperOrientation":{"description":"What paper orientation should be used while rendering the widget","type":"string","enum":["portrait","landscape"]},"rowCount":{"description":"Count of table/pivot rows to export","type":"integer","default":8000},"showTitle":{"description":"Should widget title be included in the exported file","type":"boolean","default":true},"showFooter":{"description":"Should widget footer be included in the exported file","type":"boolean","default":true},"title":{"description":"Widget title text in the exported file","type":"string"},"titleSize":{"description":"Widget title size in the exported file","type":"string","default":"medium","enum":["small","medium","large"]},"titlePosition":{"description":"Widget title position in the exported file","type":"string","default":"flex-start","enum":["flex-start","center","flex-end"]}}}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/export/dashboards/{dashboardId}/widgets/{widgetId}/png":{"x-swagger-router-controller":"exporting.swagger.controller.v1","x-permission-type":"asset","x-asset-prop-path":"swagger.params.dashboardId","post":{"x-permission-path":"widgets/export_png","tags":["exporting"],"produces":["image/png"],"responses":{"200":{"description":"Image file","schema":{"type":"string"}},"403":{"description":"User does not have permission"},"422":{"description":"Request parameters are not valid","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"},"logref":{"type":"string"}}},{"type":"object","properties":{"subErrors":{"type":"array","items":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"},"logref":{"type":"string"}}}}}}}}]}}}},"500":{"description":"Internal Server Error","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"},"logref":{"type":"string"}}}}}}},"summary":"Get a widget as .png image","description":"The **export widget to `.png`** endpoint returns the requested widget from dashboard rendered as a `.png` image file.\n","operationId":"exportWidgetAsPngByHttp","parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"The ID of the dashboard with target widget","name":"dashboardId","required":true,"type":"string","pattern":"^[0-9a-fA-F]{24}$"},{"in":"path","description":"The ID of the widget to export","name":"widgetId","required":true,"type":"string","pattern":"^[0-9a-fA-F]{24}$"},{"in":"query","description":"If dashboard is in shared mode","name":"sharedMode","required":false,"type":"boolean"},{"in":"body","description":"The configuration body for exporting","name":"body","required":true,"schema":{"type":"object","required":["params"],"properties":{"params":{"type":"object","required":["width","height"],"properties":{"width":{"description":"Render width in pixels","type":"integer","default":1000},"height":{"description":"Render height in pixels","type":"integer","default":1000},"fitWidth":{"description":"Should fit Pivot2 widget to width","type":"boolean","default":false}}}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/export/jaql/xlsx":{"x-swagger-router-controller":"exporting.swagger.controller.v1","x-permission-type":"asset","x-asset-prop-path":"swagger.params.dashboardId","post":{"x-permission-path":"widgets/export_csv","operationId":"exportPivotWidgetAsXlsxByHttp","produces":["application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"],"responses":{"200":{"description":"The requested pivot rendered as a `.xlsx` document file."},"403":{"description":"User does not have permission"},"422":{"description":"Request parameters are not valid","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"},"logref":{"type":"string"}}},{"type":"object","properties":{"subErrors":{"type":"array","items":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"},"logref":{"type":"string"}}}}}}}}]}}}},"500":{"description":"Internal server error"}},"summary":"Export pivot to excel","description":"The export pivot to `.xlsx` endpoint returns the requested pivot rendered as a `.xlsx` document file.\n<br/>**Export to Excel V2** must be enabled in the system configuration.\n","tags":["exporting"],"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"Body","name":"body","required":true,"schema":{"type":"object","required":["jaql","widgetType"],"properties":{"jaql":{"type":"object","required":["datasource","metadata","widget"],"properties":{"datasource":{"type":"object","required":["title"],"properties":{"title":{"type":"string"},"live":{"type":"boolean"},"id":{"type":"string"},"fullname":{"type":"string"}}},"metadata":{"type":"array","items":{"type":"object","properties":{"jaql":{"type":"object","properties":{"dim":{"type":"string"},"datatype":{"type":"string"},"title":{"type":"string"},"level":{"type":"string"}}},"panel":{"type":"string","enum":["scope","rows","columns","measures"]}}}},"dashboard":{"description":"The ID of the dashboard with widget","type":"string"},"widget":{"description":"The ID of widget","type":"string"}}},"dashboardId":{"description":"The ID of the dashboard with widget","type":"string","pattern":"^[0-9a-fA-F]{24}$"},"widgetType":{"description":"widget type","type":"string"},"widgetStyles":{"description":"Specific widget styles for rendering xlsx file","type":"object","properties":{"rowHeight":{"type":"integer","description":"row height in pixels"}}},"mergeRows":{"description":"Should merge rows with the same values","type":"boolean","default":false},"language":{"description":"Language to use in case no user preferences","type":"string"}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/nlq":{"x-swagger-router-controller":"nlq.controller.v1","post":{"x-hide":false,"x-permission-type":"general","x-permission-path":"nlq/createSpec","operationId":"createNlqSpec","summary":"Add an NLQ spec","description":"Creates NLQ spec for a dashboard.","tags":["nlq"],"responses":{"201":{"description":"NLA spec object.","schema":{"type":"object","properties":{"id":{"type":"string"},"datasourceTitle":{"type":"string"},"fields":{"type":"array","items":{"type":"object","properties":{"table":{"type":"string"},"column":{"type":"string"},"type":{"type":"string"}}}}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword Bearer (with space between it and the token). For more information, see API tutorial.","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"Create spec parameters.","name":"addSpec","required":true,"schema":{"type":"object","properties":{"dashboardId":{"type":"string"},"datasourceTitle":{"type":"string"},"datasource":{"type":"object"},"skipStoreSpec":{"type":"boolean"},"modelId":{"type":"string"}},"required":["dashboardId","datasourceTitle","datasource"]}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/nlq/{id}/init":{"x-swagger-router-controller":"nlq.controller.v1","post":{"x-hide":false,"x-permission-type":"general","x-permission-path":"nlq/initSpec","operationId":"initNlqSpec","summary":"Init an NLQ Model","description":"Init an NLQ Model.","tags":["nlq"],"responses":{"200":{"description":"NLQ spec object.","schema":{"type":"object","properties":{"id":{"type":"string"},"datasourceTitle":{"type":"string"},"fields":{"type":"array","items":{"type":"object","properties":{"table":{"type":"string"},"column":{"type":"string"},"type":{"type":"string"}}}}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword Bearer (with space between it and the token). For more information, see API tutorial.","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"The ID of the model to init.","name":"id","required":true,"type":"string","pattern":"^[0-9a-fA-F]{24}$"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/nlq/getNlqModelSpec":{"x-swagger-router-controller":"nlq.controller.v1","x-permission-type":"authenticate","get":{"x-hide":false,"operationId":"getNlqModelSpec","summary":"Get NLQ Model","description":"Returns NLQ spec Model - If dashboard ID not provided, returns all specs.","tags":["nlq"],"responses":{"200":{"description":"NLQ spec object.","schema":{"type":"object","properties":{"id":{"type":"string"},"datasourceTitle":{"type":"string"},"fields":{"type":"array","items":{"type":"object","properties":{"table":{"type":"string"},"column":{"type":"string"},"type":{"type":"string"}}}}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword Bearer (with space between it and the token). For more information, see API tutorial.","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"query","description":"The dashboard oid - If the field is empty, returns all specs.","name":"dashboardOid","type":"string","pattern":"^[0-9a-fA-F]{24}$"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/nlq/permissions":{"x-swagger-router-controller":"nlq.controller.v1","x-permission-type":"general","x-permission-path":"nlq/createSpec","get":{"x-hide":false,"operationId":"getAllNlqPermissions","summary":"Get the NLQ permissions for the desired query","description":"Returns a list of NLQ permissions for an entity.","tags":["nlq"],"responses":{"200":{"description":"Array of NLQ permissions.","schema":{"type":"array","items":{"type":"object","properties":{"level":{"type":"string"},"entity":{"type":"string"},"enabled":{"type":"boolean"}}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword Bearer (with space between it and the token). For more information, see API tutorial.","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"query","description":"The elasticube title.","name":"elasticubeTitle","type":"string"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/nlq/permissions/{id}":{"x-swagger-router-controller":"nlq.controller.v1","x-permission-type":"general","x-permission-path":"nlq/createSpec","delete":{"x-hide":false,"operationId":"deleteNlqPermission","summary":"Delete an NLQ permission","description":"Removes an NLQ permission by ID.","responses":{"204":{"description":"NLQ permission was removed successfully."},"403":{"description":"User does not have permission"},"404":{"description":"NLQ permission not found.","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}}},"tags":["nlq"],"parameters":[{"in":"header","description":"The user's API token preceded by the keyword Bearer (with space between it and the token). For more information, see API tutorial.","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"The NLQ permission ID to remove its object.","name":"id","required":true,"type":"string"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/nlq/permissionLevel/{level}/entity/{entity}":{"x-swagger-router-controller":"nlq.controller.v1","get":{"x-hide":false,"x-permission-type":"authenticate","operationId":"getNlqPermission","summary":"Get the NLQ permission for the desired entity","description":"Returns the NLQ permission for the desired entity.","tags":["nlq"],"responses":{"200":{"description":"Entity's NLQ permission.","schema":{"type":"object","properties":{"level":{"type":"string"},"entity":{"type":"string"},"enabled":{"type":"boolean"}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword Bearer (with space between it and the token). For more information, see API tutorial.","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"Level to check permission.","name":"level","required":true,"type":"string"},{"in":"path","description":"The ID of the entity.","name":"entity","required":true,"type":"string"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]},"post":{"x-hide":false,"x-permission-type":"general","x-permission-path":"nlq/createSpec","operationId":"setNlqPermission","summary":"Set the NLQ permission for an entity","description":"Set the NLQ permission for an entity.","tags":["nlq"],"responses":{"200":{"description":"NLQ permission.","schema":{"type":"object","properties":{"level":{"type":"string","enum":["cube","dashboard"]},"entity":{"type":"string"},"enabled":{"type":"boolean"}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword Bearer (with space between it and the token). For more information, see API tutorial.","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"Level to check permission.","name":"level","required":true,"type":"string"},{"in":"path","description":"The ID of the entity.","name":"entity","required":true,"type":"string"},{"in":"body","description":"Permission object to set enabled or disabled.","name":"nlpPermissionObject","required":true,"schema":{"type":"object","properties":{"enabled":{"type":"boolean"}},"required":["enabled"]}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/nlq/{id}":{"x-swagger-router-controller":"nlq.controller.v1","x-permission-type":"general","x-permission-path":"nlq/createSpec","patch":{"x-hide":false,"x-permission-path":"nlq/updateSpec","operationId":"updateNlqSpec","summary":"Update an NLQ spec","description":"Update NLQ spec.","tags":["nlq"],"responses":{"200":{"description":"NLQ spec object.","schema":{"type":"object","properties":{"id":{"type":"string"},"datasourceTitle":{"type":"string"},"fields":{"type":"array","items":{"type":"object","properties":{"table":{"type":"string"},"column":{"type":"string"},"type":{"type":"string"}}}}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword Bearer (with space between it and the token). For more information, see API tutorial.","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"The ID of the model to update.","name":"id","required":true,"type":"string"},{"in":"body","description":"Update spec parameters.","name":"updateSpec","required":true,"schema":{"type":"object","properties":{"id":{"type":"string"},"datasourceTitle":{"type":"string"},"fields":{"type":"array","items":{"type":"object","properties":{"table":{"type":"string"},"column":{"type":"string"},"type":{"type":"string"}}}}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]},"delete":{"x-hide":false,"operationId":"deleteNlqSpec","summary":"Delete an NLQ Model","description":"Removes an NLQ Model by ID.","tags":["nlq"],"responses":{"204":{"description":"NLQ Model was removed successfully."},"403":{"description":"User does not have permission"},"404":{"description":"NLQ Model not found.","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword Bearer (with space between it and the token). For more information, see API tutorial.","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"The NLQ Model ID to remove its object.","name":"id","required":true,"type":"string"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/nlq/schedulers":{"x-swagger-router-controller":"nlq.controller.v1","x-permission-type":"data-admins-only","get":{"x-hide":false,"operationId":"getNlqLiveSchedulers","summary":"Get all NLQ live schedulers","description":"Returns a list of NLQ live schedulers jobs configurations.","tags":["nlq"],"responses":{"200":{"description":"Live schedulers jobs configurations.","schema":{"type":"array","items":{"type":"object"}}},"403":{"description":"User does not have permission"},"404":{"description":"API not found.","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword Bearer (with space between it and the token). For more information, see API tutorial.","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"query","description":"The live model server.","name":"liveModelServer","required":false,"type":"string"},{"in":"query","description":"The live model title.","name":"liveModelTitle","required":false,"type":"string"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]},"post":{"x-hide":false,"operationId":"addNlqLiveScheduler","summary":"Add NLQ live scheduler","description":"Add NLQ live scheduler for Live model.","tags":["nlq"],"responses":{"200":{"description":"NLQ user history.","schema":{"type":"object","properties":{"nlqId":{"type":"string"},"userId":{"type":"string"},"recent":{"type":"array","items":{"type":"string"}},"stared":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad request error.\n- **32012** missing scheduler time\n"},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword Bearer (with space between it and the token). For more information, see API tutorial.","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"NLQ live scheduler settings.","name":"nlqLiveSchedulerSettings","required":true,"schema":{"type":"object","properties":{"active":{"type":"boolean"},"liveModelServer":{"type":"string"},"liveModelTitle":{"type":"string"},"hour":{"type":"number"},"minute":{"type":"number"}},"required":["active","liveModelServer","liveModelTitle","hour","minute"]}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/nlq/schedulers/{id}":{"x-swagger-router-controller":"nlq.controller.v1","x-permission-type":"data-admins-only","patch":{"x-hide":false,"responses":{"200":{"description":"Updated NLQ live scheduler settings for Live model.","schema":{"type":"object","properties":{"active":{"type":"boolean"},"liveModelServer":{"type":"string"},"liveModelTitle":{"type":"string"},"hour":{"type":"number"},"minute":{"type":"number"}},"required":["active","liveModelServer","liveModelTitle","hour","minute"]}},"403":{"description":"User does not have permission"},"404":{"description":"NLQ live scheduler settings not found.","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}}},"description":"Update an NLQ live scheduler settings.","tags":["nlq"],"summary":"Update an NLQ live scheduler for Live model","operationId":"updateNlqLiveScheduler","parameters":[{"in":"header","description":"The user's API token preceded by the keyword Bearer (with space between it and the token). For more information, see API tutorial.","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"The NLQ live scheduler settings oid to update.","name":"id","required":true,"type":"string"},{"in":"body","description":"NLQ live scheduler settings which will be updated.","name":"nlqLiveSchedulerSettings","required":true,"schema":{"type":"object","properties":{"active":{"type":"boolean"},"liveModelServer":{"type":"string"},"liveModelTitle":{"type":"string"},"hour":{"type":"number"},"minute":{"type":"number"}},"required":["active","liveModelServer","liveModelTitle","hour","minute"]}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]},"delete":{"x-hide":false,"responses":{"204":{"description":"NLQ live scheduler settings was removed successfully."},"403":{"description":"User does not have permission"},"404":{"description":"NLQ live scheduler settings not found.","schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}}},"description":"Removes an NLQ live scheduler settings by ID.","tags":["nlq"],"summary":"Delete an NLQ live scheduler settings","operationId":"deleteNlqLiveScheduler","parameters":[{"in":"header","description":"The user's API token preceded by the keyword Bearer (with space between it and the token). For more information, see API tutorial.","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"path","description":"The NLQ live scheduler settings ID to remove its object.","name":"id","required":true,"type":"string"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/nlq/getIndexedFields":{"x-swagger-router-controller":"nlq.controller.v1","x-permission-type":"general","x-permission-path":"nlq/createSpec","get":{"x-hide":false,"operationId":"getIndexedFields","summary":"Get the NLQ indexed fields in all NLQ specs by elasticube","description":"Returns an array of the indexed fields and the amount remaining to index.","tags":["nlq"],"responses":{"200":{"description":"Object with array of indexedFields and amountLeftToIndex.","schema":{"type":"object"}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword Bearer (with space between it and the token). For more information, see API tutorial.","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"query","description":"The elasticube title.","name":"elasticubeTitle","required":true,"type":"string"},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/nlq/enableNlqOnDashboards":{"x-swagger-router-controller":"nlq.controller.v1","post":{"x-hide":false,"x-permission-type":"general","x-permission-path":"nlq/createSpec","operationId":"enableNlqOnDashboards","summary":"Enable Simply Ask on all dashboards by datamodel title","description":"Enable NLQ on all dashboards by datamodel title, and on the datamodel itself.","tags":["nlq"],"responses":{"200":{"description":"Operation result.","schema":{"type":"object","properties":{"result":{"type":"string"}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword Bearer (with space between it and the token). For more information, see API tutorial.","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"Request data.","name":"enableNlqOnAllDashboardsObject","required":true,"schema":{"type":"object","properties":{"datamodelTitle":{"type":"string"}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]}},"/nlq/nlqAdvancedMode":{"x-swagger-router-controller":"nlq.controller.v1","post":{"x-hide":false,"x-permission-type":"general","x-permission-path":"nlq/createSpec","operationId":"setNlqAdvanceMode","summary":"enable/Disable the NLQ Advanced Mode","description":"Enable/Disable the NLQ Advanced Mode. Can only be called from system tenant and by the system admin user. Calling this api with enabled=false will remove indexing and synonyms from all NLQ specs, and all live schedulers will be deleted. When enabled=true, default (00:00) live schedulers will be created for live datamodels.","tags":["nlq"],"responses":{"200":{"description":"Operation result.","schema":{"type":"object","properties":{"result":{"type":"string"}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword Bearer (with space between it and the token). For more information, see API tutorial.","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},{"in":"body","description":"Required enabled status true/false.","required":true,"name":"params","schema":{"type":"object","properties":{"enabled":{"type":"boolean"}}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}]},"get":{"x-hide":false,"x-permission-type":"general","x-permission-path":"nlq/createSpec","operationId":"getNlqAdvanceMode","summary":"Get the NLQ Advanced Mode status","description":"Get the NLQ Advanced Mode status.","tags":["nlq"],"responses":{"200":{"description":"NLQ Advanced Mode status.","schema":{"type":"object","properties":{"result":{"type":"string"}}}},"403":{"description":"User does not have permission"}},"parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]}}},"definitions":{"CreateSharedSubscriptionConfigurationDto":{"properties":{"allowChangeSubscription":{"default":false,"description":"Defines if users(shares) can change their own subscription settings","type":"boolean"},"emailSettings":{"allOf":[{"$ref":"#/definitions/EmailSettings"}],"default":{"isEmail":true,"isPdf":false},"description":"Email report format settings. `isEmail` — Embedded in email, `isPdf` — PDF attachment","example":{"isEmail":true,"isPdf":false}},"executionPerDay":{"default":1,"description":"Defines how many emails per day can be send","maximum":24,"minimum":1,"type":"number"},"isDataChange":{"default":false,"description":"Indicates if the subscription triggered by data change or manually","type":"boolean"},"schedule":{"description":"Cron schedule expression","example":"0 8 * * * *","type":"string"},"startAt":{"description":"Start date in YYYY-MM-DD format","example":"2025-06-25","type":"string"},"subscribedGroups":{"description":"Subscribed groups","items":{"type":"string"},"type":"array"},"subscribedUsers":{"description":"Subscribed users","items":{"type":"string"},"type":"array"},"timezone":{"default":0,"description":"Timezone offset in minutes from UTC (e.g. -60 = UTC-1)","type":"number"},"type":{"default":"onUpdate","description":"Subscription type","enum":["daily","monthly","onUpdate"],"type":"string"},"tzName":{"description":"Timezone name (e.g. Europe/Lisbon)","example":"Europe/Lisbon","type":"string"}},"required":["subscribedUsers","subscribedGroups"],"type":"object"},"CreateUserSubscriptionConfigurationDto":{"properties":{"emailSettings":{"allOf":[{"$ref":"#/definitions/EmailSettings"}],"default":{"isEmail":true,"isPdf":false},"description":"Email report format settings. `isEmail` — Embedded in email, `isPdf` — PDF attachment","example":{"isEmail":true,"isPdf":false}},"executionPerDay":{"default":1,"description":"Defines how many emails per day can be send","maximum":24,"minimum":1,"type":"number"},"isDataChange":{"default":false,"description":"Indicates if the subscription triggered by data change or manually","type":"boolean"},"schedule":{"description":"Cron schedule expression","example":"0 8 * * * *","type":"string"},"startAt":{"description":"Start date in YYYY-MM-DD format","example":"2025-06-25","type":"string"},"subscribed":{"description":"Indicates if the user is subscribed","type":"boolean"},"timezone":{"default":0,"description":"Timezone offset in minutes from UTC (e.g. -60 = UTC-1)","type":"number"},"type":{"default":"onUpdate","description":"Subscription type","enum":["daily","monthly","onUpdate"],"type":"string"},"tzName":{"description":"Timezone name (e.g. Europe/Lisbon)","example":"Europe/Lisbon","type":"string"}},"required":["subscribed"],"type":"object"},"EmailSettings":{"properties":{},"type":"object"},"MailInfoDto":{"properties":{"error":{"description":"Amount of error reports sent","type":"number"},"groupsBcc":{"description":"Amount of emails sent with BCC for success reports","type":"number"},"notSent":{"description":"Amount of not sent reports","type":"number"},"success":{"description":"Amount of successfully sent reports","type":"number"}},"required":["success","error","notSent","groupsBcc"],"type":"object"},"PdfPreferencesDto":{"properties":{"elasticubeBuiltValue":{"default":"","description":"Custom elasticube's build timestamp value. None will be applied passing empty string.","type":"string"},"includeDS":{"default":true,"description":"Whether to include data source value in the PDF layout","type":"boolean"},"includeFilters":{"default":true,"description":"Whether to include filters in the PDF layout","type":"boolean"},"includeTitle":{"default":true,"description":"Whether to include title in the PDF layout","type":"boolean"},"preview":{"default":true,"description":"If *true* v2 pdf layout will be applied (the one we use from the UI), v1 layout will be applied otherwise","type":"boolean"},"renderingInfo":{"allOf":[{"$ref":"#/definitions/RenderingInfoDto"}],"description":"Rendering information"}},"type":"object"},"RecipientDto":{"properties":{"recipient":{"description":"Recipient ID (user or group)","type":"string"},"type":{"description":"Type of recipient","enum":["user","group"],"type":"string"}},"required":["type","recipient"],"type":"object"},"RecipientsInfoDto":{"properties":{"dataGroupsCount":{"description":"Data groups in scope of total users","type":"number"},"usersCount":{"description":"Total amount of recipient users","type":"number"}},"required":["usersCount","dataGroupsCount"],"type":"object"},"RenderingInfoDto":{"properties":{"layout":{"default":"asis","description":"Layout for rendering","enum":["asis","feed"],"type":"string"},"paperFormat":{"default":"A4","description":"Paper format for rendering","enum":["A0","A1","A2","A3","A4","A5","LEGAL","LETTER","TABLOID","legal","letter","tabloid"],"type":"string"},"paperOrientation":{"default":"portrait","description":"Paper orientation for rendering","enum":["portrait","landscape"],"type":"string"},"showNarration":{"default":true,"description":"Whether to show narration","type":"boolean"}},"type":"object"},"ReportObjectDto":{"properties":{"assetId":{"description":"Asset ID (e.g., dashboard ID)","type":"string"},"assetType":{"description":"Type of asset","enum":["dashboard"],"type":"string"},"preferences":{"allOf":[{"$ref":"#/definitions/ReportPreferencesDto"}],"description":"Report preferences"},"recipients":{"description":"Recipients of the report","items":{"$ref":"#/definitions/RecipientDto"},"type":"array"},"requestTimeout":{"default":300000,"description":"Request timeout in milliseconds","type":"number"}},"required":["assetId","assetType","recipients"],"type":"object"},"ReportPreferencesDto":{"properties":{"inline":{"description":"Whether to include dashboard in email body","type":"boolean"},"pdf":{"allOf":[{"$ref":"#/definitions/PdfPreferencesDto"}],"description":"PDF export preferences"}},"type":"object"},"ReportingResultDto":{"properties":{"mail":{"allOf":[{"$ref":"#/definitions/MailInfoDto"}],"description":"Mail sent info"},"recipients":{"allOf":[{"$ref":"#/definitions/RecipientsInfoDto"}],"description":"Recipients info"},"senderRole":{"description":"Sender user role name","type":"string"}},"type":"object"},"ResponseSharedSubscriptionConfigurationDto":{"properties":{"_id":{"description":"Subscription configuration ID","type":"string"},"allowChangeSubscription":{"description":"Indicates if the user can change their own subscription settings","type":"boolean"},"created":{"description":"When created","example":"2025-08-12T12:47:59.530Z","format":"date-time","type":"string"},"dashboardId":{"description":"Dashboard Id","type":"string"},"emailSettings":{"allOf":[{"$ref":"#/definitions/EmailSettings"}],"default":{"isEmail":true,"isPdf":false},"description":"Email report format settings. `isEmail` — Embedded in email, `isPdf` — PDF attachment","example":{"isEmail":true,"isPdf":false}},"executionPerDay":{"default":1,"description":"Defines how many emails per day can be send","maximum":24,"minimum":1,"type":"number"},"isDataChange":{"default":false,"description":"Indicates if the subscription triggered by data change or manually","type":"boolean"},"lastUpdated":{"description":"When last time updated","example":"2025-08-12T12:47:59.530Z","format":"date-time","type":"string"},"schedule":{"description":"Cron schedule expression","example":"0 8 * * * *","type":"string"},"startAt":{"description":"Start date in YYYY-MM-DD format","example":"2025-06-25","type":"string"},"subscribedGroups":{"description":"Subscribed groups","items":{"type":"string"},"type":"array"},"subscribedUsers":{"description":"Subscribed users","items":{"type":"string"},"type":"array"},"timezone":{"default":0,"description":"Timezone offset in minutes from UTC (e.g. -60 = UTC-1)","type":"number"},"type":{"default":"onUpdate","description":"Subscription type","enum":["daily","monthly","onUpdate"],"type":"string"},"tzName":{"description":"Timezone name (e.g. Europe/Lisbon)","example":"Europe/Lisbon","type":"string"}},"required":["dashboardId","subscribedUsers","subscribedGroups","allowChangeSubscription"],"type":"object"},"ResponseUserAllowedToChangeSubscription":{"properties":{"allowed":{"description":"Indicates if the user is allowed to change subscription","type":"boolean"}},"required":["allowed"],"type":"object"},"ResponseUserSubscriptionConfigurationDto":{"properties":{"_id":{"description":"Subscription configuration ID","type":"string"},"created":{"description":"When created","example":"2025-08-12T12:47:59.530Z","format":"date-time","type":"string"},"dashboardId":{"description":"Dashboard Id","type":"string"},"emailSettings":{"allOf":[{"$ref":"#/definitions/EmailSettings"}],"default":{"isEmail":true,"isPdf":false},"description":"Email report format settings. `isEmail` — Embedded in email, `isPdf` — PDF attachment","example":{"isEmail":true,"isPdf":false}},"executionPerDay":{"default":1,"description":"Defines how many emails per day can be send","maximum":24,"minimum":1,"type":"number"},"isDataChange":{"default":false,"description":"Indicates if the subscription triggered by data change or manually","type":"boolean"},"lastUpdated":{"description":"When last time updated","example":"2025-08-12T12:47:59.530Z","format":"date-time","type":"string"},"schedule":{"description":"Cron schedule expression","example":"0 8 * * * *","type":"string"},"startAt":{"description":"Start date in YYYY-MM-DD format","example":"2025-06-25","type":"string"},"subscribed":{"description":"Indicates if the user is subscribed","type":"boolean"},"timezone":{"default":0,"description":"Timezone offset in minutes from UTC (e.g. -60 = UTC-1)","type":"number"},"type":{"default":"onUpdate","description":"Subscription type","enum":["daily","monthly","onUpdate"],"type":"string"},"tzName":{"description":"Timezone name (e.g. Europe/Lisbon)","example":"Europe/Lisbon","type":"string"},"userId":{"description":"User Id for the subscription configuration","type":"string"}},"required":["dashboardId","subscribed"],"type":"object"},"plugin":{"type":"object","description":"Plugin object","properties":{"name":{"description":"plugin name","type":"string"},"version":{"description":"version of plugin","type":["string","number"]},"lastUpdate":{"description":"last time plugin updated","type":"string"},"isEnabled":{"description":"enabled/disabled plugin status","type":"boolean"},"folderName":{"description":"plugin folder name","type":"string"}}},"getPlugins":{"type":"object","description":"Plugin response model","properties":{"plugins":{"type":"array","items":{"type":"object","description":"Plugin object","properties":{"name":{"description":"plugin name","type":"string"},"version":{"description":"version of plugin","type":["string","number"]},"lastUpdate":{"description":"last time plugin updated","type":"string"},"isEnabled":{"description":"enabled/disabled plugin status","type":"boolean"},"folderName":{"description":"plugin folder name","type":"string"}}}},"count":{"description":"amount of plugins","type":"number"},"queryMetadata":{"type":"object","properties":{"limit":{"description":"limit of items to return","type":"number"},"skip":{"description":"number of items to skip","type":"number"},"search":{"description":"filter by provided string","type":"string"},"orderby":{"description":"order by specific field","type":"string"},"tenantId":{"description":"tenantId field","type":"string"},"desc":{"description":"sort by descending or ascending","type":"boolean"}}}}},"newPlugins":{"description":"Plugin updated response model","type":"array","items":{"type":"object","description":"Plugin object","properties":{"name":{"description":"plugin name","type":"string"},"version":{"description":"version of plugin","type":["string","number"]},"lastUpdate":{"description":"last time plugin updated","type":"string"},"isEnabled":{"description":"enabled/disabled plugin status","type":"boolean"},"folderName":{"description":"plugin folder name","type":"string"}}}},"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"},"logref":{"type":"string"}}},"baseApiError":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}},"notFoundApiError":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}},"unauthorizedApiError":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}},"badRequestApiError":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}},"forbiddenApiError":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}},"unprocessableEntityApiError":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"subErrors":{"type":"array","items":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}}}]}}},"tooManyRequestsApiError":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}},"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"detail":{"type":"string","description":"Additional details about the rate limit error"}}}]}}},"internalServerApiError":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}},"gatewayTimeouError":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}},"payloadTooLargeError":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}},"baseEmailServer":{"type":"object","properties":{"enable":{"type":"boolean","description":"If TRUE enable email server instead of default."},"maxRecipientsPerType":{"type":"integer","description":"Maximum number of recipients per type."},"host":{"type":"string","description":"Hostname or IP address to connect to."},"port":{"type":"integer","description":"Port to connect to."},"secure":{"type":"boolean","default":false,"description":"If TRUE the connection will only use TLS. If false (the default), TLS may still be upgraded to if available via the STARTTLS command."},"ignoreTLS":{"type":"boolean","default":false,"description":"If this is TRUE and secure is FALSE, TLS will not be used (either to connect, or as a STARTTLS connection upgrade command)."},"requireTLS":{"type":"boolean","default":false,"description":"If this is TRUE and secure is FALSE, it forces application to use STARTTLS even if the server does not advertise support for it."},"connectionTimeout":{"type":"integer","minimum":0,"default":10000,"description":"How many milliseconds to wait for the connection to establish."},"greetingTimeout":{"type":"integer","minimum":0,"default":5000,"description":"How many milliseconds to wait for the greeting after connection is established."},"socketTimeout":{"type":"integer","minimum":0,"default":5000,"description":"How many milliseconds of inactivity to allow."},"user":{"type":"string","description":"User name."},"pass":{"type":"string","description":"User password."},"logger":{"type":"boolean","default":false,"description":"If set to true then logs to console. If value is not set or is false then nothing is logged."},"debug":{"type":"boolean","default":false,"description":"If set to true, then logs SMTP traffic, otherwise logs only transaction events."},"customAuthMethod":{"type":"string","description":"Custom authentication method (NTLM)"},"type":{"type":"string","description":"SMTP or Mandrill"},"apiKey":{"type":"string","description":"Mandrill API Key"},"workstation":{"type":"string","description":"NTLM workstation"},"domain":{"type":"string","description":"NTML domain"},"senderName":{"type":"string","description":"Name of sender."},"senderEmail":{"type":"string","description":"Email of sender."}}},"emailServer":{"type":"object","required":["enable","host","port"],"properties":{"enable":{"type":"boolean","description":"If TRUE enable email server instead of default."},"maxRecipientsPerType":{"type":"integer","description":"Maximum number of recipients per type."},"host":{"type":"string","description":"Hostname or IP address to connect to."},"port":{"type":"integer","description":"Port to connect to."},"secure":{"type":"boolean","default":false,"description":"If TRUE the connection will only use TLS. If false (the default), TLS may still be upgraded to if available via the STARTTLS command."},"ignoreTLS":{"type":"boolean","default":false,"description":"If this is TRUE and secure is FALSE, TLS will not be used (either to connect, or as a STARTTLS connection upgrade command)."},"requireTLS":{"type":"boolean","default":false,"description":"If this is TRUE and secure is FALSE, it forces application to use STARTTLS even if the server does not advertise support for it."},"connectionTimeout":{"type":"integer","minimum":0,"default":10000,"description":"How many milliseconds to wait for the connection to establish."},"greetingTimeout":{"type":"integer","minimum":0,"default":5000,"description":"How many milliseconds to wait for the greeting after connection is established."},"socketTimeout":{"type":"integer","minimum":0,"default":5000,"description":"How many milliseconds of inactivity to allow."},"user":{"type":"string","description":"User name."},"pass":{"type":"string","description":"User password."},"logger":{"type":"boolean","default":false,"description":"If set to true then logs to console. If value is not set or is false then nothing is logged."},"debug":{"type":"boolean","default":false,"description":"If set to true, then logs SMTP traffic, otherwise logs only transaction events."},"customAuthMethod":{"type":"string","description":"Custom authentication method (NTLM)"},"type":{"type":"string","description":"SMTP or Mandrill"},"apiKey":{"type":"string","description":"Mandrill API Key"},"workstation":{"type":"string","description":"NTLM workstation"},"domain":{"type":"string","description":"NTML domain"},"senderName":{"type":"string","description":"Name of sender."},"senderEmail":{"type":"string","description":"Email of sender."}}},"publicSettings":{"type":"object","required":["firstday"],"properties":{"firstday":{"type":"string","description":"Name of the first day of week"},"language":{"type":"string","description":"Language for localization"}}},"globalizationSettings":{"type":"object","properties":{"language":{"type":"string","description":"Default language for localization."},"localization":{"type":"object","properties":{"default":{"type":"string","description":"Default locale for localization."},"autoDetectEnabled":{"type":"boolean","description":"If language autodetect is enabled."}}}}},"ssoSettings":{"additionalProperties":false,"type":"object","properties":{"enabled":{"type":"boolean","description":"If SSO is enabled."},"ssoType":{"type":"string","description":"Type of SSO.","default":"jwt"},"userCreationDisabled":{"type":"boolean","description":"This property enable/disable the automatic creation of users through SSO.","default":false},"nonSsoUsersCanChangePassword":{"type":"boolean","description":"This property enable/disable the ability for non-Admins non-SSO users to change their password.","default":false},"nonSsoUsersCanChangePasswordFeatureToggle":{"type":"boolean","description":"This property enable/disable the visibility of nonSsoUsersCanChangePassword on the admin page","default":false},"loginUrl":{"type":"string","description":"This is the URL that Sisense will invoke to attempt remote JWT authentication."},"logoutUrl":{"type":"string","description":"This is the URL that Sisense will return users to after they log out in case of JWT."},"sharedSecret":{"type":"string","description":"Used in the token generation script."},"loginUrlSaml":{"type":"string","description":"This is the URL that Sisense will invoke to attempt remote authentication via SAML."},"logoutUrlSaml":{"type":"string","description":"This is the URL that Sisense will return users to after they log out via SAML."},"idPCert":{"type":"string","description":"This is the certificate of identity provider."},"lowSecurityJwtSso":{"type":"boolean","description":"Allow lower level security by disabling JTI enforcement.","default":false},"emailClaim":{"type":"string","description":"Claim that will be used to retrieve the user's email from the profile object. Default claim is \"email\" for OIDC, \"sub\" for JWT and \"User.Email\" for SAML"},"firstNameClaim":{"type":"string","description":"Claim that will be used to retrieve the user's firstName from the profile object. Default claim is \"firstName\" for OIDC, \"sub for JWT and \"User.firstName\" for SAML"},"lastNameClaim":{"type":"string","description":"Claim that will be used to retrieve the user's lastName from the profile object. Default claim is \"lastName\" for OIDC, \"sub for JWT and \"User.lastName\" for SAML"},"groupClaim":{"type":"string","description":"Claim that will be used to retrieve the list of user's groups from the profile object. Default claim is \"groups\" for JWT/OIDC and \"memberOf\" for SAML"},"themeClaim":{"type":"string","description":"Claim that will be used to retrieve the theme Id of for the user profile object. Default claim is \"themeId\""},"useDefaults":{"type":"boolean","description":"SSO authentication mode (default role and groups vs group to role pairing)","default":true},"defaultRole":{"type":"string","description":"Default role for users in default mode"},"defaultGroups":{"type":"array","description":"Default groups for users in default mode","items":{"type":"string"}},"groupToRolePairing":{"type":"array","description":"Groups to roles pairing list","items":{"type":"object","properties":{"group":{"type":"string","description":"Group id"}}}},"associateWithPairs":{"type":"boolean","description":"Indicates if we need to assign to users all groups that exists in Sisense and in their profile object"},"oidc":{"type":"object","properties":{"issuer":{"type":"string","description":"The server identifier, typically the base URL of the server, using the https scheme"},"authorizationURL":{"type":"string","description":"The authorization URL used by a Relying Party when making a request for a user’s identity"},"tokenURL":{"type":"string","description":"The URL that returns access token, ID token, and refresh token"},"userInfoURL":{"type":"string","description":"The URL that returns information about the currently signed-in user"},"clientID":{"type":"string","description":"Client identifier of the Relying Party of the OpenID Provider"},"clientSecret":{"type":"string","description":"Client secret registered with the OpenID Provider"},"scope":{"type":"string","description":"Specify the scope of the requested authorization (comma-separated values, 'openid' tag are appended automatically)"},"logoutURL":{"type":"string","description":"Logout URL"}}},"saml":{"type":"object","description":"SAML configuration settings","properties":{"issuer":{"type":"string","description":"The SAML issuer identifier","default":"Sisense"},"NameIdPolicy":{"type":"string","description":"The NameID policy format for SAML assertions","default":"urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress"},"PassAuthnContext":{"type":"boolean","description":"Whether to pass authentication context in SAML requests","default":true}}}}},"systemSettings":{"type":"object","properties":{"_id":{"type":"string","description":"ID of config."},"alias":{"type":"string","description":"Web server public address."},"firstday":{"type":"string","description":"First day of the week for date related ElastiCube queries."},"usage":{"type":"object","description":"Usage Analytics feature properties block.","properties":{"enabled":{"type":"boolean","description":"Usage Analytics feature status."},"restoreDashboards":{"type":"boolean","description":"On Usage Analytics feature enabling, system should restore dashboards, by default system restore dashboards on first Usage Analytics feature turn on."},"retentionPeriodDays":{"type":"number","minimum":1,"default":30,"description":"Usage analytics retention period in days"}}},"fiscal":{"type":"object","description":"Fiscal Year.","properties":{"month":{"type":"string","enum":["jan","feb","mar","apr","may","jun","jul","aug","sep","oct","nov","dec"]},"format":{"type":"string"}}},"dashboardAdministration":{"type":"object","description":"Allow admin access for all dashboards","properties":{"enabled":{"type":"boolean"}}},"displayName":{"type":"object","description":"Enable assigning table/column Display Name to be used in Analytics interface. Using Display Name enables renaming tables/columns in data models without disrupting their dependent dashboards and widgets.","properties":{"enabled":{"type":"boolean"},"useNewSearchByDisplayNameApi":{"type":"boolean"}}},"dashboardCoAuthoring":{"type":"object","description":"Allow multiple users or groups to co-own dashboards","properties":{"enabled":{"type":"boolean"},"inactivityLockTimeoutMinutes":{"type":"number","minimum":60,"maximum":525600,"default":240,"description":"Number of minutes of inactivity before a co-authored dashboard lock is automatically released. Minimum 60 (1 hour), Maximum 525600 (1 year)."}}},"sharedFormulas":{"type":"object","description":"Shared Formulas feature properties block.","properties":{"enabled":{"type":"boolean","description":"Shared Formulas feature status."}}},"dataExplore":{"type":"object","description":"Data Explore feature status","properties":{"enabled":{"type":"boolean"}}},"email":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If mails are enabled.","default":true},"senderEmail":{"type":"string","description":"Email of sender."},"senderName":{"type":"string","description":"Name of sender."},"typesOfEmails":{"type":"object","properties":{"aDGroupInvitationEmailEnabled":{"type":"boolean","description":"AD group invitation email toggle. Sent when the user is added to the AD group.","default":true},"accountActivationEmailEnabled":{"type":"boolean","description":"If enabled Sisense will send a new user invitation to the new user.","default":true},"buildAlertCommonEmailEnabled":{"type":"boolean","description":"Build Alert toggle. Sent each time an alert build is triggered.","default":true},"buildFailureAlertEmailEnabled":{"type":"boolean","description":"Build Failure Alert toggle. Sent each time a failed alert build is triggered.","default":true},"buildSuccessAlertEmailEnabled":{"type":"boolean","description":"Build Success Alert toggle. Sent each time a successful alert build is triggered.","default":true},"changeDashboardOwnershipEmailEnabled":{"type":"boolean","description":"Transfer Ownership toggle. Sent to a user who received ownership of a dashboard from another user.","default":true},"dashboardErrorReportBulkFailEmailEnabled":{"type":"boolean","description":"Dashboard Errors Reports toggle. Sent when a dashboard report fails.","default":true},"dashboardErrorReportEmailEnabled":{"type":"boolean","description":"Dashboard Errors Reports toggle. Sent when a dashboard report fails.","default":true},"dashboardReportEmailEnabled":{"type":"boolean","description":"Dashboard Reports toggle. Dashboard scheduled email reports sent when enabled.","default":true},"kpiAlertEmailEnabled":{"type":"boolean","description":"KPI Alert toggle. Sent each time a KPI alert is triggered.","default":true},"newUserInvitationEmailEnabled":{"type":"boolean","description":"New User Invitation toggle. Sent to a new user invited to Sisense.","default":true},"newUserResendInvitationEmailEnabled":{"type":"boolean","description":"New User Invitation resend toggle. Resend to a new user invited to Sisense.","default":true},"resendInvitationEmailEnabled":{"type":"boolean","description":"Password Recovery toggle. Sent to a user who requested a new password.","default":true},"shareDashboardWithGroupEmailEnabled":{"type":"boolean","description":"Share dashboard with a group toggle. Sent an email to the group users.","default":true},"shareDashboardWithNewUserEmailEnabled":{"type":"boolean","description":"Share dashboard with a newly created user toggle.","default":true},"shareDashboardWithUserEmailEnabled":{"type":"boolean","description":"Share dashboard with existing user toggle. Sent to the recipient of a shared dashboard.","default":true},"shareElasticubeEmailEnabled":{"type":"boolean","description":"Share ElastiCube toggle. Sent to the recipient of a newly shared ElastiCube.","default":true},"userCreatedADEmailEnabled":{"type":"boolean","description":"User Created AD toggle. Sent when a user is created in Sisense after being added from Active Directory.","default":true},"userCreatedEmailEnabled":{"type":"boolean","description":"User Created toggle. Sent to a user when a user is created.","default":true}}}}},"webServer":{"type":"object","properties":{"enableSSl":{"type":"boolean","description":"If SSL is enabled."},"cors":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If cors settings is enabled."},"allowedOrigins":{"type":"array","items":{"type":"string"}}}}}},"authentication":{"type":"object","properties":{"domainGroupLogin":{"type":"boolean"},"apiTokenExpiration":{"type":"boolean"}}},"fileManagement":{"description":"Switches the ability to use the file server from the system management","type":"object","properties":{"enabled":{"type":"boolean"}}},"inviteNewUsersOnShare":{"description":"Switches the ability to invite (create) new non-sisense users while sharing a specific dashboard","type":"object","properties":{"enabled":{"type":"boolean"}}},"userActivationLinkExpiration":{"type":"number","minimum":1,"maximum":365,"default":7,"description":"User activation link expiration (days)."},"support":{"description":"Support access control","type":"object","properties":{"enabled":{"type":"boolean","description":"When \"true\", Sisense Support personnel can access your account\n"},"enabledUntil":{"type":"string","description":"Support access is enabled until this date and time, and disabled afterwards.\n"},"duration":{"type":"string","description":"Duration of time support user is turned on for.\n"}}},"newAdminUI":{"type":"object","description":"Set of feature toggles that allows to switch between the new Admin UI and the legacy one.","properties":{"enableNewAdminUI":{"type":"boolean","description":"switch between new Admin UI and the legacy one","default":false},"enableNewGeneralSettingsPage":{"type":"boolean","description":"If enabled will show the new UI for the General Settings page.","default":false},"enableNewLicensePage":{"type":"boolean","description":"If enabled will show the new UI for the License Utilization page.","default":false},"enableNewFeaturesPage":{"type":"boolean","description":"If enabled will show the new UI for the Features Settings page.","default":false},"enableNewSecurityPage":{"type":"boolean","description":"If enabled will show the new UI for the Security Settings page.","default":false},"enableNewSSOPage":{"type":"boolean","description":"If enabled will show the new UI for the SSO Settings page.","default":false},"enableUpgradePage":{"type":"boolean","description":"If enabled will show the Upgrade center page.","default":true},"enableHomePage":{"type":"boolean","description":"If enabled will show the new UI for the Home page.","default":false},"enableUsersPage":{"type":"boolean","description":"If enabled will show the new UI for the Users page.","default":false},"enableNewAdminNavigation":{"type":"boolean","description":"If enabled will show the new UI for the Admin navigation.","default":false},"enableConnectorsManagementPage":{"type":"boolean","description":"If enabled will show the new Connection management page.","default":false}}},"widgets":{"type":"object","properties":{"widgetDesignStyle":{"type":"boolean"}}},"widgetQueryLimit":{"type":"object","properties":{"chart_pie":{"type":"number","default":20000},"chart_column":{"type":"number","default":20000},"chart_bar":{"type":"number","default":20000},"chart_line":{"type":"number","default":20000},"chart_area":{"type":"number","default":20000},"chart_scatter":{"type":"number","default":20000},"chart_polar":{"type":"number","default":20000},"map_scatter":{"type":"number","default":5000},"map_area":{"type":"number","default":5000},"tablewidget":{"type":"number","default":220},"chart_funnel":{"type":"number","default":50},"indicator":{"type":"number","default":50000},"treemap":{"type":"number","default":50000},"heatmap":{"type":"number","default":50000},"sunburst":{"type":"number","default":50000},"chart_boxplot":{"type":"number","default":50000}}}}},"pulseSettings":{"type":"object","properties":{"name":{"type":"string","description":"Name of configuration.","default":"pulse"},"script":{"type":"string","description":"Pulse page extension script.","default":""}}},"pivotSettings":{"type":"object","properties":{"limit":{"type":"integer","description":"Limit of the number of records at the query level.","default":10000,"minimum":0},"columnsLimit":{"type":"integer","description":"Max columns count in pivot.","default":70,"minimum":1},"allowHtml":{"type":"boolean","description":"Allow render html in pivot2 cells","default":false},"distinctTotals":{"type":"object","properties":{"default":{"type":"object","properties":{"value":{"type":"boolean","description":"Allow Distinct Totals by default.","default":false}}},"perMeasure":{"type":"object","properties":{"value":{"type":"boolean","description":"Allow to change Distinct Totals manually on each pivot.","default":false}}}}}}},"loginLockoutSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is login lockout enabled"},"maxFailedAttempts":{"type":"number","description":"Number of failed attempts to cause lockout"},"failedAttemptsPeriod":{"type":"number","description":"Time period for counting failed attempts (in minutes)"},"lockoutPeriod":{"type":"number","description":"Time period user will be locked out for (in minutes)"}}},"configurationServices":{"type":"array","items":{"type":"string"}},"configurations":{"type":"object"},"userParameter":{"type":"object","properties":{"_id":{"type":"string","description":"The OID of user-parameter"},"name":{"type":"string","description":"The name of user-parameter"},"displayName":{"type":"string","description":"The displayname of user-parameter on client"},"type":{"type":"string","enum":["string","number","boolean","integer"],"description":"The type of user-parameter, is an enum of string, number, boolean, or integer"},"applicableAreas":{"type":"array","items":{"type":"string","enum":["Connections","Custom Live Queries","Management Console"],"description":"The appliсation area, array of enums"}},"hidden":{"type":"boolean","default":false},"description":{"type":"string","description":"Description of user-parameter"},"users":{"type":"object","description":"Object of users, where key is user OID","additionalProperties":{"type":"object","required":["contextId","contextType","value"],"properties":{"contextId":{"type":"string","description":"User's OID"},"contextType":{"type":"string","enum":["users"],"description":"Member type"},"value":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"User-parameter value for the user"},"priority":{"type":"integer","description":"Priority of user-parameter for the user"}}},"example":{"5f02edfab456d2002c1b29dc":{"contextId":"5f02edfab456d2002c1b29dc","contextType":"users","value":"user.email@sisense.com","priority":0}}},"groups":{"type":"object","description":"Object of groups, where key is group OID","additionalProperties":{"type":"object","required":["contextId","contextType","value","priority"],"properties":{"contextId":{"type":"string","description":"Group's OID"},"contextType":{"type":"string","enum":["groups"],"description":"Member type"},"value":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"User-parameter value for the group"},"priority":{"type":"integer","description":"Priority of user-parameter for the group"}}},"example":{"5f02edfab456d2002c1b29dc":{"contextId":"5f02edfab456d2002c1b29dc","contextType":"groups","value":"group.email@sisense.com","priority":0}}},"default":{"type":"object","properties":{"contextType":{"type":"string","enum":["default"],"description":"Member type"},"value":{"type":"string","description":"User-parameter value by default"}},"example":{"default":{"contextType":"default","value":"default.email@sisense.com"}}}}},"createUserParameter":{"type":"object","required":["name","displayName","type","applicableAreas","hidden"],"properties":{"name":{"type":"string","description":"The name of user-parameter"},"displayName":{"type":"string","description":"The displayname of user-parameter on client"},"type":{"type":"string","enum":["string","number","boolean","integer"],"description":"The type of user-parameter, is an enum of string, number, boolean, or integer"},"applicableAreas":{"type":"array","items":{"type":"string","enum":["Connections","Custom Live Queries","Management Console"],"description":"The appliсation area, array of enums"}},"hidden":{"type":"boolean","default":false},"description":{"type":"string","description":"Description of user-parameter"},"users":{"type":"object","description":"Object of users, where key is user OID","additionalProperties":{"type":"object","required":["contextId","contextType","value"],"properties":{"contextId":{"type":"string","description":"User's OID"},"contextType":{"type":"string","enum":["users"],"description":"Member type"},"value":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"User-parameter value for the user"},"priority":{"type":"integer","description":"Priority of user-parameter for the user"}}},"example":{"5f02edfab456d2002c1b29dc":{"contextId":"5f02edfab456d2002c1b29dc","contextType":"users","value":"user.email@sisense.com","priority":0}}},"groups":{"type":"object","description":"Object of groups, where key is group OID","additionalProperties":{"type":"object","required":["contextId","contextType","value","priority"],"properties":{"contextId":{"type":"string","description":"Group's OID"},"contextType":{"type":"string","enum":["groups"],"description":"Member type"},"value":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"User-parameter value for the group"},"priority":{"type":"integer","description":"Priority of user-parameter for the group"}}},"example":{"5f02edfab456d2002c1b29dc":{"contextId":"5f02edfab456d2002c1b29dc","contextType":"groups","value":"group.email@sisense.com","priority":0}}},"default":{"type":"object","properties":{"contextType":{"type":"string","enum":["default"],"description":"Member type"},"value":{"type":"string","description":"User-parameter value by default"}},"example":{"default":{"contextType":"default","value":"default.email@sisense.com"}}}}},"updateUserParameter":{"type":"object","properties":{"_id":{"type":"string","description":"The OID of user-parameter"},"name":{"type":"string","description":"The name of user-parameter"},"displayName":{"type":"string","description":"The displayname of user-parameter on client"},"type":{"type":"string","enum":["string","number","boolean","integer"],"description":"The type of user-parameter, is an enum of string, number, boolean, or integer"},"applicableAreas":{"type":"array","items":{"type":"string","enum":["Connections","Custom Live Queries","Management Console"],"description":"The appliсation area, array of enums"}},"hidden":{"type":"boolean","default":false},"description":{"type":"string","description":"Description of user-parameter"},"users":{"type":"object","description":"Object of users, where key is user OID","additionalProperties":{"type":"object","required":["contextId","contextType","value"],"properties":{"contextId":{"type":"string","description":"User's OID"},"contextType":{"type":"string","enum":["users"],"description":"Member type"},"value":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"User-parameter value for the user"},"priority":{"type":"integer","description":"Priority of user-parameter for the user"}}},"example":{"5f02edfab456d2002c1b29dc":{"contextId":"5f02edfab456d2002c1b29dc","contextType":"users","value":"user.email@sisense.com","priority":0}}},"groups":{"type":"object","description":"Object of groups, where key is group OID","additionalProperties":{"type":"object","required":["contextId","contextType","value","priority"],"properties":{"contextId":{"type":"string","description":"Group's OID"},"contextType":{"type":"string","enum":["groups"],"description":"Member type"},"value":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"User-parameter value for the group"},"priority":{"type":"integer","description":"Priority of user-parameter for the group"}}},"example":{"5f02edfab456d2002c1b29dc":{"contextId":"5f02edfab456d2002c1b29dc","contextType":"groups","value":"group.email@sisense.com","priority":0}}},"default":{"type":"object","properties":{"contextType":{"type":"string","enum":["default"],"description":"Member type"},"value":{"type":"string","description":"User-parameter value by default"}},"example":{"default":{"contextType":"default","value":"default.email@sisense.com"}}}}},"listUserParameters":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","description":"The OID of user-parameter"},"name":{"type":"string","description":"The name of user-parameter"},"displayName":{"type":"string","description":"The displayname of user-parameter on client"},"type":{"type":"string","enum":["string","number","boolean","integer"],"description":"The type of user-parameter, is an enum of string, number, boolean, or integer"},"applicableAreas":{"type":"array","items":{"type":"string","enum":["Connections","Custom Live Queries","Management Console"],"description":"The appliсation area, array of enums"}},"hidden":{"type":"boolean","default":false},"description":{"type":"string","description":"Description of user-parameter"}}}},"bulkDeleteUserParameters":{"type":"array","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"}},"getUserParameter":{"type":"object","properties":{"_id":{"type":"string","description":"The OID of user-parameter"},"name":{"type":"string","description":"The name of user-parameter"},"displayName":{"type":"string","description":"The displayname of user-parameter on client"},"type":{"type":"string","enum":["string","number","boolean","integer"],"description":"The type of user-parameter, is an enum of string, number, boolean, or integer"},"applicableAreas":{"type":"array","items":{"type":"string","enum":["Connections","Custom Live Queries","Management Console"],"description":"The appliсation area, array of enums"}},"hidden":{"type":"boolean","default":false},"description":{"type":"string","description":"Description of user-parameter"},"users":{"type":"object","description":"Object of users, where key is user OID","additionalProperties":{"type":"object","properties":{"contextId":{"type":"string","description":"User's OID"},"contextType":{"type":"string","enum":["users"],"description":"Member type"},"value":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"User-parameter value for the user"},"priority":{"type":"integer","description":"Priority of user-parameter for the user"},"email":{"type":"string","description":"User's email"},"userName":{"type":"string","description":"User's name"}}},"example":{"5f02edfab456d2002c1b29dc":{"contextId":"5f02edfab456d2002c1b29dc","contextType":"users","value":12345,"priority":0,"email":"user.email@sisense.com","userName":"name"}}},"groups":{"type":"object","description":"Object of groups, where key is group OID","additionalProperties":{"type":"object","properties":{"contextId":{"type":"string","description":"Group's OID"},"contextType":{"type":"string","enum":["groups"],"description":"Member type"},"value":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"User-parameter value for the group"},"priority":{"type":"integer","description":"Priority of user-parameter for the group"},"groupName":{"type":"string","description":"Name of the group"}}},"example":{"5f02edfab456d2002c1b29dc":{"contextId":"5f02edfab456d2002c1b29dc","contextType":"groups","value":"group.email@sisense.com","priority":0,"groupName":"Admins"}}},"default":{"type":"object","properties":{"contextType":{"type":"string","enum":["default"],"description":"Member type"},"value":{"type":"string","description":"User-parameter value by default"}},"example":{"default":{"contextType":"default","value":"default.email@sisense.com"}}}}},"bulkUserParameterOperationRequest":{"type":"array","description":"User parameter assigned values to be modified","items":{"type":"object","required":["op","path"],"properties":{"op":{"type":"string","description":"Operation type to be performed","enum":["add","update","remove"],"example":"update"},"path":{"type":"string","description":"The object to perform the operation on. The root defines the value assignment type: `/users`, `/groups` or `/default`. The ID must be specified for `/users` and `/groups`.\n","pattern":"^\\/users\\/[0-9a-fA-F]{24}$|^\\/groups\\/[0-9a-fA-F]{24}$|^\\/default$","example":"/users/61f16367832227001b55e9eb"},"value":{"type":"object","properties":{"value":{"type":["string","number","boolean","object","array","null"],"description":"User parameter value to be assigned. Can be `string` or `number`","example":"administrator"},"priority":{"type":"integer","description":"Priority of user parameter value for a given group. Must be provided for `/groups` value","example":5}}}}}},"bulkUserParameterOperationResponse":{"type":"object","properties":{"changed":{"type":"array","description":"A list of successful operations","items":{"type":"object","required":["op","path"],"properties":{"op":{"type":"string","description":"Operation type to be performed","enum":["add","update","remove"],"example":"update"},"path":{"type":"string","description":"The object to perform the operation on. The root defines the value assignment type: `/users`, `/groups` or `/default`. The ID must be specified for `/users` and `/groups`.\n","pattern":"^\\/users\\/[0-9a-fA-F]{24}$|^\\/groups\\/[0-9a-fA-F]{24}$|^\\/default$","example":"/users/61f16367832227001b55e9eb"},"value":{"type":"object","properties":{"value":{"type":["string","number","boolean","object","array","null"],"description":"User parameter value to be assigned. Can be `string` or `number`","example":"administrator"},"priority":{"type":"integer","description":"Priority of user parameter value for a given group. Must be provided for `/groups` value","example":5}}}}}},"errors":{"type":"array","description":"A list of failed operations","items":{"type":"object","properties":{"op":{"type":"string","description":"Operation type to be performed","enum":["add","update","remove"],"example":"update"},"path":{"type":"string","description":"The object to perform the operation on. The root defines the value assignment type: `/users`, `/groups` or `/default`. The ID must be specified for `/users` and `/groups`.\n","pattern":"^\\/users\\/[0-9a-fA-F]{24}$|^\\/groups\\/[0-9a-fA-F]{24}$|^\\/default$","example":"/users/61f16367832227001b55e9eb"},"error":{"type":"object","properties":{"message":{"type":"string","description":"Error message","example":"Cannot perform 'update' operation at the non-existing path"}}}}}}}},"user":{"type":"object","properties":{"_id":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"email":{"type":"string","pattern":"^(([^<>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z\\-0-9]{2,})|([a-zA-Z\\-0-9]+))$"},"userName":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleId":{"type":"string"},"active":{"type":"boolean"},"groups":{"type":"array","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"}},"adgroups":{"type":"array","items":{"type":"string","pattern":"^\\[\\d{1,3}(?:,\\d{1,3}){27}\\]$"}},"activeDirectory":{"type":"boolean"},"principalName":{"type":"string"},"objectSid":{"type":"string"},"uSNChanged":{"type":"string"},"dn":{"type":"string"},"preferences":{"type":"object","properties":{"localeId":{"type":["string","null"]},"language":{"type":["string","null"]}}},"uiSettings":{"type":"object"},"created":{"type":"string","format":"date-time"},"lastLogin":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"},"ldapDomainId":{"type":"string"},"pendingExpiration":{"type":"string","format":"date-time"},"createdSso":{"type":"string"},"requireTwoFactorAuth":{"type":"boolean","default":false,"description":"Whether two-factor authentication is required for this user. If not provided, defaults to false for new users."}}},"sisenseUser":{"type":"object","properties":{"email":{"type":"string","pattern":"^(([^<>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z\\-0-9]{2,})|([a-zA-Z\\-0-9]+))$"},"userName":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"groups":{"type":"array","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"}},"preferences":{"type":"object","properties":{"localeId":{"type":["string","null"]}}},"uiSettings":{"type":"object"},"requireTwoFactorAuth":{"type":"boolean","default":false,"description":"Whether two-factor authentication is required for this user. If not provided, defaults to false for new users."}}},"adUser":{"type":"object","required":["userName","ldapDomainId"],"properties":{"userName":{"type":"string"},"ldapDomainId":{"type":"string"},"roleId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"groups":{"type":"array","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"}},"objectSid":{"type":"string","pattern":"^\\[\\d{1,3}(?:,\\d{1,3}){27}\\]$"},"preferences":{"type":"object","properties":{"localeId":{"type":["string","null"]}}},"uiSettings":{"type":"object"}}},"device":{"type":"object","properties":{"deviceId":{"type":"string"},"token":{"type":"string"}}},"userPreferences":{"type":"object","properties":{"localeId":{"type":["string","null"]},"language":{"type":["string","null"]}}},"userUiSettings":{"type":"object","properties":{"ecmNext":{"type":"object","properties":{"guidersShown":{"type":"object","properties":{"ecActions":{"type":"boolean"}}},"tagsColors":{"type":"array","maxItems":200,"items":{"type":"object","additionalProperties":false,"required":["tagText","tagColor"],"properties":{"tagText":{"type":"string"},"tagColor":{"type":"string"}}}}}},"admin":{"type":"object","properties":{"customEmailServerNotification":{"type":"object","properties":{"lastClosedAt":{"type":"string","format":"date-time"}}},"tenantsUiSettings":{"type":"object","properties":{"tenantsRowsOnPage":{"type":"number"}}}}}}},"group":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"language":{"type":"string"},"mail":{"type":"string"},"ad":{"type":"boolean"},"roleId":{"type":"string","pattern":"(^[0-9a-fA-F]{24}$|^[Nn][Uu][Ll]{2}$)"},"defaultRole":{"type":"string"},"objectSid":{"type":"string","pattern":"^\\[\\d{1,3}(?:,\\d{1,3}){27}\\]$"},"dn":{"type":"string"},"uSNChanged":{"type":"string"},"created":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"themeId":{"type":"string"},"excludeFromSharing":{"type":"boolean","default":false}}},"sisenseGroup":{"type":"object","properties":{"name":{"type":"string"},"excludeFromSharing":{"type":"boolean","default":false}}},"adGroup":{"type":"object","properties":{"name":{"type":"string"},"cn":{"type":"string"},"roleId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"objectSid":{"type":"string","pattern":"^\\[\\d{1,3}(?:,\\d{1,3}){27}\\]$"},"dn":{"type":"string"}}},"updateResult":{"type":"object","properties":{"updateCount":{"type":"integer"}}},"reassignThemes":{"type":"object","properties":{"from":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","example":"themeOid","description":"old theme object id (oid)"},"to":{"type":"string","example":"themeOid","pattern":"^[0-9a-fA-F]{24}$","description":"new theme object id (oid)"}}},"reassignThemesResponse":{"type":"object","properties":{"from":{"type":"string","description":"old theme object id (oid)"},"to":{"type":"string","description":"new theme object id (oid)"},"affectedGroups":{"type":"integer","description":"amount of affected groups"}}},"beginResetPassword":{"type":"object","required":["email"],"properties":{"email":{"type":"string"},"tenant":{"type":"string"}}},"resetPasswordpass":{"type":"object","required":["password"],"properties":{"password":{"type":"string"}}},"changePassword":{"type":"object","required":["currentPassword","newPassword"],"properties":{"currentPassword":{"type":"string"},"newPassword":{"type":"string"}}},"tokenedUserResponse":{"type":"object","required":["userName"],"properties":{"userName":{"type":"string"}}},"beginActivate":{"type":"object","required":["email"],"properties":{"email":{"type":"string","pattern":"^(([^<>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z\\-0-9]{2,})|([a-zA-Z\\-0-9]+))$"}}},"beginActivateBulk":{"type":"array","items":{"type":"string","pattern":"^(([^<>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z\\-0-9]{2,})|([a-zA-Z\\-0-9]+))$"}},"licenseInformation":{"type":"object","properties":{"bigData":{"type":"boolean"},"expirationDate":{"type":"string"},"highAvailability":{"type":"boolean"},"inUseAdmins":{"type":"integer"},"inUseDesigners":{"type":"integer"},"inUseViewers":{"type":"integer"},"maxAdmins":{"type":"integer"},"maxDesigners":{"type":"integer"},"maxViewers":{"type":"integer"},"macine":{"type":"string"},"trial":{"type":"boolean"}}},"lockoutStatus":{"type":"object","properties":{"blocked":{"type":"boolean"},"blockedUntil":{"type":"string"}}},"emptyBody":{"type":"object"},"loginResponse":{"type":"object","required":["success","message","access_token","profile"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"access_token":{"type":"string"},"profile":{"type":"object"}}},"server":{"type":"object","required":["server"],"properties":{"server":{"type":"string"}}},"saveServer":{"type":"object","required":["token","cookieType","server","userName"],"properties":{"token":{"type":"string"},"cookieType":{"type":"string"},"server":{"type":"string"},"userName":{"type":"string"},"deviceId":{"type":"string"},"expiration":{"type":"string"},"issueDate":{"type":"string"},"serverSession":{"type":"string"}}},"serverAccess":{"type":"object","required":["serverName"],"properties":{"serverName":{"type":"string"},"name":{"type":"string"}}},"mongoUserObject":{"type":"object","required":["userName"],"properties":{"userName":{"type":"string"},"password":{"type":"string"}}},"ldapDomainRequest":{"type":"object","properties":{"enabled":{"type":"boolean"},"url":{"type":"string","pattern":"^ldap|ldaps\\:\\/\\/.+"},"baseDN":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"name":{"type":"string"},"syncActive":{"type":"boolean"},"syncInterval":{"type":"integer"},"forceSyncEnabled":{"type":"boolean"},"sslEnabled":{"type":"boolean"},"pfxCertificate":{"type":"string"},"pfxKey":{"type":"string"}}},"ldapDomainSyncRequest":{"type":"object","properties":{"force":{"description":"indicates if to sync all the changes from the Active Directory server since it was created","type":"boolean","default":false},"gnames":{"description":"groups to sync","type":"array","uniqueItems":true,"default":[],"items":{"type":"string"}},"unames":{"description":"users to sync","type":"array","uniqueItems":true,"default":[],"items":{"type":"string"}}}},"ldapDomainResponse":{"type":"object","properties":{"_id":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"enabled":{"type":"boolean"},"url":{"type":"string"},"baseDN":{"type":"string"},"username":{"type":"string"},"name":{"type":"string"},"syncUsn":{"type":"string"},"syncActive":{"type":"boolean"},"forceSyncEnabled":{"type":"boolean"},"syncInterval":{"type":"integer"},"sslEnabled":{"type":"boolean"}}},"ldapDomainTestRequest":{"type":"object","properties":{"_id":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"url":{"type":"string","pattern":"^ldap|ldaps\\:\\/\\/.+"},"baseDN":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"sslEnabled":{"type":"boolean"},"pfxCertificate":{"type":"string"},"pfxKey":{"type":"string"}}},"tenant":{"type":"object","properties":{"_id":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"name":{"type":"string"},"default":{"type":"boolean"},"shouldCreateSamples":{"type":"boolean"},"defaultDataGroupId":{"type":"string"}}},"newTenant":{"type":"object","required":["name","email","license"],"properties":{"name":{"type":"string"},"email":{"type":"string","pattern":"^(([^<>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z\\-0-9]{2,})|([a-zA-Z\\-0-9]+))$"},"password":{"type":"string"},"shouldCreateSamples":{"type":"boolean"},"defaultDataGroupId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"isExistingUser":{"type":"boolean"},"tenantDomainNames":{"type":"array","items":{"type":"string"}},"license":{"type":"object","properties":{"admins":{"type":"integer"},"contributors":{"type":"integer"},"consumers":{"type":"integer"}}}}},"generateWebAccessToken":{"type":"object","required":["header","payload","secret"],"properties":{"header":{"type":"object","description":"Includes type of token, encryption and compression algorithms, and unique identifier of the token configuration - kid.\nCheck [Using Web Access Tokens - Securing Users](https://documentation.sisense.com/docs/using-web-access-token) to see the exact list of required properties and their accepted values\n","properties":{"typ":{"description":"Defines the type of the token. The value must be `JWT`, as the only one supported at the moment.","example":"JWT"},"kid":{"description":"Key ID value of the created token configuration.","example":"6194f6b0326fd7003600126e"},"alg":{"description":"Encryption algorithm of the Content Encryption Key (CEK). The value must be `RSA-OAEP-256`, as the only one supported at the moment.","example":"RSA-OAEP-256"},"enc":{"description":"Encryption algorithm for the JWT claims. The value must be `A128GCM`, as the only one supported at the moment.","example":"A128GCM"},"zip":{"description":"Compression algorithm. The value must be `DEF` as the only one supported at the moment.","example":"DEF"}}},"payload":{"type":"object","description":"Consist of claims which are the statements defining end user’s permissions and experience of interacting with the assets.\nCheck [Using Web Access Tokens - Securing Users](https://documentation.sisense.com/docs/using-web-access-token) to see list of supported claims.\n","properties":{"sub":{"description":"ID of the Sisense user on behalf of whom the access is granted","example":"6128c62ea23e09002c411453"},"nbf":{"description":"Time before which the JWT MUST NOT be accepted for processing","example":1612707042},"exp":{"description":"Expiration time on, or after which, the JWT MUST NOT be accepted for processing","example":1757326503},"thm":{"description":"String identifies session UI theme id.","example":"61f72cb3867f3f001bec0002"},"lng":{"description":"Language of the Sisense interface","example":"fr-FR"},"grants":{"description":"Parental structure claim for permissions. Permission claims entered outside of “grants” are ignored","properties":{"res":{"description":"Specifies the list of dashboards that are allowed to be accessed via the Web Access Token","example":["dashboards/5fe9ea09c3106c002ca11273","dashboards/6127726ffd984a0036529a7d"]},"prm":{"description":"Specifies end-user permissions for the Web Access Token environment within the scope of the `Viewer` role level. Available options are `filter` and `export`.","example":["filter","export"]},"flt":{"description":"Specifies filters that should be applied to the asset in a Web Access Token-based environment.","example":[]},"acl":{"description":"Data security that should be applied to the end user","example":[]}}}}},"secret":{"type":"string","description":"Is a signature used to encrypt token’s data and protect from changing its content","example":"-----BEGIN PUBLIC KEY-----MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtT5bUIL6A9wxChGWgUdqBwkvRNPcGvMZyxlDdRKlAhvtsKkxU0aKyyvdzDXh0OTrde1L4wqTsEs+5ASZDVzcJ7wFCN8w9owaJHOgmGgKrspTWIHXRIf+3sttIkTPFy5fDsaAkR7lYOe4LFJhhCpoZKf3+B433xZUgIaxMmC+WzgiPWw0b0K4wfBGnm55NkpoFUd2BvkeDxlvVei5aX8g+sBGKePurI6jOKtgct0PQFJNCcAtH4qYbaP0zPOWAGnHB9d4F2gIm4HgKkS+SxRtJNv4pUTHYMgAGj9mbpi36vwbpxUzY0UZW9mM9lpraIXDTYFeRXkNUEO2VLQ/NSu8DQIDAQAB-----END PUBLIC KEY-----"}}},"testWatPayload":{"type":"object","required":["wat"],"properties":{"wat":{"type":"string","description":"Web Access Token to test","example":"eyJhbGciOiJSU0EtT0FFUC0yNTYiLCJ6aXAiOiJERUYiLCJlbmMiOiJBMTI4R0NNIiwia2lkIjoiNjE2NmNhODliZTAzYjcwMDM3MjI3ZjVkIn0.HJmbC7dHTZv9SMEOJcgbJGupUG2AC5AU7beM7gqwpmG8gweg6bmuUM8tKzopBaGUPS4wtTctG2gV7vGgGTHoZwC7vbH0V9Q93d35EEQkf8ZdA3ZJNDbSdbU9_Wh9PngmucxyNDFAKDVtKXkIADnRlbPiTwGEkj4csSmlFj-8VZm_AHEkZsnz6C8wDSS6dM6_n8DlWHbxQZahmiySIxCltDiIUXLzQB1Pk5Fq3R4zDzYoU0KBbq4a2t3xWY8TQu6U3Sl5w-th6xCD92NHu5dScVntqBpLLjm0XmgKRxus_EV8W3yb3IdR0jYvSOPrj-stGSoBNFrhGbIOqoYwmQRFWQ.Fi7gVwzvAn_PeOE2.cEiJB0EvlpciGRB5DAay23DSsSE-Z2S5uXJ6eUzK1QM5FOuSsOtVa9Ro9YRWhFjSeUJCj83nv4YjTwYG1yeBvQ.spPUTdhW5z5u2TgKepOG4w"},"validationLevel":{"type":"string","enum":["structure","logic","data"],"default":"data","description":"Specifies the testing level for the selected Web Access Token","example":"logic"}}},"testWatResponse":{"type":"object","properties":{"isValid":{"type":"boolean","description":"Indicates whether token passed validation for all specified levels","example":true},"structure":{"type":"object","properties":{"executed":{"type":"boolean","description":"Indicates whether level's validation was executed","example":true},"isValid":{"type":"boolean","description":"Indicates whether token passed level's validation","example":true},"errors":{"type":"array","description":"Level's validation errors","example":[],"items":{"type":"string"}}}},"logic":{"type":"object","properties":{"executed":{"type":"boolean","description":"Indicates whether level's validation was executed","example":true},"isValid":{"type":"boolean","description":"Indicates whether token passed level's validation","example":true},"errors":{"type":"array","description":"Level's validation errors","example":[],"items":{"type":"string"}}}},"data":{"type":"object","properties":{"executed":{"type":"boolean","description":"Indicates whether level's validation was executed","example":true},"isValid":{"type":"boolean","description":"Indicates whether token passed level's validation","example":true},"errors":{"type":"array","description":"Level's validation errors","example":[],"items":{"type":"string"}}}}}},"decryptWatPayload":{"type":"object","required":["wat"],"properties":{"wat":{"type":"string","description":"Web Access Token to decrypt"}}},"decryptWatResponse":{"type":"object","properties":{"header":{"type":"object","description":"Decrypted header"},"payload":{"type":"object","description":"Decrypted payload"}}},"mongoObjectId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"createNlqSpec":{"type":"object","properties":{"dashboardId":{"type":"string"},"datasourceTitle":{"type":"string"},"datasource":{"type":"object"},"skipStoreSpec":{"type":"boolean"},"modelId":{"type":"string"}},"required":["dashboardId","datasourceTitle","datasource"]},"nlqSpec":{"type":"object","properties":{"id":{"type":"string"},"datasourceTitle":{"type":"string"},"fields":{"type":"array","items":{"type":"object","properties":{"table":{"type":"string"},"column":{"type":"string"},"type":{"type":"string"}}}}}},"tokenizeSentenceRequest":{"type":"object","properties":{"sentence":{"type":"string"}}},"nlq2JaqlRequest":{"type":"object","properties":{"modelId":{"type":"string"},"text":{"type":"string"},"word_matches":{"type":"array","items":{"type":"object"}},"timezone":{"type":"string"}}},"nlq2JaqlInfusedRequest":{"type":"object","properties":{"modelId":{"type":"string"},"text":{"type":"string"},"word_matches":{"type":"array","items":{"type":"object"}},"timezone":{"type":"string"}}},"spellcheckRequest":{"type":"object","properties":{"modelId":{"type":"string"},"text":{"type":"string"}}},"wordAutocompleteRequest":{"type":"object","properties":{"modelId":{"type":"string"},"text":{"type":"string"}}},"compileModelRequest":{"type":"object"},"initModelRequest":{"type":"object","properties":{"modelId":{"type":"string"}}},"nextBestRequest":{"type":"object","properties":{"nlqSessionGuid":{"type":"string"},"modelOid":{"type":"string"},"sentence":{"type":"string"},"dashboardOid":{"type":"string"},"userId":{"type":"string"},"count":{"type":"integer"},"queryJaqls":{"type":"object","properties":{"metadata":{"type":"array"},"datasource":{"description":"Can be: string or object, etc. (except `null`)"}}},"timezone":{"type":"string"}}},"nlqUserHistory":{"type":"object","properties":{"nlqId":{"type":"string"},"userId":{"type":"string"},"recent":{"type":"array","items":{"type":"string"}},"stared":{"type":"array","items":{"type":"string"}}}},"nlqSentenceObject":{"type":"object","properties":{"title":{"type":"string"},"sentence":{"type":"string"},"jaqlDescription":{"type":"string"},"refs":{"type":"array","items":{"type":"object"}},"type":{"type":"string","enum":["stared","recent"]}}},"nlqPermission":{"type":"object","properties":{"level":{"type":"string","enum":["cube","dashboard"]},"entity":{"type":"string"},"enabled":{"type":"boolean"}}},"nlqLiveSchedulerSettings":{"type":"object","properties":{"active":{"type":"boolean"},"liveModelServer":{"type":"string"},"liveModelTitle":{"type":"string"},"hour":{"type":"number"},"minute":{"type":"number"}},"required":["active","liveModelServer","liveModelTitle","hour","minute"]},"enableNlqOnDashboards":{"type":"object","properties":{"result":{"type":"string"}}},"nlqAdvancedModeResponse":{"type":"object","properties":{"result":{"type":"string"}}},"nlqAdvancedModeRequest":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"activeDedup":{"type":"object","properties":{"elasticubeOid":{"type":"string"},"dedupColumn":{"type":"string"},"sourceColumn":{"type":"string"},"clusters":{"type":"array","items":{"type":"object","properties":{"members":{"type":"array","minItems":1,"items":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"]}},"representative":{"type":"string"},"isChecked":{"type":"boolean"}},"required":["members"]}},"ratio":{"type":"number"}}},"suggestionDedup":{"type":"object","properties":{"elasticubeOid":{"type":"string"},"sourceColumn":{"type":"string"},"clusters":{"type":"array","items":{"type":"object","properties":{"members":{"type":"array","minItems":1,"items":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"]}},"representative":{"type":"string"},"isChecked":{"type":"boolean"}},"required":["members"]}},"buildTime":{"type":"string"}}},"dedupClusters":{"type":"array","items":{"type":"object","properties":{"members":{"type":"array","minItems":1,"items":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"]}},"representative":{"type":"string"},"isChecked":{"type":"boolean"}},"required":["members"]}},"uniforecastPayload":{"type":"object","properties":{"horizon":{"type":"integer","format":"int64","description":"An integer larger than 0 indicating how many future periods to forecast"},"level":{"type":"string","description":"Period date level","enum":["day","week","month","quarter","year"]},"data":{"type":"array","description":"JSON object that hold value for each date","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"value":{"type":"number"}}}},"model":{"type":"string","description":"forecast model to use","enum":["en","aa","hw","fb"]},"eBar":{"type":"number","minimum":50,"maximum":99},"boundaries":{"type":"object","properties":{"lower":{"type":"number","description":"The lowest allowed value in the forecast series"},"upper":{"type":"number","description":"The highest allowed value in the forecast series"},"isInt":{"type":"boolean","description":"If true, all forecasted values will be rounded to a whole number"}}}}},"multiforecastPayload":{"type":"object","properties":{"horizon":{"type":"integer","format":"int64","description":"An integer larger than 0 indicating how many future periods to forecast"},"level":{"type":"string","description":"Period date level","enum":["day","week","month","quarter","year"]},"data":{"type":"array","description":"JSON object that hold value for each date","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"value":{"type":"number"},"value2":{"type":"number"}}}},"type":{"type":"string","description":"2nd Horizion type","enum":["uni-forecast","last","customValues"]},"customValues":{"type":"array","items":{"type":"integer"}},"boundaries":{"type":"object","properties":{"lower":{"type":"number","description":"The lowest allowed value in the forecast series"},"upper":{"type":"number","description":"The highest allowed value in the forecast series"},"isInt":{"type":"boolean","description":"If true, all forecasted values will be rounded to a whole number"}}}}},"forecastData":{"type":"array","description":"JSON object that hold value for each date","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"value":{"type":"number"}}}},"forecastMultiData":{"type":"array","description":"JSON object that hold value for each date","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"value":{"type":"number"},"value2":{"type":"number"}}}},"trendPayload":{"type":"object","properties":{"type":{"type":"string","description":"Trend type","enum":["linear","logarithmic","local","smooth"]},"ignoreAnomalies":{"type":"boolean","description":"If true, values considered as anomalies will be replaced by the average of the two values that come before and after it."},"data":{"type":"object","properties":{"series":{"type":"array","description":"JSON object that hold value for each date","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"value":{"type":"number"}}}},"compare":{"type":"array","description":"JSON object that hold value for each date","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"value":{"type":"number"}}}},"forecast":{"type":"array","description":"JSON object that hold value for each date","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"value":{"type":"number"}}}}}}}},"trendData":{"type":"array","description":"JSON object that hold value for each date","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"value":{"type":"number"}}}},"timeseriesData":{"type":"object","properties":{"data":{"type":"array","description":"JSON object that hold value for each date","items":{"type":"object","properties":{"date":{"type":"string"},"value":{"type":"number"}}}}}},"driversData":{"type":"object","properties":{"headers":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}}}},"metadata":{"type":"array","items":{"type":"object","properties":{"jaql":{"type":"object"}}}},"datasource":{"type":"object"}}},"forecastBoundaries":{"type":"object","properties":{"lower":{"type":"number","description":"The lowest allowed value in the forecast series"},"upper":{"type":"number","description":"The highest allowed value in the forecast series"},"isInt":{"type":"boolean","description":"If true, all forecasted values will be rounded to a whole number"}}},"basicExplanationsBodySchema":{"type":"object","required":["measure"],"properties":{"measure":{"description":"Measure jaql to find explanations about its change","type":"object","properties":{"dim":{"type":"string"},"table":{"type":"string"},"column":{"type":"string"},"agg":{"type":"string"}}},"options":{"description":"Whether to fetch and use recommended fields in the calculation of the explanations","type":"object","properties":{"maxRecommendations":{"type":"number","default":8},"jaqlsToExplore":{"type":"array","items":{"type":"object","properties":{"dim":{"type":"string"},"table":{"type":"string"},"column":{"type":"string"}}}}}}}},"categoricalExplanationsBodySchema":{"type":"object","required":["measure","categoricalFieldId","selectedMember"],"properties":{"measure":{"description":"Measure jaql to find explanations about its change","type":"object","properties":{"dim":{"type":"string"},"agg":{"type":"string"}}},"fetchFieldRecommendations":{"description":"Whether to fetch and use recommended fields in the calculation of the explanations","type":"boolean"},"fieldsToExplore":{"description":"List of jaqls represents fields to explore how they affect the measure","type":"array","items":{"type":"object","required":["dim"],"properties":{"dim":{"type":"string","description":"Field dimension id"},"level":{"type":"string","description":"Optional. For date dimensions specify the date level (years, months, etc..)"}}}},"categoricalFieldId":{"type":"string"},"selectedMember":{"type":"string"},"compareSelectedMemberTo":{"type":"string"}}},"notebooks":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"description":{"type":"string"},"notebookType":{"type":"string"},"icon":{"type":"string"},"codePath":{"type":"string"},"language":{"type":"string"},"mode":{"type":"string"},"cellsDisable":{"type":"array","items":{"type":"integer"}},"columns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"integer"},"name":{"type":"string"}}}},"additionalParameters":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"},"dependsOn":{"type":"boolean"},"title":{"type":"string"},"description":{"type":"string"}}}}}},"notebooksCustomProperties":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"description":{"type":"string"},"notebookType":{"type":"string"},"icon":{"type":"string"},"group":{"type":"string"},"timeout":{"type":"integer","minimum":0},"columns":{"type":"array","minItems":1,"items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"integer"},"name":{"type":"string"}}}},"additionalParameters":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"},"dependsOn":{"type":"boolean"},"title":{"type":"string"},"description":{"type":"string"}}}},"notebookCode":{"type":"object"}}},"notebookShareRequest":{"type":"object","properties":{"partyId":{"type":"string"},"type":{"type":"string"},"permission":{"type":"string"}}},"recommendRequest":{"$ref":"../../../features/recommendations/v1/recommendations.swagger.definitions.yaml#recommendRequest"}},"x-components":{},"consumes":["application/json"],"parameters":{"fields":{"name":"fields","in":"query","description":"Whitelist of fields to return for each document. fields Can also define which fields to exclude by prefixing field names with `-`","required":false,"type":"string"},"sort":{"name":"sort","in":"query","description":"Field by which the results should be sorted. Ascending by default, descending if prefixed by `-`","required":false,"type":"string"},"skip":{"name":"skip","in":"query","description":"Number of results to skip from the start of the data set. skip is to be used with the `limit` parameter for paging","required":false,"type":"integer","minimum":0},"limit":{"name":"limit","in":"query","description":"How many results should be returned. limit is to be used with the `skip` parameter for paging","required":false,"type":"integer","minimum":1},"expand":{"name":"expand","in":"query","description":"List of fields that should be expanded (substitures their IDs with actual objects). May be nested using the `resource.subResource` format","required":false,"type":"string"},"x-device-id":{"in":"header","description":"The device id.","name":"x-device-id","required":false,"type":"string"},"authorization":{"in":"header","description":"The user's API token preceded by the keyword Bearer (with space between it and the token). For more information, see API tutorial.","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"},"id":{"name":"id","in":"path","description":"The ID of the plugin in `folderName/pluginName` format.","required":true,"type":"string","pattern":"^[a-zA-Z0-9_-]+\\/[a-zA-Z0-9_-]+$"},"uuid":{"in":"path","description":"The Notebook uuid","name":"uuid","required":true,"type":"string"},"widgetOid":{"in":"path","description":"widgetOid input parameter","name":"widgetOid","required":true,"type":"string"},"indicatorExplanations":{"in":"body","name":"InidcatorExplanations","description":"Indicator Explanations body payload","schema":{"type":"object","required":["measure"],"properties":{"measure":{"description":"Measure jaql to find explanations about its change","type":"object","properties":{"dim":{"type":"string"},"table":{"type":"string"},"column":{"type":"string"},"agg":{"type":"string"}}},"options":{"description":"Whether to fetch and use recommended fields in the calculation of the explanations","type":"object","properties":{"maxRecommendations":{"type":"number","default":8},"jaqlsToExplore":{"type":"array","items":{"type":"object","properties":{"dim":{"type":"string"},"table":{"type":"string"},"column":{"type":"string"}}}}}}}}},"categoricalExplanations":{"in":"body","name":"categoricalExplanations","description":"Categorical Explanations body payload","schema":{"type":"object","required":["measure","categoricalFieldId","selectedMember"],"properties":{"measure":{"description":"Measure jaql to find explanations about its change","type":"object","properties":{"dim":{"type":"string"},"agg":{"type":"string"}}},"fetchFieldRecommendations":{"description":"Whether to fetch and use recommended fields in the calculation of the explanations","type":"boolean"},"fieldsToExplore":{"description":"List of jaqls represents fields to explore how they affect the measure","type":"array","items":{"type":"object","required":["dim"],"properties":{"dim":{"type":"string","description":"Field dimension id"},"level":{"type":"string","description":"Optional. For date dimensions specify the date level (years, months, etc..)"}}}},"categoricalFieldId":{"type":"string"},"selectedMember":{"type":"string"},"compareSelectedMemberTo":{"type":"string"}}}}}}