{"swagger":"2.0","basePath":"/api","consumes":["application/json"],"produces":["application/json","text/plain"],"paths":{"/settings/api":{"x-swagger-router-controller":"settings.api.controller.v0.9","x-permission-type":"admins-only","get":{"operationId":"get","summary":"get api settings.","description":"Returns api settings.","tags":["settings"],"responses":{"200":{"description":"api settings.","schema":{"type":"object","properties":{"_id":{"type":"string"},"apiKey":{"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":"set","summary":"set api settings.","description":"Returns api settings.","tags":["settings"],"responses":{"200":{"description":"api settings.","schema":{"type":"object","properties":{"apiKey":{"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":"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":"config","required":true,"schema":{"type":"object","properties":{"apiKey":{"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":{"operationId":"deleteToken","summary":"Delete api settings.","description":"Delete api settings.","tags":["settings"],"responses":{"200":{"description":"api settings.","schema":{"type":"object","properties":{"_id":{"type":"string"},"apiKey":{"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"}},"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 security settings.","name":"security","required":true,"schema":{"type":"object","properties":{"_id":{"type":"string"},"apiKey":{"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"}]}},"/settings/api/generate":{"x-swagger-router-controller":"settings.api.controller.v0.9","x-permission-type":"admins-only","get":{"operationId":"generateNew","summary":"Generate api settings.","description":"Generate api settings.","tags":["settings"],"responses":{"200":{"description":"Api settings.","schema":{"type":"object","properties":{"_id":{"type":"string"},"apiKey":{"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"}]}},"/branding":{"x-swagger-router-controller":"branding.controller.v0.9","get":{"x-permission-type":"none","operationId":"getBranding","summary":"Returns the current branding metadata","description":"Returns the current branding metadata","tags":["branding"],"responses":{"200":{"description":"Branding metadata.","schema":{"type":"object","properties":{"activationSubtitle":{"type":"string"},"activationTitle":{"type":"string"},"contactUsText":{"type":"string"},"copyrightText":{"type":"string"},"documentationUrl":{"type":"string"},"emails":{"type":"object","properties":{"createdUserSubject":{"type":"string"},"newUserInviteSubject":{"type":"string"},"passwordRecoverySubject":{"type":"string"},"senderEmail":{"type":"string"},"senderName":{"type":"string"},"shareWithExistingUserSubject":{"type":"string"},"shareWithNewUserSubject":{"type":"string"},"templates_directory":{"type":"string"},"transferOwnership":{"type":"string"},"twoFactorAuthSubject":{"type":"string"},"emailLogo":{"type":"string"}}},"favicon":{"type":"string"},"forumUrl":{"type":"string"},"homePage":{"type":"string"},"homePageConfig":{"type":"object","properties":{"documentationLink":{"type":"string"},"hideSearchInNavver":{"type":"boolean","default":true},"marketingPart":{"type":"string"},"hideMarketingBanner":{"type":"boolean","default":false},"tutorialsLink":{"type":"string"}}},"loginSubtitle":{"type":"string"},"loginTitle":{"type":"string"},"logo":{"type":"object","properties":{"desktop":{"type":"object","properties":{"large":{"type":"string"},"small":{"type":"string"},"icon":{"type":"string"}}},"phone":{"type":"object","properties":{"large":{"type":"string"},"small":{"type":"string"},"icon":{"type":"string"}}},"tablet":{"type":"object","properties":{"large":{"type":"string"},"small":{"type":"string"},"icon":{"type":"string"}}}}},"pageTitle":{"type":"string"},"poweredBySisense":{"type":"boolean","default":true},"enabled":{"type":"boolean","default":true},"widgetsPoweredBySisense":{"type":"boolean"}}}},"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","x-roles-allowed":"tenantAdmin,admin","x-middleware":["sanitizeData","validatePoweredBySisensePermissions"],"operationId":"setBranding","summary":"Adds new branding to your Sisense dashboards","description":"Branding includes customized texts, logos and emails.","tags":["branding"],"responses":{"200":{"description":"branding metadata.","schema":{"type":"object","properties":{"activationSubtitle":{"type":"string"},"activationTitle":{"type":"string"},"contactUsText":{"type":"string"},"copyrightText":{"type":"string"},"documentationUrl":{"type":"string"},"emails":{"type":"object","properties":{"createdUserSubject":{"type":"string"},"newUserInviteSubject":{"type":"string"},"passwordRecoverySubject":{"type":"string"},"senderEmail":{"type":"string"},"senderName":{"type":"string"},"shareWithExistingUserSubject":{"type":"string"},"shareWithNewUserSubject":{"type":"string"},"templates_directory":{"type":"string"},"transferOwnership":{"type":"string"},"twoFactorAuthSubject":{"type":"string"},"emailLogo":{"type":"string"}}},"favicon":{"type":"string"},"forumUrl":{"type":"string"},"homePage":{"type":"string"},"homePageConfig":{"type":"object","properties":{"documentationLink":{"type":"string"},"hideSearchInNavver":{"type":"boolean","default":true},"marketingPart":{"type":"string"},"hideMarketingBanner":{"type":"boolean","default":false},"tutorialsLink":{"type":"string"}}},"loginSubtitle":{"type":"string"},"loginTitle":{"type":"string"},"logo":{"type":"object","properties":{"desktop":{"type":"object","properties":{"large":{"type":"string"},"small":{"type":"string"},"icon":{"type":"string"}}},"phone":{"type":"object","properties":{"large":{"type":"string"},"small":{"type":"string"},"icon":{"type":"string"}}},"tablet":{"type":"object","properties":{"large":{"type":"string"},"small":{"type":"string"},"icon":{"type":"string"}}}}},"pageTitle":{"type":"string"},"poweredBySisense":{"type":"boolean","default":true},"enabled":{"type":"boolean","default":true},"widgetsPoweredBySisense":{"type":"boolean"}}}},"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 branding metadata.","name":"branding","required":true,"schema":{"type":"object","properties":{"activationSubtitle":{"type":"string"},"activationTitle":{"type":"string"},"contactUsText":{"type":"string"},"copyrightText":{"type":"string"},"documentationUrl":{"type":"string"},"emails":{"type":"object","properties":{"createdUserSubject":{"type":"string"},"newUserInviteSubject":{"type":"string"},"passwordRecoverySubject":{"type":"string"},"senderEmail":{"type":"string"},"senderName":{"type":"string"},"shareWithExistingUserSubject":{"type":"string"},"shareWithNewUserSubject":{"type":"string"},"templates_directory":{"type":"string"},"transferOwnership":{"type":"string"},"twoFactorAuthSubject":{"type":"string"},"emailLogo":{"type":"string"}}},"favicon":{"type":"string"},"forumUrl":{"type":"string"},"homePage":{"type":"string"},"homePageConfig":{"type":"object","properties":{"documentationLink":{"type":"string"},"hideSearchInNavver":{"type":"boolean","default":true},"marketingPart":{"type":"string"},"hideMarketingBanner":{"type":"boolean","default":false},"tutorialsLink":{"type":"string"}}},"loginSubtitle":{"type":"string"},"loginTitle":{"type":"string"},"logo":{"type":"object","properties":{"desktop":{"type":"object","properties":{"large":{"type":"string"},"small":{"type":"string"},"icon":{"type":"string"}}},"phone":{"type":"object","properties":{"large":{"type":"string"},"small":{"type":"string"},"icon":{"type":"string"}}},"tablet":{"type":"object","properties":{"large":{"type":"string"},"small":{"type":"string"},"icon":{"type":"string"}}}}},"pageTitle":{"type":"string"},"poweredBySisense":{"type":"boolean","default":true},"enabled":{"type":"boolean","default":true},"widgetsPoweredBySisense":{"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"}]},"delete":{"x-permission-type":"admins-only","x-roles-allowed":"tenantAdmin,admin","operationId":"resetBranding","summary":"Resets the current branding to the default Sisense branding","description":"Resets the current branding to the default Sisense branding.","tags":["branding"],"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/globalization":{"x-swagger-router-controller":"settings.globalization.controller.v0.9","get":{"x-permission-type":"none","operationId":"get","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":{"name":{"type":"string","description":"Name of configuration.","default":"globalization"},"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":"set","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":{"name":{"type":"string","description":"Name of configuration.","default":"globalization"},"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":{"name":{"type":"string","description":"Name of configuration.","default":"globalization"},"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"}]}},"/settings/proxy":{"x-swagger-router-controller":"settings.proxy.controller.v0.9","x-permission-type":"none","get":{"operationId":"get","summary":"Returns proxy server settings in your server.","description":"This is to allow geo data (used in area and scatter map widgets) to be pulled in from external Sisense servers.","tags":["settings"],"responses":{"200":{"description":"Pulse configuration settings.","schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"ip":{"type":"string"},"port":{"type":"number"},"username":{"type":"string"},"password":{"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":"add","summary":"Adds proxy server settings to your server.","description":"This option can be used to allow geo data (used in area and scatter map widgets), to be pulled in from external Sisense servers when such data is blocked by your organization’s proxy server.","tags":["settings"],"responses":{"200":{"description":"Pulse configuration settings.","schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"ip":{"type":"string"},"port":{"type":"number"},"username":{"type":"string"},"password":{"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"}},"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 Proxy settings.","name":"Proxy","required":true,"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"ip":{"type":"string"},"port":{"type":"number"},"username":{"type":"string"},"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"}]},"put":{"operationId":"update","summary":"Updates proxy server settings in your server.","description":"This option can be used to allow geo data (used in area and scatter map widgets), to be pulled in from external Sisense servers when such data is blocked by your organization’s proxy server.","tags":["settings"],"responses":{"200":{"description":"Proxy configuration settings.","schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"ip":{"type":"string"},"port":{"type":"number"},"username":{"type":"string"},"password":{"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"}},"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 Proxy settings.","name":"Proxy","required":true,"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"ip":{"type":"string"},"port":{"type":"number"},"username":{"type":"string"},"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"}]},"delete":{"operationId":"delete","summary":"Deletes proxy server settings in your server.","description":"Deletes proxy server 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"}},"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/security":{"x-swagger-router-controller":"settings.security.controller.v0.9","x-permission-type":"admins-only","get":{"operationId":"get","summary":"Returns security settings.","description":"Returns **security settings**.","x-roles-allowed":"tenantAdmin,admin","tags":["settings"],"responses":{"200":{"description":"Security settings.","schema":{"type":"object","properties":{"defaultTimeout":{"type":"number","minimum":0,"maximum":86400},"authenticationMode":{"type":"string","enum":["client","server"]},"applyDataSecurityOnFilters":{"type":"boolean"},"redirectToAnyUrl":{"type":"boolean"},"adminsTimeout":{"type":"number","minimum":0,"maximum":86400},"sameSite":{"type":"string","enum":["Default","None","Lax","Strict"]},"sessionOnlyCookie":{"type":"boolean"},"passwordError":{"type":"string"},"cookieExp":{"type":"number"},"embeddedDomains":{"type":"array","items":{"type":"string"}},"chipsEnabled":{"type":"boolean"},"targetDomains":{"type":"array","items":{"type":"string"}},"applyDataSecurityOnFiltersRelations":{"type":"boolean"},"hideListOfAllowedEmbeddedDomains":{"type":"boolean"},"forceSecureCookies":{"type":"boolean"},"dataSecurityDefaultGroupStrict":{"type":"boolean"},"secret":{"type":"string"},"passwordRegex":{"type":"string"},"csrf":{"type":"object","properties":{"enabled":{"type":"boolean"}}}}}},"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":"set","summary":"Adds/updates security settings.","description":"Adds/updates **security settings**.","tags":["settings"],"responses":{"200":{"description":"Security settings.","schema":{"type":"object","properties":{"defaultTimeout":{"type":"number","minimum":0,"maximum":86400},"authenticationMode":{"type":"string","enum":["client","server"]},"applyDataSecurityOnFilters":{"type":"boolean"},"redirectToAnyUrl":{"type":"boolean"},"adminsTimeout":{"type":"number","minimum":0,"maximum":86400},"sameSite":{"type":"string","enum":["Default","None","Lax","Strict"]},"sessionOnlyCookie":{"type":"boolean"},"passwordError":{"type":"string"},"cookieExp":{"type":"number"},"embeddedDomains":{"type":"array","items":{"type":"string"}},"chipsEnabled":{"type":"boolean"},"targetDomains":{"type":"array","items":{"type":"string"}},"applyDataSecurityOnFiltersRelations":{"type":"boolean"},"hideListOfAllowedEmbeddedDomains":{"type":"boolean"},"forceSecureCookies":{"type":"boolean"},"dataSecurityDefaultGroupStrict":{"type":"boolean"},"secret":{"type":"string"},"passwordRegex":{"type":"string"},"csrf":{"type":"object","properties":{"enabled":{"type":"boolean"}}}}}},"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 security settings.","name":"security","required":true,"schema":{"type":"object","properties":{"defaultTimeout":{"type":"number","minimum":0,"maximum":86400},"authenticationMode":{"type":"string","enum":["client","server"]},"applyDataSecurityOnFilters":{"type":"boolean"},"redirectToAnyUrl":{"type":"boolean"},"adminsTimeout":{"type":"number","minimum":0,"maximum":86400},"sameSite":{"type":"string","enum":["Default","None","Lax","Strict"]},"sessionOnlyCookie":{"type":"boolean"},"passwordError":{"type":"string"},"cookieExp":{"type":"number"},"embeddedDomains":{"type":"array","items":{"type":"string"}},"chipsEnabled":{"type":"boolean"},"targetDomains":{"type":"array","items":{"type":"string"}},"applyDataSecurityOnFiltersRelations":{"type":"boolean"},"hideListOfAllowedEmbeddedDomains":{"type":"boolean"},"forceSecureCookies":{"type":"boolean"},"dataSecurityDefaultGroupStrict":{"type":"boolean"},"secret":{"type":"string"},"passwordRegex":{"type":"string"},"csrf":{"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"}]}},"/settings/sso":{"x-swagger-router-controller":"settings.sso.controller.v0.9","x-permission-type":"admins-only","x-roles-allowed":"tenantAdmin,admin","get":{"operationId":"get","summary":"Returns sso settings.","description":"The **sso settings** used for single sign on configuration.","tags":["settings"],"responses":{"200":{"description":"SSO configuration settings.","schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If SSO is enabled."},"ssoType":{"type":"string","description":"Type of SSO.","default":"jwt"},"loginUrl":{"type":"string","description":"This is the URL that Sisense will invoke to attempt remote authentication."},"logoutUrl":{"type":"string","description":"This is the URL that Sisense will return users to after they log out."},"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}}}},"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"},"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":"set","summary":"Set sso settings.","description":"The **sso settings** used for single sign on configuration.","tags":["settings"],"responses":{"200":{"description":"SSO configuration settings.","schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If SSO is enabled."},"ssoType":{"type":"string","description":"Type of SSO.","default":"jwt"},"loginUrl":{"type":"string","description":"This is the URL that Sisense will invoke to attempt remote authentication."},"logoutUrl":{"type":"string","description":"This is the URL that Sisense will return users to after they log out."},"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}}}},"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":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If SSO is enabled."},"ssoType":{"type":"string","description":"Type of SSO.","default":"jwt"},"loginUrl":{"type":"string","description":"This is the URL that Sisense will invoke to attempt remote authentication."},"logoutUrl":{"type":"string","description":"This is the URL that Sisense will return users to after they log out."},"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}}}},{"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.v0.9","x-permission-type":"admins-only","get":{"operationId":"get","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."},"email":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If mails are enabled."},"senderEmail":{"type":"string","description":"Email of sender."},"senderName":{"type":"string","description":"Name of sender."}}},"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."}}},"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"}}}}}}}}},"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":{"x-permission-path":"manage/systemconfig","operationId":"set","summary":"Adds or updates system 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."},"email":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If mails are enabled."},"senderEmail":{"type":"string","description":"Email of sender."},"senderName":{"type":"string","description":"Name of sender."}}},"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."}}},"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"}}}}}}}}},"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."},"email":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If mails are enabled."},"senderEmail":{"type":"string","description":"Email of sender."},"senderName":{"type":"string","description":"Name of sender."}}},"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."}}},"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"}}}}}}}}},{"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"}]}},"/test/testing":{"get":{"tags":["Test"],"operationId":"ApiTestTestingGet","consumes":[],"produces":["text/plain","application/json","text/json"],"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"}],"responses":{"200":{"description":"Success","schema":{"type":"string"}},"403":{"description":"User does not have permission"}}}},"/translation/{schemaType}/{schemaId}/jaql":{"post":{"tags":["TranslationService"],"operationId":"ApiTranslationBySchemaTypeBySchemaIdJaqlPost","consumes":["text/plain","application/octet-stream","application/json-patch+json","application/json","text/json","application/*+json"],"produces":["text/plain","application/json","text/json"],"x-permission-type":"authenticate","parameters":[{"name":"schemaType","in":"path","required":true,"type":"string","enum":["Live","MonetDb","Logical"]},{"name":"schemaId","in":"path","required":true,"type":"string"},{"name":"jaql","in":"body","required":false,"schema":{"type":"object"}},{"name":"dsid","in":"header","required":false,"type":"string"},{"name":"userId","in":"header","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"}],"responses":{"200":{"description":"Success","schema":{"type":"string"}},"403":{"description":"User does not have permission"}}}},"/translation/{schemaType}/{schemaId}/odbc":{"post":{"tags":["TranslationService"],"operationId":"ApiTranslationBySchemaTypeBySchemaIdOdbcPost","consumes":["text/plain","application/octet-stream","application/json-patch+json","application/json","text/json","application/*+json"],"produces":["text/plain","application/json","text/json"],"x-permission-type":"data-admins-only","parameters":[{"name":"query","in":"body","required":false,"schema":{"type":"string"}},{"name":"schemaType","in":"path","required":true,"type":"string","enum":["Live","MonetDb","Logical"]},{"name":"schemaId","in":"path","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":"string"}},"403":{"description":"User does not have permission"}}}},"/translation/{schemaType}/{schemaId}/jaql/explain/queries":{"post":{"tags":["TranslationService"],"operationId":"ApiTranslationByDsdidJaqlExplainQueriesPost","consumes":["text/plain","application/octet-stream","application/json-patch+json","application/json","text/json","application/*+json"],"produces":["text/plain","application/json","text/json"],"x-permission-type":"authenticate","parameters":[{"name":"schemaType","in":"path","required":true,"type":"string","enum":["Live","MonetDb","Logical"]},{"name":"schemaId","in":"path","required":true,"type":"string"},{"name":"query","in":"body","required":false,"schema":{"type":"object"}},{"name":"skipPermision","in":"query","required":false,"type":"boolean"},{"name":"includeRowCount","in":"query","required":false,"type":"boolean"},{"name":"includeUniqueCount","in":"query","required":false,"type":"boolean"},{"name":"userId","in":"header","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"}],"responses":{"200":{"description":"Success","schema":{"type":"string"}},"403":{"description":"User does not have permission"}}}},"/translation/{schemaType}/{schemaId}/jaql/explain/queries/secondPass":{"post":{"tags":["TranslationService"],"operationId":"ApiTranslationByDsdidJaqlExplainQueriesSecondPassPost","consumes":["text/plain","application/octet-stream","application/json-patch+json","application/json","text/json","application/*+json"],"produces":["text/plain","application/json","text/json"],"x-permission-type":"authenticate","parameters":[{"name":"schemaType","in":"path","required":true,"type":"string","enum":["Live","MonetDb","Logical"]},{"name":"schemaId","in":"path","required":true,"type":"string"},{"name":"queryResult","in":"body","required":false,"schema":{"type":"object"}},{"name":"skipPermision","in":"query","required":false,"type":"boolean"},{"name":"userId","in":"header","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"}],"responses":{"200":{"description":"Success","schema":{"type":"string"}},"403":{"description":"User does not have permission"}}}},"/translation/dependencymap":{"post":{"tags":["TranslationService"],"operationId":"ApiTranslationDependencymapPost","consumes":["text/plain","application/octet-stream","application/json-patch+json","application/json","text/json","application/*+json"],"produces":["text/plain","application/json","text/json"],"x-permission-type":"authenticate","parameters":[{"name":"payload","in":"body","required":false,"schema":{"$ref":"#/definitions/SchemaEtlPayload"}},{"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":"string"}},"403":{"description":"User does not have permission"}}}},"/translation/generateCustomElementsSqls":{"post":{"tags":["TranslationService"],"operationId":"ApiTranslationGenerateCustomElementsSqlsPost","consumes":["text/plain","application/octet-stream","application/json-patch+json","application/json","text/json","application/*+json"],"produces":["text/plain","application/json","text/json"],"x-permission-type":"authenticate","parameters":[{"name":"schemaEtlPayload","in":"body","required":false,"schema":{"$ref":"#/definitions/SchemaEtlPayload"}},{"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":"string"}},"403":{"description":"User does not have permission"}}}},"/translation/explainCustomTableQuery":{"post":{"tags":["TranslationService"],"operationId":"ApiTranslationExplainCustomTableQueryPost","consumes":["text/plain","application/octet-stream","application/json-patch+json","application/json","text/json","application/*+json"],"produces":["text/plain","application/json","text/json"],"x-permission-type":"authenticate","parameters":[{"name":"payload","in":"body","required":false,"schema":{"$ref":"#/definitions/CustomTablePayload"}},{"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":"string"}},"403":{"description":"User does not have permission"}}}},"/translation/explainCustomColumnExpression":{"post":{"tags":["TranslationService"],"operationId":"ApiTranslationExplainCustomColumnExpressionPost","consumes":["text/plain","application/octet-stream","application/json-patch+json","application/json","text/json","application/*+json"],"produces":["text/plain","application/json","text/json"],"x-permission-type":"authenticate","parameters":[{"name":"payload","in":"body","required":false,"schema":{"$ref":"#/definitions/CustomColumnPayload"}},{"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":"string"}},"403":{"description":"User does not have permission"}}}},"/translation/getContextFromExpression":{"post":{"tags":["TranslationService"],"operationId":"ApiTranslationGetContextFromExpressionPost","consumes":["text/plain","application/octet-stream","application/json-patch+json","application/json","text/json","application/*+json"],"produces":["text/plain","application/json","text/json"],"x-permission-type":"authenticate","parameters":[{"name":"payload","in":"body","required":false,"schema":{"$ref":"#/definitions/AutoCompletionPayload"}},{"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":"array","items":{"$ref":"#/definitions/ContextElement"}}},"403":{"description":"User does not have permission"}}}},"/translation/{schemaType}/{schemaId}/parse":{"post":{"tags":["TranslationService"],"operationId":"ApiTranslationBySchemaTypeBySchemaIdParsePost","consumes":["text/plain","application/octet-stream","application/json-patch+json","application/json","text/json","application/*+json"],"produces":["text/plain","application/json","text/json"],"x-permission-type":"data-admins-only","parameters":[{"name":"schemaType","in":"path","required":true,"type":"string","enum":["Live","MonetDb","Logical"]},{"name":"schemaId","in":"path","required":true,"type":"string"},{"name":"formula","in":"body","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"},{"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":"string"}},"403":{"description":"User does not have permission"}}}},"/translation/{schemaType}/{schemaId}/fields/search":{"post":{"tags":["TranslationService"],"operationId":"ApiTranslationBySchemaTypeBySchemaIdFieldsSearchPost","consumes":["text/plain","application/octet-stream","application/json-patch+json","application/json","text/json","application/*+json"],"produces":["text/plain","application/json","text/json"],"x-permission-type":"data-admins-only","parameters":[{"name":"schemaType","in":"path","required":true,"type":"string","enum":["Live","MonetDb","Logical"]},{"name":"schemaId","in":"path","required":true,"type":"string"},{"name":"query","in":"body","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"},{"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":"string"}},"403":{"description":"User does not have permission"}}}},"/translation/{schemaType}/{schemaId}/explainsql":{"post":{"tags":["TranslationService"],"operationId":"ApiTranslationBySchemaTypeBySchemaIdExplainsqlPost","consumes":["text/plain","application/octet-stream","application/json-patch+json","application/json","text/json","application/*+json"],"produces":["text/plain","application/json","text/json"],"x-permission-type":"data-admins-only","parameters":[{"name":"query","in":"body","required":false,"schema":{"type":"string"}},{"name":"schemaType","in":"path","required":true,"type":"string","enum":["Live","MonetDb","Logical"]},{"name":"schemaId","in":"path","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":"string"}},"403":{"description":"User does not have permission"}}}},"/translation/{schemaType}/{schemaId}/sql":{"post":{"tags":["TranslationService"],"operationId":"ApiTranslationBySchemaTypeBySchemaIdSqlPost","consumes":["text/plain","application/octet-stream","application/json-patch+json","application/json","text/json","application/*+json"],"produces":["text/plain","application/json","text/json"],"x-permission-type":"data-admins-only","parameters":[{"name":"query","in":"body","required":false,"schema":{"type":"string"}},{"name":"schemaType","in":"path","required":true,"type":"string","enum":["Live","MonetDb","Logical"]},{"name":"schemaId","in":"path","required":true,"type":"string"},{"name":"rowLimit","in":"query","required":false,"type":"integer","format":"int64"},{"name":"offset","in":"query","required":false,"type":"integer","format":"int64"},{"name":"sample","in":"query","required":false,"type":"integer","format":"int64"},{"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":"string"}},"403":{"description":"User does not have permission"}}}},"/auth/isauth":{"x-swagger-router-controller":"authentication.controller.v0.9","x-permission-type":"none","get":{"x-skip-auth":true,"responses":{"200":{"description":"No response was specified","schema":{"type":"object","properties":{"isAuthenticated":{"type":"boolean"}}}},"403":{"description":"User does not have permission"}},"description":"Operations about auth","tags":["auth"],"summary":"Returns users that are logged in.","operationId":"isAuthenticated","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"}]}},"/auth/logout":{"x-swagger-router-controller":"authentication.controller.v0.9","x-permission-type":"none","get":{"description":"Operations about auth.","responses":{"403":{"description":"User does not have permission"}},"tags":["auth"],"summary":"Forces the user to be logged out","operationId":"logout","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"}]}},"/users":{"x-swagger-router-controller":"users.controller.v0.9","get":{"x-permission-type":"general","x-permission-path":"manage/users/get","x-roles-allowed":"tenantAdmin,admin","operationId":"getAll","tags":["users"],"summary":"Returns all users and related metadata.","description":"Operations about users","parameters":[{"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":"Enter a search query to return results matching the query.","name":"search","required":false,"type":"string"},{"in":"query","description":"Enter a users groups IDs comma delimiter to return results matching the query.","name":"groups","required":false,"type":"string"},{"in":"query","description":"Enter a user email to return results matching the query.","name":"email","required":false,"type":"string"},{"in":"query","description":"Enter a username to return results matching the query.","name":"userName","required":false,"type":"string"},{"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":"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":"Searches in Active Directory when didn't found enough internal groups.","name":"externalAD","required":false,"type":"boolean"},{"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":"Searches only Active Directory users.","name":"onlyAD","required":false,"type":"boolean","enum":[false,true]},{"in":"query","description":"Includes the user's groups if the user belongs to one or more groups.","name":"groupsNames","required":false,"type":"boolean","enum":[false,true]},{"in":"query","description":"Returns the domain details of each AD user.","name":"includeDomain","required":false,"type":"boolean","enum":[false,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"},{"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":"No response was specified","schema":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"active":{"type":"boolean"},"activeDirectory":{"type":"boolean"},"adgroups":{"type":"array","items":{"type":"object"}},"baseRoleName":{"type":"string"},"changePasswordState":{"type":"boolean"},"created":{"type":"string","format":"date-time"},"createdSso":{"type":"string"},"dn":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"groups":{"type":"array","items":{"type":"string"}},"hash":{"type":"string"},"lastLogin":{"type":"string","format":"date-time"},"lastName":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"},"ldapDomainId":{"type":"string"},"pendingExpiration":{"type":"string","format":"date-time"},"preferences":{"type":"object","properties":{"localeId":{"type":"string"},"language":{"type":"string"}}},"principalName":{"type":"string"},"roleId":{"type":"string"},"roleName":{"type":"string"},"uSNChanged":{"type":"string"},"userName":{"type":"string"}}}}},"400":{"description":"invalid skip"},"403":{"description":"User does not have permission"}}},"post":{"tags":["users"],"operationId":"addUser","x-roles-allowed":"tenantAdmin,admin","x-permission-type":"general","x-permission-path":"manage/users/add","x-middleware":["attachTenantIdToEntitiesWithUserTenant"],"summary":"Adds a new user.","description":"Operations about users","parameters":[{"in":"body","description":"The user object includes all the user information.","name":"newUser","required":false,"schema":{"type":"array","items":{"type":"object","properties":{"userName":{"type":"string"},"roleId":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"groups":{"type":"array","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"}},"preferences":{"type":"object","properties":{"localeId":{"type":"string"},"language":{"type":"string"}}},"password":{"type":"string"}}}}},{"in":"query","description":"Send actionable activation notification to the user","name":"notify","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"}],"responses":{"200":{"description":"No response was specified","schema":{"type":"object","properties":{"_id":{"type":"string"},"active":{"type":"boolean"},"activeDirectory":{"type":"boolean"},"adgroups":{"type":"array","items":{"type":"object"}},"baseRoleName":{"type":"string"},"changePasswordState":{"type":"boolean"},"created":{"type":"string","format":"date-time"},"createdSso":{"type":"string"},"dn":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"groups":{"type":"array","items":{"type":"string"}},"hash":{"type":"string"},"lastLogin":{"type":"string","format":"date-time"},"lastName":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"},"ldapDomainId":{"type":"string"},"pendingExpiration":{"type":"string","format":"date-time"},"preferences":{"type":"object","properties":{"localeId":{"type":"string"},"language":{"type":"string"}}},"principalName":{"type":"string"},"roleId":{"type":"string"},"roleName":{"type":"string"},"uSNChanged":{"type":"string"},"userName":{"type":"string"}}}},"400":{"description":"invalid input"},"403":{"description":"User does not have permission"}}}},"/users/ad":{"x-swagger-router-controller":"users.controller.v0.9","get":{"tags":["users"],"operationId":"getAdUsers","x-permission-type":"general","x-permission-path":"manage/users/get","x-roles-allowed":"tenantAdmin,admin","summary":"Searches for users in Active Directory.","description":"Operations about users","parameters":[{"in":"query","description":"Limits the result set to a defined number of results. - 0 or blank to not limit","name":"limit","required":false,"type":"integer","format":"int32"},{"in":"query","description":"Checks if the user exists in the database.","name":"checkExist","required":false,"type":"boolean"},{"in":"query","description":"Enter a search query to return results matching the query.","name":"search","required":false,"type":"string"},{"in":"query","description":"Enter a domain name or id.","name":"domain","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"}],"responses":{"200":{"description":"No response was specified","schema":{"type":"array","items":{"type":"object","required":["ldapDomainId"],"properties":{"adgroups":{"type":"array","items":{"type":"object"}},"userName":{"type":"string"},"ldapDomainId":{"type":"string"},"roleId":{"type":"string"},"dn":{"type":"string"},"sn":{"type":"string"},"givenName":{"type":"string"},"mail":{"type":"string"},"sAMAccountName":{"type":"string"},"userPrincipalName":{"type":"string"}}}}},"400":{"description":"invalid skip"},"403":{"description":"User does not have permission"}}},"post":{"tags":["users"],"operationId":"addAdUser","x-permission-type":"general","x-permission-path":"manage/users/add","x-roles-allowed":"tenantAdmin,admin","summary":"Imports a user from Active Directory as a new user in Sisense.","description":"Operations about users","parameters":[{"in":"body","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.","name":"user","required":false,"schema":{"type":"array","items":{"type":"object","required":["ldapDomainId"],"properties":{"adgroups":{"type":"array","items":{"type":"object"}},"userName":{"type":"string"},"ldapDomainId":{"type":"string"},"roleId":{"type":"string"},"dn":{"type":"string"},"sn":{"type":"string"},"givenName":{"type":"string"},"mail":{"type":"string"},"sAMAccountName":{"type":"string"},"userPrincipalName":{"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":"No response was specified","schema":{"type":"object","properties":{"_id":{"type":"string"},"active":{"type":"boolean"},"activeDirectory":{"type":"boolean"},"adgroups":{"type":"array","items":{"type":"object"}},"baseRoleName":{"type":"string"},"changePasswordState":{"type":"boolean"},"created":{"type":"string","format":"date-time"},"createdSso":{"type":"string"},"dn":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"groups":{"type":"array","items":{"type":"string"}},"hash":{"type":"string"},"lastLogin":{"type":"string","format":"date-time"},"lastName":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"},"ldapDomainId":{"type":"string"},"pendingExpiration":{"type":"string","format":"date-time"},"preferences":{"type":"object","properties":{"localeId":{"type":"string"},"language":{"type":"string"}}},"principalName":{"type":"string"},"roleId":{"type":"string"},"roleName":{"type":"string"},"uSNChanged":{"type":"string"},"userName":{"type":"string"}}}},"400":{"description":"invalid input"},"403":{"description":"User does not have permission"}}}},"/users/allDirectories":{"x-swagger-router-controller":"users.controller.v0.9","get":{"tags":["users"],"operationId":"getAllDirectoriesUsers","x-permission-type":"general","x-permission-path":"manage/users/get","x-roles-allowed":"tenantAdmin,admin","summary":"Searches for users in all user directories.","description":"Operations about users","parameters":[{"in":"query","description":"Limits the result set to a defined number of results. - 0 or blank to not limit","name":"limit","required":false,"type":"integer","format":"int32"},{"in":"query","description":"contains","name":"search","required":false,"type":"string"},{"in":"query","description":"Enter a users groups IDs comma delimiter to return results matching the query.","name":"groups","required":false,"type":"string"},{"in":"query","description":"Returns the domain details of each AD user.","name":"includeDomain","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"},{"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":"No response was specified","schema":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"active":{"type":"boolean"},"activeDirectory":{"type":"boolean"},"adgroups":{"type":"array","items":{"type":"object"}},"baseRoleName":{"type":"string"},"changePasswordState":{"type":"boolean"},"created":{"type":"string","format":"date-time"},"createdSso":{"type":"string"},"dn":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"groups":{"type":"array","items":{"type":"string"}},"hash":{"type":"string"},"lastLogin":{"type":"string","format":"date-time"},"lastName":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"},"ldapDomainId":{"type":"string"},"pendingExpiration":{"type":"string","format":"date-time"},"preferences":{"type":"object","properties":{"localeId":{"type":"string"},"language":{"type":"string"}}},"principalName":{"type":"string"},"roleId":{"type":"string"},"roleName":{"type":"string"},"uSNChanged":{"type":"string"},"userName":{"type":"string"}}}}},"400":{"description":"invalid skip"},"403":{"description":"User does not have permission"}}}},"/users/count":{"x-swagger-router-controller":"users.controller.v0.9","get":{"tags":["users"],"operationId":"count","x-roles-allowed":"tenantAdmin,admin","x-permission-path":"manage/users/get","x-permission-type":"admins-only","summary":"Counts users using a defined query string.","description":"Operations about users","parameters":[{"in":"query","description":"Searches for users with usernames that include the query string.","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"}],"responses":{"200":{"description":"No response was specified","schema":{"type":"object","properties":{"collection":{"type":"string"},"count":{"type":"integer"}}}},"400":{"description":"invalid search"},"403":{"description":"User does not have permission"}}}},"/users/loggedin":{"x-swagger-router-controller":"users.controller.v0.9","get":{"tags":["users"],"operationId":"getLoggedInUser","x-permission-type":"authenticate","summary":"Retrieves my user details.","description":"Operations about users","responses":{"200":{"description":"No response was specified","schema":{"type":"object","properties":{"_id":{"type":"string"},"active":{"type":"boolean"},"activeDirectory":{"type":"boolean"},"adgroups":{"type":"array","items":{"type":"object"}},"baseRoleName":{"type":"string"},"changePasswordState":{"type":"boolean"},"created":{"type":"string","format":"date-time"},"createdSso":{"type":"string"},"dn":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"groups":{"type":"array","items":{"type":"string"}},"hash":{"type":"string"},"lastLogin":{"type":"string","format":"date-time"},"lastName":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"},"ldapDomainId":{"type":"string"},"pendingExpiration":{"type":"string","format":"date-time"},"preferences":{"type":"object","properties":{"localeId":{"type":"string"},"language":{"type":"string"}}},"principalName":{"type":"string"},"roleId":{"type":"string"},"roleName":{"type":"string"},"uSNChanged":{"type":"string"},"userName":{"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"}]}},"/users/{user}":{"x-swagger-router-controller":"users.controller.v0.9","get":{"tags":["users"],"operationId":"findByIdUsername","x-permission-type":"general","x-permission-path":"manage/users/get","x-roles-allowed":"tenantAdmin,admin","summary":"Returns metadata for a user by username or user ID.","description":"Operations about users","parameters":[{"in":"path","description":"The user's ID or username","name":"user","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":"No response was specified","schema":{"type":"object","properties":{"_id":{"type":"string"},"active":{"type":"boolean"},"activeDirectory":{"type":"boolean"},"adgroups":{"type":"array","items":{"type":"object"}},"baseRoleName":{"type":"string"},"changePasswordState":{"type":"boolean"},"created":{"type":"string","format":"date-time"},"createdSso":{"type":"string"},"dn":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"groups":{"type":"array","items":{"type":"string"}},"hash":{"type":"string"},"lastLogin":{"type":"string","format":"date-time"},"lastName":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"},"ldapDomainId":{"type":"string"},"pendingExpiration":{"type":"string","format":"date-time"},"preferences":{"type":"object","properties":{"localeId":{"type":"string"},"language":{"type":"string"}}},"principalName":{"type":"string"},"roleId":{"type":"string"},"roleName":{"type":"string"},"uSNChanged":{"type":"string"},"userName":{"type":"string"}}}},"400":{"description":"invalid id"},"403":{"description":"User does not have permission"},"404":{"description":"id not found"}}},"put":{"tags":["users"],"operationId":"updateUser","x-permission-type":"general","x-permission-path":"manage/users/modify","x-roles-allowed":"tenantAdmin,admin","summary":"Updates one or more user details, by user ID or username.","description":"Operations about users","parameters":[{"in":"path","description":"The user's ID or username.","name":"user","required":true,"type":"string"},{"in":"body","description":"The user object that needs to be updated.","name":"userUpdate","required":false,"schema":{"type":"object","properties":{"userName":{"type":"string"},"roleId":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"groups":{"type":"array","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"}},"preferences":{"type":"object","properties":{"localeId":{"type":"string"},"language":{"type":"string"}}},"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"}],"responses":{"200":{"description":"No response was specified"},"400":{"description":"invalid id"},"403":{"description":"User does not have permission"},"404":{"description":"id not found"}}},"delete":{"tags":["users"],"operationId":"deleteUserByIdUsername","x-permission-type":"general","x-permission-path":"manage/users/remove","x-roles-allowed":"tenantAdmin,admin","summary":"Deletes a user by user ID or username.","description":"Operations about users","parameters":[{"in":"path","description":"The user's ID or username.","name":"user","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":"No response was specified"},"400":{"description":"invalid id"},"403":{"description":"User does not have permission"},"404":{"description":"id not found"}}}},"/users/delete":{"x-swagger-router-controller":"users.controller.v0.9","post":{"tags":["users"],"operationId":"deleteUsers","x-permission-type":"general","x-permission-path":"manage/users/remove","x-roles-allowed":"tenantAdmin,admin","summary":"Deletes a user by user ID.","description":"Operations about users","parameters":[{"in":"body","description":"The user's ID.","name":"userIds","required":false,"schema":{"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"},{"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":"No response was specified"},"400":{"description":"invalid id"},"403":{"description":"User does not have permission"},"404":{"description":"id not found"}}}},"/users/simulate":{"x-swagger-router-controller":"users.controller.v0.9","post":{"tags":["users"],"operationId":"simulate","x-permission-type":"general","x-permission-path":"manage/users/add","x-roles-allowed":"tenantAdmin,admin","summary":"Returns the users and related metadata of a simulated operation that adds multiple users.","description":"Operations about users","parameters":[{"in":"body","description":"The list of user emails to add, or usernames for Active Directory mode.","name":"emailUserList","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"in":"query","description":"run in ActiveDirectory mode","name":"admode","required":false,"type":"boolean"},{"in":"query","description":"run in ActiveDirectory mode","name":"ldapDomainId","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"}],"responses":{"200":{"description":"No response was specified","schema":{"type":"object","properties":{"license":{"type":"object","properties":{"admins":{"type":"integer"},"consumers":{"type":"integer"},"contributors":{"type":"integer"}}},"users":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string"},"isExist":{"type":"boolean"},"roleId":{"type":"string"}}}}}}},"400":{"description":"invalid input"},"403":{"description":"User does not have permission"}}}},"/users/validate":{"x-swagger-router-controller":"users.controller.v0.9","post":{"tags":["users"],"operationId":"validateEmails","x-permission-type":"general","x-permission-path":"manage/users/add","x-roles-allowed":"tenantAdmin,admin","summary":"Validates existing users by entering their emails.","description":"Operations about users","parameters":[{"in":"body","description":"List of emails of users that require validation.","name":"emails","required":false,"schema":{"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"},{"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":"No response was specified"},"400":{"description":"invalid input"},"403":{"description":"User does not have permission"}}}},"/users/forgetpassword":{"x-swagger-router-controller":"users.controller.v0.9","post":{"tags":["users"],"operationId":"forgetPassword","x-permission-type":"none","summary":"Sends a user an email to activate or reset the user's password.","description":"Operations about users","parameters":[{"in":"body","description":"The email of the user that requires a password reset.","name":"userEmail","required":false,"schema":{"type":"object","properties":{"email":{"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":"No response was specified"},"403":{"description":"User does not have permission"}}}},"/users/resendinvite":{"x-swagger-router-controller":"users.controller.v0.9","post":{"tags":["users"],"operationId":"resendInvite","x-permission-type":"general","x-permission-path":"manage/users/get","x-roles-allowed":"tenantAdmin,admin","summary":"Resend invite email and return list of users invite status","description":"Operations about users","parameters":[{"in":"body","description":"List of IDs of users","name":"userIds","required":false,"schema":{"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"},{"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":{"202":{"description":"object with invitation statuses","schema":{"type":"object","properties":{"accepted":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"}}}},"rejected":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"reason":{"type":"string"}}}}}}},"400":{"description":"invalid input"},"403":{"description":"User does not have permission"}}}},"/groups":{"x-swagger-router-controller":"groups.controller.v0.9","get":{"tags":["groups"],"operationId":"getAll","x-permission-type":"general","x-roles-allowed":"tenantAdmin,admin","x-permission-path":"manage/groups/get","summary":"Returns all user groups with metadata.","description":"Operations about groups","parameters":[{"in":"query","description":"Limits the result set to a defined number of results. Enter 0 (zero) or leave blank not to limit.","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":"Enter a search query to return results matching the query.","name":"search","required":false,"type":"string"},{"in":"query","description":"Search for a group using an Active Directory dn as the search query. Use the semi-colon ; delimiter to search multiple groups.","name":"dn","required":false,"type":"string"},{"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"},{"in":"query","description":"Searches only Active Directory user groups.","name":"onlyAD","required":false,"type":"boolean"},{"in":"query","description":"Search only for non-Active Directory groups.","name":"noAD","required":false,"type":"boolean"},{"in":"query","description":"Searches exact matches when searching by the Active Directory dn.","name":"exactMatch","required":false,"type":"boolean"},{"in":"query","description":"Searches in Active Directory when didn't found enough internal groups.","name":"externalAD","required":false,"type":"boolean"},{"in":"query","description":"Counts the number of users in each group.","name":"usersCount","required":false,"type":"boolean"},{"in":"query","description":"Returns the domain details of each AD group.","name":"includeDomain","required":false,"type":"boolean"},{"in":"query","description":"Returns the theme names of each group.","name":"includeThemeNames","required":false,"type":"boolean"},{"in":"query","description":"Enter a tenantId to return only groups from specified tenant.","name":"tenantId","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"}],"responses":{"200":{"description":"No response was specified","schema":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"created":{"type":"string","format":"date-time"},"mail":{"type":"string"},"roleId":{"type":"string","pattern":"(^[0-9a-fA-F]{24}$|^[Nn][Uu][Ll]{2}$)"},"baseRoleName":{"type":"string"},"cn/name":{"type":"string"},"dn":{"type":"string"},"member":{"type":"array","items":{"type":"string"}},"uSNChanged":{"type":"string"},"objectSid":{"type":"string","pattern":"^\\[\\d{1,3}(?:,\\d{1,3}){27}\\]$"},"lastUpdated":{"type":"string","format":"date-time"},"defaultRole":{"type":"string"},"language":{"type":"string"},"excludeFromSharing":{"type":"boolean","default":false},"timeout":{"type":["string","number","null"]}}}}},"400":{"description":"invalid skip"},"403":{"description":"User does not have permission"}}},"post":{"tags":["groups"],"operationId":"addGroup","x-middleware":["attachTenantIdToEntitiesWithUserTenant"],"x-permission-type":"general","x-roles-allowed":"tenantAdmin,admin","x-permission-path":"manage/groups/add","summary":"Adds a new Sisense user group.","description":"Operations about groups","parameters":[{"in":"body","description":"The group object that needs to be added.","name":"newGroups","required":false,"schema":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"tenantId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"name":{"type":"string"},"excludeFromSharing":{"type":"boolean","default":false},"created":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"}}}}},{"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":"No response was specified","schema":{"type":"object","properties":{"_id":{"type":"string"},"tenantId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"name":{"type":"string"},"excludeFromSharing":{"type":"boolean","default":false},"created":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"}}}},"400":{"description":"invalid input"},"403":{"description":"User does not have permission"}}},"delete":{"tags":["groups"],"operationId":"deleteGroups","x-permission-type":"general","x-roles-allowed":"tenantAdmin,admin","x-permission-path":"manage/groups/remove","summary":"Deletes multiple groups by group name or ID.","description":"Operations about groups","parameters":[{"in":"body","description":"The IDs of the groups to delete.","name":"deleteGroup","required":false,"schema":{"type":"object","properties":{"groups":{"type":"array","items":{"type":"string"}},"deleteAdUsers":{"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"},{"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":"No response was specified"},"400":{"description":"invalid id"},"403":{"description":"User does not have permission"},"404":{"description":"id not found"}}}},"/groups/ad":{"x-swagger-router-controller":"groups.controller.v0.9","get":{"tags":["groups"],"operationId":"getAdGroups","x-roles-allowed":"tenantAdmin,admin","x-permission-type":"general","x-permission-path":"manage/groups/get","summary":"Searches for groups directly in Active Directory.","description":"Operations about groups","parameters":[{"in":"query","description":"Limits the result set to a defined number of results. Enter 0 (zero) or leave blank not to limit. - 0 or blank to not limit","name":"limit","required":false,"type":"integer","format":"int32"},{"in":"query","description":"Check if a group exists in Active Directory, and if not, searches groups created in Sisense.","name":"checkExist","required":false,"type":"boolean"},{"in":"query","description":"Enter a search query to return results matching the query.","name":"search","required":false,"type":"string"},{"in":"query","description":"Enter a domain name or id.","name":"domain","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"}],"responses":{"200":{"description":"No response was specified","schema":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"objectSid":{"type":"string","pattern":"^\\[\\d{1,3}((?:,\\d{1,3}){27}|(?:,\\d{1,3}){15})\\]$"},"cn/name":{"type":"string"},"dn":{"type":"string"},"name":{"type":"string"},"uSNChanged":{"type":"string"},"mail":{"type":"string"},"roleId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"created":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"}}}}},"400":{"description":"invalid skip"},"403":{"description":"User does not have permission"}}},"post":{"tags":["groups"],"operationId":"addAdGroups","x-roles-allowed":"tenantAdmin,admin","x-permission-type":"general","x-permission-path":"manage/groups/add","x-middleware":["attachTenantIdToEntitiesWithUserTenant"],"summary":"Adds a new Active Directory user group.","description":"Operations about groups","parameters":[{"in":"body","description":"The group object that needs to be added to the collection.","name":"newGroups","required":false,"schema":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"objectSid":{"type":"string","pattern":"^\\[\\d{1,3}((?:,\\d{1,3}){27}|(?:,\\d{1,3}){15})\\]$"},"cn/name":{"type":"string"},"dn":{"type":"string"},"name":{"type":"string"},"uSNChanged":{"type":"string"},"mail":{"type":"string"},"roleId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"created":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"}}}}},{"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":"No response was specified","schema":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"created":{"type":"string","format":"date-time"},"mail":{"type":"string"},"roleId":{"type":"string","pattern":"(^[0-9a-fA-F]{24}$|^[Nn][Uu][Ll]{2}$)"},"baseRoleName":{"type":"string"},"cn/name":{"type":"string"},"dn":{"type":"string"},"member":{"type":"array","items":{"type":"string"}},"uSNChanged":{"type":"string"},"objectSid":{"type":"string","pattern":"^\\[\\d{1,3}(?:,\\d{1,3}){27}\\]$"},"lastUpdated":{"type":"string","format":"date-time"},"defaultRole":{"type":"string"},"language":{"type":"string"},"excludeFromSharing":{"type":"boolean","default":false},"timeout":{"type":["string","number","null"]}}}},"400":{"description":"invalid input"},"403":{"description":"User does not have permission"}}}},"/groups/allDirectories":{"x-swagger-router-controller":"groups.controller.v0.9","get":{"tags":["groups"],"operationId":"getAllDirectoriesGroups","x-permission-type":"general","x-permission-path":"manage/groups/get","x-roles-allowed":"tenantAdmin,admin","summary":"Searches for groups in all directories.","description":"Operations about groups","parameters":[{"in":"query","description":"Limits the result set to a defined number of results. Enter 0 (zero) or leave blank not to limit. - 0 or blank to not limit","name":"limit","required":false,"type":"integer","format":"int32"},{"in":"query","description":"Enter a search query to return results matching the query.","name":"search","required":false,"type":"string"},{"in":"query","description":"Returns the number of users per group.","name":"usersCount","required":false,"type":"boolean"},{"in":"query","description":"Returns the domain details of each AD group.","name":"includeDomain","required":false,"type":"boolean"},{"in":"query","description":"Searches exact matches.","name":"exactMatch","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"},{"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":"No response was specified","schema":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"created":{"type":"string","format":"date-time"},"mail":{"type":"string"},"roleId":{"type":"string","pattern":"(^[0-9a-fA-F]{24}$|^[Nn][Uu][Ll]{2}$)"},"baseRoleName":{"type":"string"},"cn/name":{"type":"string"},"dn":{"type":"string"},"member":{"type":"array","items":{"type":"string"}},"uSNChanged":{"type":"string"},"objectSid":{"type":"string","pattern":"^\\[\\d{1,3}(?:,\\d{1,3}){27}\\]$"},"lastUpdated":{"type":"string","format":"date-time"},"defaultRole":{"type":"string"},"language":{"type":"string"},"excludeFromSharing":{"type":"boolean","default":false},"timeout":{"type":["string","number","null"]}}}}},"400":{"description":"invalid search"},"403":{"description":"User does not have permission"}}}},"/groups/{group}":{"x-swagger-router-controller":"groups.controller.v0.9","get":{"tags":["groups"],"operationId":"findByIdName","x-permission-type":"general","x-permission-path":"manage/groups/get","x-roles-allowed":"tenantAdmin,admin","summary":"Returns metadata for a group by group ID or name.","description":"Operations about groups","parameters":[{"in":"path","description":"The ID or username of the group","name":"group","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":"No response was specified","schema":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"created":{"type":"string","format":"date-time"},"mail":{"type":"string"},"roleId":{"type":"string","pattern":"(^[0-9a-fA-F]{24}$|^[Nn][Uu][Ll]{2}$)"},"baseRoleName":{"type":"string"},"cn/name":{"type":"string"},"dn":{"type":"string"},"member":{"type":"array","items":{"type":"string"}},"uSNChanged":{"type":"string"},"objectSid":{"type":"string","pattern":"^\\[\\d{1,3}(?:,\\d{1,3}){27}\\]$"},"lastUpdated":{"type":"string","format":"date-time"},"defaultRole":{"type":"string"},"language":{"type":"string"},"excludeFromSharing":{"type":"boolean","default":false},"timeout":{"type":["string","number","null"]}}}},"400":{"description":"invalid id"},"403":{"description":"User does not have permission"},"404":{"description":"id not found"}}},"put":{"tags":["groups"],"operationId":"updateGroup","x-permission-type":"general","x-permission-path":"manage/groups/modify","x-roles-allowed":"tenantAdmin,admin","x-middleware":["attachTenantIdToEntitiesWithUserTenant"],"summary":"Updates a group by group ID or name. What are we updating? name, role (only for AD)","description":"Operations about groups","parameters":[{"in":"path","description":"The group's ID or name.","name":"group","required":true,"type":"string"},{"in":"body","description":"The group object that needs to be updated.","name":"groupUpdate","required":false,"schema":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"created":{"type":"string","format":"date-time"},"mail":{"type":"string"},"roleId":{"type":"string","pattern":"(^[0-9a-fA-F]{24}$|^[Nn][Uu][Ll]{2}$)"},"baseRoleName":{"type":"string"},"cn/name":{"type":"string"},"dn":{"type":"string"},"member":{"type":"array","items":{"type":"string"}},"uSNChanged":{"type":"string"},"objectSid":{"type":"string","pattern":"^\\[\\d{1,3}(?:,\\d{1,3}){27}\\]$"},"lastUpdated":{"type":"string","format":"date-time"},"defaultRole":{"type":"string"},"language":{"type":"string"},"excludeFromSharing":{"type":"boolean","default":false},"timeout":{"type":["string","number","null"]}}}},{"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":"No response was specified"},"400":{"description":"invalid id"},"403":{"description":"User does not have permission"},"404":{"description":"id not found"}}},"delete":{"tags":["groups"],"operationId":"deleteGroupByIdName","x-permission-type":"general","x-permission-path":"manage/groups/remove","x-roles-allowed":"tenantAdmin,admin","summary":"Deletes a group by group ID or name.","description":"Operations about groups","parameters":[{"in":"path","description":"The group's ID or name.","name":"group","required":true,"type":"string"},{"in":"query","description":"Select true if you want to delete the users of the Active Directory group.","name":"deleteAdUsers","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"},{"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":"No response was specified"},"400":{"description":"invalid id"},"403":{"description":"User does not have permission"},"404":{"description":"id not found"}}}},"/groups/{group}/users":{"x-swagger-router-controller":"groups.controller.v0.9","get":{"tags":["groups"],"operationId":"getGroupUsers","x-roles-allowed":"tenantAdmin,admin","x-permission-type":"general","x-permission-path":"manage/groups/get","summary":"Returns a list of users in a group together with each user's metadata.","description":"Operations about groups","parameters":[{"in":"path","description":"The group's ID or username.","name":"group","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":"No response was specified","schema":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"active":{"type":"boolean"},"activeDirectory":{"type":"boolean"},"adgroups":{"type":"array","items":{"type":"object"}},"baseRoleName":{"type":"string"},"changePasswordState":{"type":"boolean"},"created":{"type":"string","format":"date-time"},"createdSso":{"type":"string"},"dn":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"groups":{"type":"array","items":{"type":"string"}},"hash":{"type":"string"},"lastLogin":{"type":"string","format":"date-time"},"lastName":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"},"ldapDomainId":{"type":"string"},"pendingExpiration":{"type":"string","format":"date-time"},"preferences":{"type":"object","properties":{"localeId":{"type":"string"},"language":{"type":"string"}}},"principalName":{"type":"string"},"roleId":{"type":"string"},"roleName":{"type":"string"},"uSNChanged":{"type":"string"},"userName":{"type":"string"}}}}},"400":{"description":"invalid id"},"403":{"description":"User does not have permission"},"404":{"description":"id not found"}}},"post":{"tags":["groups"],"operationId":"addGroupUsers","x-roles-allowed":"tenantAdmin,admin","x-permission-type":"general","x-permission-path":"manage/groups/modify","summary":"Adds users to a Sisense user group.","description":"Operations about groups","parameters":[{"in":"path","description":"The group's ID or name.","name":"group","required":true,"type":"string"},{"in":"body","description":"The IDs or usernames of the users that need to be added to the group.","name":"usersArray","required":false,"schema":{"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"},{"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":"No response was specified","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"invalid input"},"403":{"description":"User does not have permission"}}},"delete":{"tags":["groups"],"operationId":"deleteGroupUsers","x-permission-type":"general","x-permission-path":"manage/groups/remove","x-roles-allowed":"tenantAdmin,admin","summary":"Removes users from a user group.","description":"Operations about groups","parameters":[{"in":"path","description":"The group's ID or name.","name":"group","required":true,"type":"string"},{"in":"body","description":"The user IDs or usernames to remove from the group.","name":"usersArray","required":false,"schema":{"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"},{"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":"No response was specified","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"invalid input"},"403":{"description":"User does not have permission"}}}},"/groups/byIds":{"x-swagger-router-controller":"groups.controller.v0.9","post":{"tags":["groups"],"operationId":"findByIds","x-roles-allowed":"tenantAdmin,admin","x-permission-type":"general","x-permission-path":"manage/groups/get","summary":"Returns a list of groups by groups IDs.","description":"Operations about groups","parameters":[{"in":"body","description":"List of groups Ids","name":"idsList","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"in":"query","description":"Returns the number of users per group.","name":"usersCount","required":false,"type":"boolean"},{"in":"query","description":"Returns the domain details of each AD group.","name":"includeDomain","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"},{"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":"No response was specified","schema":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"created":{"type":"string","format":"date-time"},"mail":{"type":"string"},"roleId":{"type":"string","pattern":"(^[0-9a-fA-F]{24}$|^[Nn][Uu][Ll]{2}$)"},"baseRoleName":{"type":"string"},"cn/name":{"type":"string"},"dn":{"type":"string"},"member":{"type":"array","items":{"type":"string"}},"uSNChanged":{"type":"string"},"objectSid":{"type":"string","pattern":"^\\[\\d{1,3}(?:,\\d{1,3}){27}\\]$"},"lastUpdated":{"type":"string","format":"date-time"},"defaultRole":{"type":"string"},"language":{"type":"string"},"excludeFromSharing":{"type":"boolean","default":false},"timeout":{"type":["string","number","null"]}}}}},"400":{"description":"invalid id"},"403":{"description":"User does not have permission"},"404":{"description":"id not found"}}}},"/groups/validateName":{"x-swagger-router-controller":"groups.controller.v0.9","post":{"tags":["groups"],"operationId":"validateName","x-roles-allowed":"tenantAdmin,admin","x-permission-type":"general","x-permission-path":"manage/groups/modify","summary":"Checks if the group exists.","description":"Operations about groups","parameters":[{"in":"body","description":"The name of the group to validate.","name":"group","required":false,"schema":{"type":"object","properties":{"name":{"type":"string"},"tenantId":{"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"},{"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":"No response was specified","schema":{"type":"boolean"}},"400":{"description":"invalid id"},"403":{"description":"User does not have permission"},"404":{"description":"id not found"}}}},"/roles":{"x-swagger-router-controller":"roles.controller.v0.9","get":{"tags":["roles"],"operationId":"getAllRoles","x-permission-type":"designers-and-admins-only","x-roles-allowed":"tenantAdmin,admin","summary":"Returns all the role types and the enabled permissions per role type.","description":"Get all roles","parameters":[{"in":"query","description":"Includes the role's manifest (list of permissions showing what's enabled/disabled).","name":"includeManifest","required":false,"type":"boolean"},{"in":"query","description":"Includes the role's base role name.","name":"includeBaseRolesName","required":false,"type":"boolean"},{"in":"query","description":"Select True.","name":"compiledRoles","required":false,"type":"boolean"},{"in":"query","description":"If true, the response will always be '200' with fail and success codes presented in an array.","name":"envelop","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"},{"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":"No response was specified","schema":{"type":"array","items":{"type":"object","properties":{"baseRoleName":{"type":"string"},"desc":{"type":"string"},"manifest":{"properties":{"dashboards":{"properties":{"create":{"type":"boolean"},"duplicate":{"type":"boolean"},"edit_script":{"type":"boolean"},"export_dash":{"type":"boolean"},"export_image":{"type":"boolean"},"export_pdf":{"type":"boolean"},"filters":{"properties":{"advanced":{"type":"boolean"},"create":{"type":"boolean"},"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_auto_update":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"import":{"type":"boolean"},"rename":{"type":"boolean"},"restore":{"type":"boolean"},"select_palette":{"type":"boolean"},"toggle_edit_mode":{"type":"boolean"}}},"widgets":{"properties":{"change_type":{"type":"boolean"},"create":{"type":"boolean"},"delete":{"type":"boolean"},"drill_to_anywhere":{"type":"boolean"},"duplicate":{"type":"boolean"},"edit_script":{"type":"boolean"},"export_csv":{"type":"boolean"},"export_png":{"type":"boolean"},"filters":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"items":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"reorder":{"type":"boolean"}}},"modify_selection_mode":{"type":"boolean"},"rename":{"type":"boolean"}}}}},"name":{"type":"string"},"parent":{"type":"string"}}}}},"403":{"description":"User does not have permission"}}},"post":{"tags":["roles"],"operationId":"addRole","x-permission-type":"admins-only","summary":"Adds a new role (currently not supported).","description":"Add new role","parameters":[{"in":"body","description":"role object that needs to be added to the collection","name":"role","required":false,"schema":{"type":"object","properties":{"baseRoleName":{"type":"string"},"desc":{"type":"string"},"manifest":{"properties":{"dashboards":{"properties":{"create":{"type":"boolean"},"duplicate":{"type":"boolean"},"edit_script":{"type":"boolean"},"export_dash":{"type":"boolean"},"export_image":{"type":"boolean"},"export_pdf":{"type":"boolean"},"filters":{"properties":{"advanced":{"type":"boolean"},"create":{"type":"boolean"},"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_auto_update":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"import":{"type":"boolean"},"rename":{"type":"boolean"},"restore":{"type":"boolean"},"select_palette":{"type":"boolean"},"toggle_edit_mode":{"type":"boolean"}}},"widgets":{"properties":{"change_type":{"type":"boolean"},"create":{"type":"boolean"},"delete":{"type":"boolean"},"drill_to_anywhere":{"type":"boolean"},"duplicate":{"type":"boolean"},"edit_script":{"type":"boolean"},"export_csv":{"type":"boolean"},"export_png":{"type":"boolean"},"filters":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"items":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"reorder":{"type":"boolean"}}},"modify_selection_mode":{"type":"boolean"},"rename":{"type":"boolean"}}}}},"name":{"type":"string"},"parent":{"type":"string"}}}},{"in":"query","description":"wrap response with status 200","name":"envelop","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"},{"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":"No response was specified","schema":{"type":"object","properties":{"baseRoleName":{"type":"string"},"desc":{"type":"string"},"manifest":{"properties":{"dashboards":{"properties":{"create":{"type":"boolean"},"duplicate":{"type":"boolean"},"edit_script":{"type":"boolean"},"export_dash":{"type":"boolean"},"export_image":{"type":"boolean"},"export_pdf":{"type":"boolean"},"filters":{"properties":{"advanced":{"type":"boolean"},"create":{"type":"boolean"},"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_auto_update":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"import":{"type":"boolean"},"rename":{"type":"boolean"},"restore":{"type":"boolean"},"select_palette":{"type":"boolean"},"toggle_edit_mode":{"type":"boolean"}}},"widgets":{"properties":{"change_type":{"type":"boolean"},"create":{"type":"boolean"},"delete":{"type":"boolean"},"drill_to_anywhere":{"type":"boolean"},"duplicate":{"type":"boolean"},"edit_script":{"type":"boolean"},"export_csv":{"type":"boolean"},"export_png":{"type":"boolean"},"filters":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"items":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"reorder":{"type":"boolean"}}},"modify_selection_mode":{"type":"boolean"},"rename":{"type":"boolean"}}}}},"name":{"type":"string"},"parent":{"type":"string"}}}},"400":{"description":"invalid input"},"403":{"description":"User does not have permission"}}}},"/roles/{idOrName}":{"x-swagger-router-controller":"roles.controller.v0.9","get":{"tags":["roles"],"operationId":"getRoleByIdOrName","x-permission-type":"none","summary":"Returns the user role by role ID or role name.","description":"Get role by id or name","parameters":[{"in":"path","description":"The name or ID of the role.","name":"idOrName","required":true,"type":"string"},{"in":"query","description":"True returns full list of role permissions. False returns the compiled base role name.","name":"compiledRole","required":false,"type":"boolean"},{"in":"query","description":"wrap response with status 200","name":"envelop","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"},{"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":"No response was specified","schema":{"type":"object","properties":{"baseRoleName":{"type":"string"},"desc":{"type":"string"},"manifest":{"properties":{"dashboards":{"properties":{"create":{"type":"boolean"},"duplicate":{"type":"boolean"},"edit_script":{"type":"boolean"},"export_dash":{"type":"boolean"},"export_image":{"type":"boolean"},"export_pdf":{"type":"boolean"},"filters":{"properties":{"advanced":{"type":"boolean"},"create":{"type":"boolean"},"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_auto_update":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"import":{"type":"boolean"},"rename":{"type":"boolean"},"restore":{"type":"boolean"},"select_palette":{"type":"boolean"},"toggle_edit_mode":{"type":"boolean"}}},"widgets":{"properties":{"change_type":{"type":"boolean"},"create":{"type":"boolean"},"delete":{"type":"boolean"},"drill_to_anywhere":{"type":"boolean"},"duplicate":{"type":"boolean"},"edit_script":{"type":"boolean"},"export_csv":{"type":"boolean"},"export_png":{"type":"boolean"},"filters":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"items":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"reorder":{"type":"boolean"}}},"modify_selection_mode":{"type":"boolean"},"rename":{"type":"boolean"}}}}},"name":{"type":"string"},"parent":{"type":"string"}}}},"400":{"description":"invalid idOrName"},"403":{"description":"User does not have permission"},"404":{"description":"idOrName not found"}}},"delete":{"tags":["roles"],"operationId":"deleteRoleByIdOrName","x-permission-type":"admins-only","summary":"Deletes a user role by ID or name.","description":"Delete role by id or name","parameters":[{"in":"path","description":"The name or ID of the role.","name":"idOrName","required":true,"type":"string"},{"in":"query","description":"wrap response with status 200","name":"envelop","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"},{"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":"No response was specified"},"400":{"description":"invalid idOrName"},"403":{"description":"User does not have permission"},"404":{"description":"idOrName not found"}}},"put":{"tags":["roles"],"operationId":"updateRoleByIdOrName","x-permission-type":"admins-only","summary":"Updates a user role by role ID or name.","description":"Update role by id or name","parameters":[{"in":"path","description":"The name or ID of the role.","name":"idOrName","required":true,"type":"string"},{"in":"body","description":"The updated role object should include the path to the setting you want to change and the setting.","name":"role","required":false,"schema":{"type":"object","properties":{"baseRoleName":{"type":"string"},"desc":{"type":"string"},"manifest":{"properties":{"dashboards":{"properties":{"create":{"type":"boolean"},"duplicate":{"type":"boolean"},"edit_script":{"type":"boolean"},"export_dash":{"type":"boolean"},"export_image":{"type":"boolean"},"export_pdf":{"type":"boolean"},"filters":{"properties":{"advanced":{"type":"boolean"},"create":{"type":"boolean"},"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_auto_update":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"import":{"type":"boolean"},"rename":{"type":"boolean"},"restore":{"type":"boolean"},"select_palette":{"type":"boolean"},"toggle_edit_mode":{"type":"boolean"}}},"widgets":{"properties":{"change_type":{"type":"boolean"},"create":{"type":"boolean"},"delete":{"type":"boolean"},"drill_to_anywhere":{"type":"boolean"},"duplicate":{"type":"boolean"},"edit_script":{"type":"boolean"},"export_csv":{"type":"boolean"},"export_png":{"type":"boolean"},"filters":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"items":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"reorder":{"type":"boolean"}}},"modify_selection_mode":{"type":"boolean"},"rename":{"type":"boolean"}}}}},"name":{"type":"string"},"parent":{"type":"string"}}}},{"in":"query","description":"wrap response with status 200","name":"envelop","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"},{"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":"No response was specified","schema":{"type":"object","properties":{"baseRoleName":{"type":"string"},"desc":{"type":"string"},"manifest":{"properties":{"dashboards":{"properties":{"create":{"type":"boolean"},"duplicate":{"type":"boolean"},"edit_script":{"type":"boolean"},"export_dash":{"type":"boolean"},"export_image":{"type":"boolean"},"export_pdf":{"type":"boolean"},"filters":{"properties":{"advanced":{"type":"boolean"},"create":{"type":"boolean"},"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_auto_update":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"import":{"type":"boolean"},"rename":{"type":"boolean"},"restore":{"type":"boolean"},"select_palette":{"type":"boolean"},"toggle_edit_mode":{"type":"boolean"}}},"widgets":{"properties":{"change_type":{"type":"boolean"},"create":{"type":"boolean"},"delete":{"type":"boolean"},"drill_to_anywhere":{"type":"boolean"},"duplicate":{"type":"boolean"},"edit_script":{"type":"boolean"},"export_csv":{"type":"boolean"},"export_png":{"type":"boolean"},"filters":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"items":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"reorder":{"type":"boolean"}}},"modify_selection_mode":{"type":"boolean"},"rename":{"type":"boolean"}}}}},"name":{"type":"string"},"parent":{"type":"string"}}}},"400":{"description":"invalid idOrName"},"403":{"description":"User does not have permission"},"404":{"description":"idOrName not found"}}}},"/roles/{idOrName}/manifest/{path}":{"x-swagger-router-controller":"roles.controller.v0.9","get":{"tags":["roles"],"operationId":"getManifestByPath","x-permission-type":"none","summary":"Returns the permissions of a user role under a specific path in the role manifest.","description":"Get manifest by id or name and path","parameters":[{"in":"path","description":"The name or ID of the role.","name":"idOrName","required":true,"type":"string"},{"in":"path","description":"Encoded path to the manifest, for example, /dashboards/filters will return all permissions under filters.","name":"path","required":true,"type":"string"},{"in":"query","description":"True returns full list of role permissions. False returns the compiled base role name.","name":"compiledRole","required":false,"type":"boolean"},{"in":"query","description":"wrap response with status 200","name":"envelop","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"},{"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":"No response was specified","schema":{"properties":{"dashboards":{"properties":{"create":{"type":"boolean"},"duplicate":{"type":"boolean"},"edit_script":{"type":"boolean"},"export_dash":{"type":"boolean"},"export_image":{"type":"boolean"},"export_pdf":{"type":"boolean"},"filters":{"properties":{"advanced":{"type":"boolean"},"create":{"type":"boolean"},"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_auto_update":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"import":{"type":"boolean"},"rename":{"type":"boolean"},"restore":{"type":"boolean"},"select_palette":{"type":"boolean"},"toggle_edit_mode":{"type":"boolean"}}},"widgets":{"properties":{"change_type":{"type":"boolean"},"create":{"type":"boolean"},"delete":{"type":"boolean"},"drill_to_anywhere":{"type":"boolean"},"duplicate":{"type":"boolean"},"edit_script":{"type":"boolean"},"export_csv":{"type":"boolean"},"export_png":{"type":"boolean"},"filters":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"items":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"reorder":{"type":"boolean"}}},"modify_selection_mode":{"type":"boolean"},"rename":{"type":"boolean"}}}}}},"400":{"description":"invalid idOrName"},"403":{"description":"User does not have permission"},"404":{"description":"idOrName not found"}}},"delete":{"tags":["roles"],"operationId":"deleteManifestByPath","x-permission-type":"admins-only","summary":"Restores some or all permissions under a specific path in the role manifest.","description":"delete manifest by id or name and path","parameters":[{"in":"path","description":"The name or ID of the role.","name":"idOrName","required":true,"type":"string"},{"in":"path","description":"Encoded path to the manifest. Enter the full path of the setting you want to change, as it appears in the hierarchy. ","name":"path","required":true,"type":"string"},{"in":"query","description":"wrap response with status 200","name":"envelop","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"},{"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":"No response was specified","schema":{"type":"object","properties":{"baseRoleName":{"type":"string"},"desc":{"type":"string"},"manifest":{"properties":{"dashboards":{"properties":{"create":{"type":"boolean"},"duplicate":{"type":"boolean"},"edit_script":{"type":"boolean"},"export_dash":{"type":"boolean"},"export_image":{"type":"boolean"},"export_pdf":{"type":"boolean"},"filters":{"properties":{"advanced":{"type":"boolean"},"create":{"type":"boolean"},"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_auto_update":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"import":{"type":"boolean"},"rename":{"type":"boolean"},"restore":{"type":"boolean"},"select_palette":{"type":"boolean"},"toggle_edit_mode":{"type":"boolean"}}},"widgets":{"properties":{"change_type":{"type":"boolean"},"create":{"type":"boolean"},"delete":{"type":"boolean"},"drill_to_anywhere":{"type":"boolean"},"duplicate":{"type":"boolean"},"edit_script":{"type":"boolean"},"export_csv":{"type":"boolean"},"export_png":{"type":"boolean"},"filters":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"items":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"reorder":{"type":"boolean"}}},"modify_selection_mode":{"type":"boolean"},"rename":{"type":"boolean"}}}}},"name":{"type":"string"},"parent":{"type":"string"}}}},"400":{"description":"invalid idOrName"},"403":{"description":"User does not have permission"},"404":{"description":"idOrName not found"}}},"put":{"tags":["roles"],"operationId":"updateManifestByPath","x-permission-type":"admins-only","summary":"Updates permissions in a user role manifest by role ID or name.","description":"update manifest by id or name and path","parameters":[{"in":"path","description":"The name or ID of the role.","name":"idOrName","required":true,"type":"string"},{"in":"path","description":"Encoded path to the manifest. Enter the path to the setting that you want to change as it appears in the hierarchy. Do not include the setting in the path. Example: To change the ‘Create’ setting for dashboard filters, enter dashboards/filters/. For creating dashboards, enter /dashboards.","name":"path","required":true,"type":"string"},{"in":"body","description":"updated manifest object","name":"manifest","required":false,"schema":{"properties":{"dashboards":{"properties":{"create":{"type":"boolean"},"duplicate":{"type":"boolean"},"edit_script":{"type":"boolean"},"export_dash":{"type":"boolean"},"export_image":{"type":"boolean"},"export_pdf":{"type":"boolean"},"filters":{"properties":{"advanced":{"type":"boolean"},"create":{"type":"boolean"},"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_auto_update":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"import":{"type":"boolean"},"rename":{"type":"boolean"},"restore":{"type":"boolean"},"select_palette":{"type":"boolean"},"toggle_edit_mode":{"type":"boolean"}}},"widgets":{"properties":{"change_type":{"type":"boolean"},"create":{"type":"boolean"},"delete":{"type":"boolean"},"drill_to_anywhere":{"type":"boolean"},"duplicate":{"type":"boolean"},"edit_script":{"type":"boolean"},"export_csv":{"type":"boolean"},"export_png":{"type":"boolean"},"filters":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"items":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"reorder":{"type":"boolean"}}},"modify_selection_mode":{"type":"boolean"},"rename":{"type":"boolean"}}}}}},{"in":"query","description":"wrap response with status 200","name":"envelop","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"},{"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":"No response was specified","schema":{"type":"object","properties":{"baseRoleName":{"type":"string"},"desc":{"type":"string"},"manifest":{"properties":{"dashboards":{"properties":{"create":{"type":"boolean"},"duplicate":{"type":"boolean"},"edit_script":{"type":"boolean"},"export_dash":{"type":"boolean"},"export_image":{"type":"boolean"},"export_pdf":{"type":"boolean"},"filters":{"properties":{"advanced":{"type":"boolean"},"create":{"type":"boolean"},"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_auto_update":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"import":{"type":"boolean"},"rename":{"type":"boolean"},"restore":{"type":"boolean"},"select_palette":{"type":"boolean"},"toggle_edit_mode":{"type":"boolean"}}},"widgets":{"properties":{"change_type":{"type":"boolean"},"create":{"type":"boolean"},"delete":{"type":"boolean"},"drill_to_anywhere":{"type":"boolean"},"duplicate":{"type":"boolean"},"edit_script":{"type":"boolean"},"export_csv":{"type":"boolean"},"export_png":{"type":"boolean"},"filters":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"items":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"reorder":{"type":"boolean"}}},"modify_selection_mode":{"type":"boolean"},"rename":{"type":"boolean"}}}}},"name":{"type":"string"},"parent":{"type":"string"}}}},"400":{"description":"invalid idOrName"},"403":{"description":"User does not have permission"},"404":{"description":"idOrName not found"}}},"post":{"tags":["roles"],"operationId":"addToManifestByPath","x-permission-type":"admins-only","summary":"Updates a user role manifest by role ID or name.","description":"add manifest by id or name and path","parameters":[{"in":"path","description":"The name or ID of the role.","name":"idOrName","required":true,"type":"string"},{"in":"path","description":"Encoded path to the manifest. Enter the path to the setting that you want to change as it appears in the hierarchy. Do not include the setting in the path. Example: To change the ‘Create’ setting for dashboard filters, enter dashboards/filters/. For creating dashboards, enter /dashboards. See the reference table above for more settings.","name":"path","required":true,"type":"string"},{"in":"body","description":"The updated manifest object. Defines whether to enable or disable the setting. For example, to enable ‘create’, type in: create: true","name":"manifest","required":false,"schema":{"properties":{"dashboards":{"properties":{"create":{"type":"boolean"},"duplicate":{"type":"boolean"},"edit_script":{"type":"boolean"},"export_dash":{"type":"boolean"},"export_image":{"type":"boolean"},"export_pdf":{"type":"boolean"},"filters":{"properties":{"advanced":{"type":"boolean"},"create":{"type":"boolean"},"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_auto_update":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"import":{"type":"boolean"},"rename":{"type":"boolean"},"restore":{"type":"boolean"},"select_palette":{"type":"boolean"},"toggle_edit_mode":{"type":"boolean"}}},"widgets":{"properties":{"change_type":{"type":"boolean"},"create":{"type":"boolean"},"delete":{"type":"boolean"},"drill_to_anywhere":{"type":"boolean"},"duplicate":{"type":"boolean"},"edit_script":{"type":"boolean"},"export_csv":{"type":"boolean"},"export_png":{"type":"boolean"},"filters":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"items":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"reorder":{"type":"boolean"}}},"modify_selection_mode":{"type":"boolean"},"rename":{"type":"boolean"}}}}}},{"in":"query","description":"wrap response with status 200","name":"envelop","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"},{"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":"No response was specified","schema":{"type":"object","properties":{"baseRoleName":{"type":"string"},"desc":{"type":"string"},"manifest":{"properties":{"dashboards":{"properties":{"create":{"type":"boolean"},"duplicate":{"type":"boolean"},"edit_script":{"type":"boolean"},"export_dash":{"type":"boolean"},"export_image":{"type":"boolean"},"export_pdf":{"type":"boolean"},"filters":{"properties":{"advanced":{"type":"boolean"},"create":{"type":"boolean"},"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_auto_update":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"import":{"type":"boolean"},"rename":{"type":"boolean"},"restore":{"type":"boolean"},"select_palette":{"type":"boolean"},"toggle_edit_mode":{"type":"boolean"}}},"widgets":{"properties":{"change_type":{"type":"boolean"},"create":{"type":"boolean"},"delete":{"type":"boolean"},"drill_to_anywhere":{"type":"boolean"},"duplicate":{"type":"boolean"},"edit_script":{"type":"boolean"},"export_csv":{"type":"boolean"},"export_png":{"type":"boolean"},"filters":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"items":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"reorder":{"type":"boolean"}}},"modify_selection_mode":{"type":"boolean"},"rename":{"type":"boolean"}}}}},"name":{"type":"string"},"parent":{"type":"string"}}}},"400":{"description":"invalid idOrName"},"403":{"description":"User does not have permission"},"404":{"description":"idOrName not found"}}}},"/elasticubes/{server}/{elasticube}/permissions":{"get":{"tags":["elasticubes"],"operationId":"elasticubesAuthForCube","summary":"Returns all authentication records for the given cube","description":"Returns all authentication records for the given cube","parameters":[{"in":"path","description":"Address of the server containing the cube","name":"server","required":true,"type":"string"},{"in":"path","description":"Title or Id of the elasticube","name":"elasticube","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":"No response was specified","schema":{"$ref":"#/definitions/elasticubeAuth"}},"400":{"description":"invalid cubeId"},"403":{"description":"User does not have permission"}},"x-permission-type":"authenticate"},"post":{"tags":["elasticubes"],"operationId":"addElasticubePermissions","summary":"Defines a new permission for the given ElastiCube.","parameters":[{"in":"path","description":"The server address of the ElastiCube.","name":"server","required":true,"type":"string"},{"in":"path","description":"The name or ID of the ElastiCube","name":"elasticube","required":true,"type":"string"},{"in":"body","description":"The 'shares' is an array containing the different permissions. Each permission is an ACL (access control level).","name":"shares","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/acl"}}},{"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":"No response was specified","schema":{"type":"boolean"}},"400":{"description":"invalid cubeId"},"403":{"description":"User does not have permission"}},"x-permission-type":"authenticate"},"put":{"tags":["elasticubes"],"operationId":"updateElasticubePermissions","summary":"Updates the permissions (ACLs) for the current ElastiCube.","parameters":[{"in":"path","description":"The server address of the ElastiCube.","name":"server","required":true,"type":"string"},{"in":"path","description":"The name or ID of the ElastiCube","name":"elasticube","required":true,"type":"string"},{"in":"body","description":"The 'shares' is an array containing the different permissions. Each permission is an ACL (access control level).","name":"shares","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/acl"}}},{"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":"No response was specified","schema":{"type":"boolean"}},"400":{"description":"invalid cubeId"},"403":{"description":"User does not have permission"}},"x-permission-type":"data-admins-only"},"delete":{"tags":["elasticubes"],"operationId":"deleteElasticubePermissions","summary":"Deletes all permissions for the ElastiCube.","parameters":[{"in":"path","description":"The server address of the ElastiCube.","name":"server","required":true,"type":"string"},{"in":"path","description":"The name or ID of the ElastiCube.","name":"elasticube","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":"No response was specified","schema":{"type":"boolean"}},"400":{"description":"invalid cubeId"},"403":{"description":"User does not have permission"}},"x-permission-type":"authenticate"}},"/elasticubes/{server}/{elasticube}/datasecurity":{"get":{"tags":["elasticubes"],"operationId":"getElasticubeDataSecurity","summary":"Return data security rules for an elasticube","description":"Return data security rules for an elasticube","parameters":[{"in":"path","description":"The ElastiCube's server address.","name":"server","required":true,"type":"string"},{"in":"path","description":"The name of the ElastiCube.","name":"elasticube","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":"No response was specified"},"400":{"description":"invalid elastiCube identifier"},"403":{"description":"User does not have permission"}},"x-permission-type":"authenticate"},"post":{"tags":["elasticubes"],"operationId":"addElasticubeDataSecurityForDatasource","summary":"Add new data context for datasource","description":"Defines data security for an ElastiCube.","parameters":[{"in":"path","description":"The server address of the ElastiCube.","name":"server","required":true,"type":"string"},{"in":"path","description":"The name of the ElastiCube.","name":"elasticube","required":true,"type":"string"},{"in":"body","description":"The array of data security rules that should be added.\n<br /><b>exclusionary</b> - This boolean determines if a data security rule is exclusionary or inclusionary. By default, this value is <b>false</b>, which means all rules are inclusionary.When a rule is inclusionary, all defined members can see the relevant rows. When a rule is exclusionary, the relevant rows are hidden from all defined members.","name":"Array of DataSecurity objects description","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/elasticubeNewDataSecurityItemCubeGiven"}}},{"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":"No response was specified"},"403":{"description":"User does not have permission"},"404":{"description":"dataContext not found"}},"x-permission-type":"authenticate"},"delete":{"tags":["elasticubes"],"operationId":"deleteDataContextForColumnQuery","summary":"Delete data security rule for a column","description":"Delete data security rule for a column","parameters":[{"in":"path","description":"server address","name":"server","required":true,"type":"string"},{"in":"path","description":"elasticube name","name":"elasticube","required":true,"type":"string"},{"in":"query","description":"table name","name":"table","required":true,"type":"string"},{"in":"query","description":"column name","name":"column","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":"No response was specified"},"400":{"description":"invalid datasource identifier"},"403":{"description":"User does not have permission"}},"x-permission-type":"authenticate"}},"/elasticubes/{server}/{cube}/{user}/datasecurity":{"get":{"tags":["elasticubes"],"operationId":"getElasticubeDataSecurityForUser","summary":"Return data security rules for a user","description":"Return data security rules for a user","parameters":[{"in":"path","description":"The ElastiCube's server address","name":"server","required":true,"type":"string"},{"in":"path","description":"The ElastiCube's name","name":"cube","required":true,"type":"string"},{"in":"path","description":"The user's ID or username.","name":"user","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":"No response was specified"},"400":{"description":"invalid elasticube identifier"},"403":{"description":"User does not have permission"}},"x-permission-type":"authenticate"}},"/elasticubes/{server}/{elasticube}/datasecurity/{table}/{column}":{"get":{"tags":["elasticubes"],"operationId":"getElasticubeDataSecurityForColumn","summary":"Return data security rules for column.","description":"Returns ElastiCube data security rules for a column in a table in the ElastiCube.","parameters":[{"in":"path","description":"The ElastiCube's server address.","name":"server","required":true,"type":"string"},{"in":"path","description":"The name of the ElastiCube","name":"elasticube","required":true,"type":"string"},{"in":"path","description":"The name of the table in the ElastiCube","name":"table","required":true,"type":"string"},{"in":"path","description":"The name of the column in the table","name":"column","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":"No response was specified"},"400":{"description":"invalid elasticube identifier"},"403":{"description":"User does not have permission"}},"x-permission-type":"authenticate"}},"/elasticubes/{server}/{elasticube}/listColumnsOidsIncludeDataSecurity":{"get":{"tags":["elasticubes"],"operationId":"getListColumnOidsIncludedInDataContextForElasticube","summary":"Returns tables and columns security rules for an elasticube","description":"Returns tables and columns security rules for an elasticube","parameters":[{"in":"path","description":"The ElastiCube's server address.","name":"server","required":true,"type":"string"},{"in":"path","description":"The name of the ElastiCube.","name":"elasticube","required":true,"type":"string"},{"in":"query","description":"is Live cube","name":"isLive","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"},{"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":"No response was specified"},"400":{"description":"invalid elastiCube identifier"},"403":{"description":"User does not have permission"}},"x-permission-type":"authenticate"}},"/elasticubes/datasecurity":{"post":{"tags":["elasticubes"],"operationId":"addElasticubeDataSecurity","summary":"Add new data context","description":"Add new data context","parameters":[{"in":"body","description":"The array of data security rules that should be added.\n<b>server and elasticube</b> are required\n\n<br /><b>exclusionary</b> - This boolean determines if a data security rule is exclusionary or inclusionary. By default, this value is <b>false</b>, which means all rules are inclusionary.When a rule is inclusionary, all defined members can see the relevant rows. When a rule is exclusionary, the relevant rows are hidden from all defined members.","name":"Array of DataSecurity objects description","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/elasticubeNewDataSecurityItem"}}},{"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":"No response was specified"},"403":{"description":"User does not have permission"},"404":{"description":"dataContext not found"}},"x-permission-type":"authenticate"}},"/elasticubes/datasecurity/{id}":{"put":{"tags":["elasticubes"],"operationId":"updateElasticubeDataSecurity","summary":"Update a data security rule by id","description":"Update a data security rule by id","parameters":[{"in":"path","description":"data security _id","name":"id","required":true,"type":"string"},{"in":"body","description":"The data security object that needs to be updated by the elasticube identifier\n<b>server</b> and <b>elasticube</b> are required\n\n<br /><b>exclusionary</b> - This boolean determines if a data security rule is exclusionary or inclusionary. By default, this value is <b>false</b>, which means all rules are inclusionary.When a rule is inclusionary, all defined members can see the relevant rows. When a rule is exclusionary, the relevant rows are hidden from all defined members.","name":"DataSecurity object description","required":false,"schema":{"$ref":"#/definitions/elasticubeUpdateDataSecurity"}},{"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":"No response was specified"},"400":{"description":"invalid id"},"403":{"description":"User does not have permission"},"404":{"description":"dataContext not found"}},"x-permission-type":"authenticate"}},"/geo/geoJson/{type}":{"get":{"tags":["geo"],"operationId":"geoJson","summary":"get geoJson by type","description":"get geoJson by type","parameters":[{"in":"path","description":"type of geo json (ie: world, usa)","name":"type","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":"No response was specified"},"403":{"description":"User does not have permission"},"404":{"description":"type not found"}},"x-permission-type":"authenticate"}},"/palettes":{"get":{"tags":["palettes"],"operationId":"getAllPalettes","summary":"Returns a list of available palettes in the Sisense web app.","responses":{"200":{"description":"No response was specified","schema":{"type":"array","items":{}}},"403":{"description":"User does not have permission"}},"x-permission-type":"none","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":{"tags":["palettes"],"operationId":"addPalette","summary":"Adds a new color palette.","parameters":[{"in":"body","description":"New palette to add","name":"palette","required":false,"schema":{"$ref":"#/definitions/palette"}},{"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":"No response was specified"},"403":{"description":"User does not have permission"}},"x-permission-type":"authenticate"}},"/palettes/default":{"get":{"tags":["palettes"],"operationId":"getDefaultPalette","summary":"Returns the default color palette.","responses":{"200":{"description":"No response was specified","schema":{"$ref":"#/definitions/palette"}},"403":{"description":"User does not have permission"}},"x-permission-type":"none","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"}]}},"/palettes/{name}":{"put":{"tags":["palettes"],"operationId":"updatePalette","summary":"Updates the dashboard's color palette.","parameters":[{"in":"path","description":"Palette's name","name":"name","required":true,"type":"string"},{"in":"body","description":"The updated palette settings to add","name":"palette","required":false,"schema":{"$ref":"#/definitions/palette"}},{"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":"No response was specified"},"403":{"description":"User does not have permission"}},"x-permission-type":"authenticate"},"delete":{"tags":["palettes"],"operationId":"removePalette","summary":"Deletes a color palette from the color palettes.","parameters":[{"in":"path","description":"Palette's 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"}],"responses":{"200":{"description":"No response was specified"},"403":{"description":"User does not have permission"}},"x-permission-type":"authenticate"}},"/shares/dashboard/{id}":{"get":{"tags":["shares"],"operationId":"getDashboardShare","summary":"get share dashboard","description":"get share dashboard","parameters":[{"in":"path","description":"dashboard's oid","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"},{"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":"No response was specified","schema":{"$ref":"#/definitions/share"}},"400":{"description":"invalid input"},"403":{"description":"User does not have permission"},"404":{"description":"id not found"}},"x-permission-type":"authenticate"},"post":{"tags":["shares"],"operationId":"shareDashboard","summary":"share dashboard","description":"share dashboard","parameters":[{"in":"path","description":"dashboard's oid","name":"id","required":true,"type":"string"},{"in":"query","description":"Actions to execute with dashboard. Pass multiple values as action=share&action=publish","name":"action","required":false,"type":"array","items":{"type":"string","enum":["share","publish"]}},{"in":"body","description":"share object that will define the share","name":"share","required":true,"schema":{"$ref":"#/definitions/share"}},{"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":"No response was specified","schema":{"$ref":"#/definitions/shareResult"}},"400":{"description":"invalid input"},"403":{"description":"User does not have permission"},"404":{"description":"id not found"}},"x-permission-type":"authenticate"}},"/shares/dashboard/{id}/subscription":{"get":{"tags":["shares"],"operationId":"getUserDashboardSubscription","summary":"get user dashboard subscription","description":"get user dashboard subscription","parameters":[{"in":"path","description":"dashboard's oid","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"},{"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":"No response was specified","schema":{"$ref":"#/definitions/sharesSubscription"}},"400":{"description":"invalid input"},"403":{"description":"User does not have permission"},"404":{"description":"id not found"}},"x-hide":false,"x-permission-type":"authenticate"},"post":{"tags":["shares"],"operationId":"updateUserDashboardSubscription","summary":"update user dashboard subscription","description":"update user dashboard subscription","parameters":[{"in":"path","description":"dashboard's oid","name":"id","required":true,"type":"string"},{"in":"body","description":"subscription object","name":"sharesSubscription","required":false,"schema":{"$ref":"#/definitions/sharesSubscription"}},{"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":"No response was specified"},"400":{"description":"invalid input"},"403":{"description":"User does not have permission"},"404":{"description":"id not found"}},"x-hide":false,"x-permission-type":"authenticate"}}},"definitions":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"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"}}}}},"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"}}}}},"apiSettings":{"type":"object","properties":{"_id":{"type":"string"},"apiKey":{"type":"string"}}},"apiSetting":{"type":"object","properties":{"apiKey":{"type":"string"}}},"branding":{"type":"object","properties":{"activationSubtitle":{"type":"string"},"activationTitle":{"type":"string"},"contactUsText":{"type":"string"},"copyrightText":{"type":"string"},"documentationUrl":{"type":"string"},"emails":{"type":"object","properties":{"createdUserSubject":{"type":"string"},"newUserInviteSubject":{"type":"string"},"passwordRecoverySubject":{"type":"string"},"senderEmail":{"type":"string"},"senderName":{"type":"string"},"shareWithExistingUserSubject":{"type":"string"},"shareWithNewUserSubject":{"type":"string"},"templates_directory":{"type":"string"},"transferOwnership":{"type":"string"},"twoFactorAuthSubject":{"type":"string"},"emailLogo":{"type":"string"}}},"favicon":{"type":"string"},"forumUrl":{"type":"string"},"homePage":{"type":"string"},"homePageConfig":{"type":"object","properties":{"documentationLink":{"type":"string"},"hideSearchInNavver":{"type":"boolean","default":true},"marketingPart":{"type":"string"},"hideMarketingBanner":{"type":"boolean","default":false},"tutorialsLink":{"type":"string"}}},"loginSubtitle":{"type":"string"},"loginTitle":{"type":"string"},"logo":{"type":"object","properties":{"desktop":{"type":"object","properties":{"large":{"type":"string"},"small":{"type":"string"},"icon":{"type":"string"}}},"phone":{"type":"object","properties":{"large":{"type":"string"},"small":{"type":"string"},"icon":{"type":"string"}}},"tablet":{"type":"object","properties":{"large":{"type":"string"},"small":{"type":"string"},"icon":{"type":"string"}}}}},"pageTitle":{"type":"string"},"poweredBySisense":{"type":"boolean","default":true},"enabled":{"type":"boolean","default":true},"widgetsPoweredBySisense":{"type":"boolean"}}},"logoPlatform":{"type":"object","properties":{"large":{"type":"string"},"small":{"type":"string"},"icon":{"type":"string"}}},"brandEmails":{"type":"object","properties":{"createdUserSubject":{"type":"string"},"newUserInviteSubject":{"type":"string"},"passwordRecoverySubject":{"type":"string"},"senderEmail":{"type":"string"},"senderName":{"type":"string"},"shareWithExistingUserSubject":{"type":"string"},"shareWithNewUserSubject":{"type":"string"},"templates_directory":{"type":"string"},"transferOwnership":{"type":"string"},"twoFactorAuthSubject":{"type":"string"},"emailLogo":{"type":"string"}}},"homePageConfig":{"type":"object","properties":{"documentationLink":{"type":"string"},"hideSearchInNavver":{"type":"boolean","default":true},"marketingPart":{"type":"string"},"hideMarketingBanner":{"type":"boolean","default":false},"tutorialsLink":{"type":"string"}}},"logo":{"type":"object","properties":{"desktop":{"type":"object","properties":{"large":{"type":"string"},"small":{"type":"string"},"icon":{"type":"string"}}},"phone":{"type":"object","properties":{"large":{"type":"string"},"small":{"type":"string"},"icon":{"type":"string"}}},"tablet":{"type":"object","properties":{"large":{"type":"string"},"small":{"type":"string"},"icon":{"type":"string"}}}}},"globalizationSettings":{"type":"object","properties":{"name":{"type":"string","description":"Name of configuration.","default":"globalization"},"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."}}}}},"proxySettings":{"type":"object","properties":{"enabled":{"type":"boolean"},"ip":{"type":"string"},"port":{"type":"number"},"username":{"type":"string"},"password":{"type":"string"}}},"securitySettings":{"type":"object","properties":{"name":{"type":"string"},"allowAddServers":{"type":"boolean"},"secret":{"type":"string"}}},"securitySchema":{"type":"object","properties":{"defaultTimeout":{"type":"number","minimum":0,"maximum":86400},"authenticationMode":{"type":"string","enum":["client","server"]},"applyDataSecurityOnFilters":{"type":"boolean"},"redirectToAnyUrl":{"type":"boolean"},"adminsTimeout":{"type":"number","minimum":0,"maximum":86400},"sameSite":{"type":"string","enum":["Default","None","Lax","Strict"]},"sessionOnlyCookie":{"type":"boolean"},"passwordError":{"type":"string"},"cookieExp":{"type":"number"},"embeddedDomains":{"type":"array","items":{"type":"string"}},"chipsEnabled":{"type":"boolean"},"targetDomains":{"type":"array","items":{"type":"string"}},"applyDataSecurityOnFiltersRelations":{"type":"boolean"},"hideListOfAllowedEmbeddedDomains":{"type":"boolean"},"forceSecureCookies":{"type":"boolean"},"dataSecurityDefaultGroupStrict":{"type":"boolean"},"secret":{"type":"string"},"passwordRegex":{"type":"string"},"csrf":{"type":"object","properties":{"enabled":{"type":"boolean"}}}}},"ssoSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If SSO is enabled."},"ssoType":{"type":"string","description":"Type of SSO.","default":"jwt"},"loginUrl":{"type":"string","description":"This is the URL that Sisense will invoke to attempt remote authentication."},"logoutUrl":{"type":"string","description":"This is the URL that Sisense will return users to after they log out."},"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}}},"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."},"email":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If mails are enabled."},"senderEmail":{"type":"string","description":"Email of sender."},"senderName":{"type":"string","description":"Name of sender."}}},"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."}}},"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"}}}}}}}},"SchemaEtlPayload":{"type":"object","properties":{"customTables":{"type":"array","items":{"$ref":"#/definitions/CustomTable"}},"customColumns":{"type":"array","items":{"$ref":"#/definitions/CustomColumn"}},"monetDbSchema":{"$ref":"#/definitions/MonetDbSchema"}}},"CustomTable":{"type":"object","properties":{"tableName":{"type":"string"},"tableGeneratingQuery":{"type":"string"}}},"CustomColumn":{"type":"object","properties":{"tableName":{"type":"string"},"columnName":{"type":"string"},"columnGeneratingExpression":{"type":"string"}}},"MonetDbSchema":{"type":"object","properties":{"schemaId":{"type":"string"},"schemaName":{"type":"string"},"schemaPhysicalName":{"type":"string"},"tables":{"type":"array","items":{"$ref":"#/definitions/MonetDataTable"}},"relationships":{"type":"array","items":{"$ref":"#/definitions/MonetRelationship"}},"dimensionTables":{"type":"array","items":{"$ref":"#/definitions/MonetDimensionTable"}}}},"MonetDataTable":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/definitions/MonetDataColumn"}},"tablePhysicalName":{"type":"string"},"tableName":{"type":"string"},"isGeneratedTable":{"type":"boolean"}}},"MonetRelationship":{"type":"object","properties":{"relationshipId":{"type":"string"},"columnRefs":{"type":"array","items":{"$ref":"#/definitions/ColumnRefImp"}},"logicalColumnType":{"type":"string"}}},"MonetDimensionTable":{"type":"object","properties":{"tablePhysicalName":{"type":"string"},"monetColumnType":{"type":"string"}}},"MonetDataColumn":{"type":"object","properties":{"columnName":{"type":"string"},"monetColumnType":{"type":"string"},"logicalColumnType":{"type":"string"},"indexed":{"type":"boolean"},"columnPhysicalName":{"type":"string"},"isGeneratedColumn":{"type":"boolean"},"properties":{"type":"object","additionalProperties":{"type":"string"}}}},"ColumnRefImp":{"type":"object","properties":{"columnName":{"type":"string"},"tableName":{"type":"string"}}},"CustomTablePayload":{"type":"object","properties":{"tableName":{"type":"string"},"customTableQuery":{"type":"string"},"monetDbSchema":{"$ref":"#/definitions/MonetDbSchema"}}},"CustomColumnPayload":{"type":"object","properties":{"columnName":{"type":"string"},"tableName":{"type":"string"},"customColumnExpression":{"type":"string"},"monetDbSchema":{"$ref":"#/definitions/MonetDbSchema"}}},"AutoCompletionPayload":{"type":"object","properties":{"expression":{"type":"string"},"monetDbSchema":{"$ref":"#/definitions/MonetDbSchema"},"row":{"format":"int32","type":"integer"},"column":{"format":"int32","type":"integer"}}},"ContextElement":{"type":"object","properties":{"type":{"enum":["Columns","Tables"],"type":"string"},"value":{"type":"string"}}},"isAuth":{"type":"object","properties":{"isAuthenticated":{"type":"boolean"}}},"pref":{"type":"object","properties":{"localeId":{"type":"string"},"language":{"type":"string"}}},"user":{"type":"object","properties":{"userName":{"type":"string"},"roleId":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"groups":{"type":"array","items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"}},"preferences":{"type":"object","properties":{"localeId":{"type":"string"},"language":{"type":"string"}}},"password":{"type":"string"}}},"userCount":{"type":"object","properties":{"collection":{"type":"string"},"count":{"type":"integer"}}},"userResponse":{"type":"object","properties":{"_id":{"type":"string"},"active":{"type":"boolean"},"activeDirectory":{"type":"boolean"},"adgroups":{"type":"array","items":{"type":"object"}},"baseRoleName":{"type":"string"},"changePasswordState":{"type":"boolean"},"created":{"type":"string","format":"date-time"},"createdSso":{"type":"string"},"dn":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"groups":{"type":"array","items":{"type":"string"}},"hash":{"type":"string"},"lastLogin":{"type":"string","format":"date-time"},"lastName":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"},"ldapDomainId":{"type":"string"},"pendingExpiration":{"type":"string","format":"date-time"},"preferences":{"type":"object","properties":{"localeId":{"type":"string"},"language":{"type":"string"}}},"principalName":{"type":"string"},"roleId":{"type":"string"},"roleName":{"type":"string"},"uSNChanged":{"type":"string"},"userName":{"type":"string"}}},"ADuserSearchResponse":{"type":"object","required":["ldapDomainId"],"properties":{"adgroups":{"type":"array","items":{"type":"object"}},"userName":{"type":"string"},"ldapDomainId":{"type":"string"},"roleId":{"type":"string"},"dn":{"type":"string"},"sn":{"type":"string"},"givenName":{"type":"string"},"mail":{"type":"string"},"sAMAccountName":{"type":"string"},"userPrincipalName":{"type":"string"}}},"leftLicenses":{"type":"object","properties":{"admins":{"type":"integer"},"consumers":{"type":"integer"},"contributors":{"type":"integer"}}},"userEmail":{"type":"object","properties":{"email":{"type":"string"}}},"userExist":{"type":"object","properties":{"email":{"type":"string"},"isExist":{"type":"boolean"},"roleId":{"type":"string"}}},"simulateAdd":{"type":"object","properties":{"license":{"type":"object","properties":{"admins":{"type":"integer"},"consumers":{"type":"integer"},"contributors":{"type":"integer"}}},"users":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string"},"isExist":{"type":"boolean"},"roleId":{"type":"string"}}}}}},"userListIds":{"type":"object","properties":{"idsList":{"type":"array","items":{"type":"string"}}}},"userActivate":{"type":"object","properties":{"password":{"type":"string"},"preferences":{"type":"object","properties":{"localeId":{"type":"string"},"language":{"type":"string"}}}}},"resendInvite":{"type":"object","properties":{"accepted":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"}}}},"rejected":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"reason":{"type":"string"}}}}}},"acceptedResendInvite":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"}}},"rejectedResendInvite":{"type":"object","properties":{"id":{"type":"string"},"reason":{"type":"string"}}},"group":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"created":{"type":"string","format":"date-time"},"mail":{"type":"string"},"roleId":{"type":"string","pattern":"(^[0-9a-fA-F]{24}$|^[Nn][Uu][Ll]{2}$)"},"baseRoleName":{"type":"string"},"cn/name":{"type":"string"},"dn":{"type":"string"},"member":{"type":"array","items":{"type":"string"}},"uSNChanged":{"type":"string"},"objectSid":{"type":"string","pattern":"^\\[\\d{1,3}(?:,\\d{1,3}){27}\\]$"},"lastUpdated":{"type":"string","format":"date-time"},"defaultRole":{"type":"string"},"language":{"type":"string"},"excludeFromSharing":{"type":"boolean","default":false},"timeout":{"type":["string","number","null"]}}},"validateName":{"type":"object","properties":{"name":{"type":"string"},"tenantId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"parentId":{"type":"string"},"title":{"type":"string"}}},"regularGroup":{"type":"object","properties":{"_id":{"type":"string"},"tenantId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"name":{"type":"string"},"excludeFromSharing":{"type":"boolean","default":false},"created":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"}}},"deleteGroup":{"type":"object","properties":{"groups":{"type":"array","items":{"type":"string"}},"deleteAdUsers":{"type":"boolean"}}},"ADgroup":{"type":"object","properties":{"_id":{"type":"string"},"objectSid":{"type":"string","pattern":"^\\[\\d{1,3}((?:,\\d{1,3}){27}|(?:,\\d{1,3}){15})\\]$"},"cn/name":{"type":"string"},"dn":{"type":"string"},"name":{"type":"string"},"uSNChanged":{"type":"string"},"mail":{"type":"string"},"roleId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"created":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"}}},"groupCount":{"type":"object","properties":{"collection":{"type":"string"},"count":{"type":"integer"}}},"dashboardFilters":{"properties":{"advanced":{"type":"boolean"},"create":{"type":"boolean"},"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_auto_update":{"type":"boolean"},"toggle_expansion":{"type":"boolean"},"modify_filter_relationship":{"type":"boolean"}}},"widgetFilters":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"widgetItems":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"reorder":{"type":"boolean"}}},"dashboardsManifest":{"properties":{"create":{"type":"boolean"},"duplicate":{"type":"boolean"},"edit_script":{"type":"boolean"},"export_dash":{"type":"boolean"},"export_image":{"type":"boolean"},"export_pdf":{"type":"boolean"},"filters":{"properties":{"advanced":{"type":"boolean"},"create":{"type":"boolean"},"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_auto_update":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"import":{"type":"boolean"},"rename":{"type":"boolean"},"restore":{"type":"boolean"},"select_palette":{"type":"boolean"},"toggle_edit_mode":{"type":"boolean"}}},"role":{"type":"object","properties":{"baseRoleName":{"type":"string"},"desc":{"type":"string"},"manifest":{"properties":{"dashboards":{"properties":{"create":{"type":"boolean"},"duplicate":{"type":"boolean"},"edit_script":{"type":"boolean"},"export_dash":{"type":"boolean"},"export_image":{"type":"boolean"},"export_pdf":{"type":"boolean"},"filters":{"properties":{"advanced":{"type":"boolean"},"create":{"type":"boolean"},"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_auto_update":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"import":{"type":"boolean"},"rename":{"type":"boolean"},"restore":{"type":"boolean"},"select_palette":{"type":"boolean"},"toggle_edit_mode":{"type":"boolean"}}},"widgets":{"properties":{"change_type":{"type":"boolean"},"create":{"type":"boolean"},"delete":{"type":"boolean"},"drill_to_anywhere":{"type":"boolean"},"duplicate":{"type":"boolean"},"edit_script":{"type":"boolean"},"export_csv":{"type":"boolean"},"export_png":{"type":"boolean"},"filters":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"items":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"reorder":{"type":"boolean"}}},"modify_selection_mode":{"type":"boolean"},"rename":{"type":"boolean"}}}}},"name":{"type":"string"},"parent":{"type":"string"}}},"roleManifest":{"properties":{"dashboards":{"properties":{"create":{"type":"boolean"},"duplicate":{"type":"boolean"},"edit_script":{"type":"boolean"},"export_dash":{"type":"boolean"},"export_image":{"type":"boolean"},"export_pdf":{"type":"boolean"},"filters":{"properties":{"advanced":{"type":"boolean"},"create":{"type":"boolean"},"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_auto_update":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"import":{"type":"boolean"},"rename":{"type":"boolean"},"restore":{"type":"boolean"},"select_palette":{"type":"boolean"},"toggle_edit_mode":{"type":"boolean"}}},"widgets":{"properties":{"change_type":{"type":"boolean"},"create":{"type":"boolean"},"delete":{"type":"boolean"},"drill_to_anywhere":{"type":"boolean"},"duplicate":{"type":"boolean"},"edit_script":{"type":"boolean"},"export_csv":{"type":"boolean"},"export_png":{"type":"boolean"},"filters":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"items":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"reorder":{"type":"boolean"}}},"modify_selection_mode":{"type":"boolean"},"rename":{"type":"boolean"}}}}},"widgetsManifest":{"properties":{"change_type":{"type":"boolean"},"create":{"type":"boolean"},"delete":{"type":"boolean"},"drill_to_anywhere":{"type":"boolean"},"duplicate":{"type":"boolean"},"edit_script":{"type":"boolean"},"export_csv":{"type":"boolean"},"export_png":{"type":"boolean"},"filters":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"toggle_expansion":{"type":"boolean"}}},"items":{"properties":{"modify_type":{"type":"boolean"},"on_off":{"type":"boolean"},"reorder":{"type":"boolean"}}},"modify_selection_mode":{"type":"boolean"},"rename":{"type":"boolean"}}},"Jaql":{},"acl":{"properties":{"party":{"type":"string"},"permission":{"type":"string"},"type":{"type":"string"}}},"activity":{"properties":{"action":{"type":"string"},"device":{"type":"string"},"resourceId":{"type":"string"}}},"attachDetachConfig":{"properties":{"dataDirectory":{"type":"string"},"deleteOnDetach":{"type":"boolean"},"sync":{"type":"boolean"}}},"dashboard":{"properties":{"_id":{"type":"string"},"created":{"type":"string","format":"date-time"},"desc":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"},"lastUsed":{"type":"string","format":"date-time"},"layout":{"type":"string"},"oid":{"type":"string"},"owner":{"type":"string"},"parentFolder":{"type":"string"},"shares":{"type":"array","items":{"$ref":"#/definitions/sharesToObject"}},"source":{"type":"string"},"style":{"type":"string"},"tags":{"type":"array","items":{"type":"object","properties":{"tagId":{"type":"string"}}}},"tenantId":{"type":"string"},"type":{"type":"string"},"usageCount":{"type":"integer","format":"int32"},"userId":{"type":"string"}}},"elasticubeAuth":{"properties":{"server":{"type":"string"},"shares":{"type":"array","items":{"$ref":"#/definitions/acl"}},"title":{"type":"string"}}},"elasticubeDataSecurityParty":{"properties":{"party":{"type":"string"},"type":{"type":"string"}}},"elasticubeNewDataSecurityItem":{"properties":{"allMembers":{"type":"boolean"},"column":{"type":"string"},"datatype":{"type":"string"},"elasticube":{"type":"string"},"exclusionary":{"type":"boolean"},"members":{"type":"array","items":{"type":"string"}},"server":{"type":"string"},"shares":{"type":"array","items":{"$ref":"#/definitions/elasticubeDataSecurityParty"}},"table":{"type":"string"}}},"elasticubeNewDataSecurityItemCubeGiven":{"properties":{"allMembers":{"type":"boolean"},"column":{"type":"string"},"datatype":{"type":"string"},"exclusionary":{"type":"boolean"},"members":{"type":"array","items":{"type":"string"}},"shares":{"type":"array","items":{"$ref":"#/definitions/elasticubeDataSecurityParty"}},"table":{"type":"string"}}},"elasticubeServer":{"properties":{"address":{"type":"string"},"defaultCubePermissions":{"type":"array","items":{"$ref":"#/definitions/acl"}}}},"elasticubeUpdateDataSecurity":{"properties":{"allMembers":{"type":"boolean"},"column":{"type":"string"},"datatype":{"type":"string"},"exclusionary":{"type":"boolean"},"members":{"type":"array","items":{"type":"string"}},"shares":{"type":"array","items":{"$ref":"#/definitions/elasticubeDataSecurityParty"}},"table":{"type":"string"}}},"folderV0.9":{"required":["type"],"properties":{"_id":{"type":"string"},"created":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"name":{"type":"string"},"parentId":{"type":"string"},"shares":{"type":"array","items":{"$ref":"#/definitions/sharesToObject"}},"type":{"type":"string"},"userId":{"type":"string"}}},"invitation":{"properties":{"ownerId":{"type":"string"},"recipientId":{"type":"string"}}},"metadata":{"properties":{"_id":{"type":"string"},"agg":{"type":"string"},"context":{"type":"integer","format":"int32"},"created":{"type":"string","format":"date-time"},"dataType":{"type":"string","format":"date-time"},"dim":{"type":"string"},"filter":{"type":"string"},"formula":{"type":"string","format":"date-time"},"oid":{"type":"string"},"title":{"type":"string"}}},"palette":{"required":["name","colors"],"properties":{"_id":{"type":"string"},"colors":{"type":"array","items":{"type":"string"}},"isDefault":{"type":"boolean"},"max":{"type":"string"},"min":{"type":"string"},"name":{"type":"string"},"sortOrder":{"type":"integer"}}},"server":{"properties":{"_id":{"type":"string"},"address":{"type":"string"},"created":{"type":"string","format":"date-time"},"defaultCubePermissions":{"type":"array","items":{"$ref":"#/definitions/acl"},"description":"defaultCubePermissions can be either an array of ACL objects OR an object of the type { 'tenantEveryone' : bool }, where 'tenantEveryone' indicates whether to grant permissions to the 'tenantEveryone' group, or to no-one"},"lastUpdated":{"type":"string","format":"date-time"},"owner":{"type":"string"}}},"share":{"required":["sharesTo"],"properties":{"allowChangeSubscription":{"type":"boolean"},"isPublic":{"type":"boolean"},"sharesTo":{"type":"array","items":{"$ref":"#/definitions/sharesToObject"}},"sharesToNew":{"type":"array","items":{"$ref":"#/definitions/sharesToNewObject"}},"subscribedGroups":{"type":"array","items":{"type":"string"}},"subscribedUsers":{"type":"array","items":{"type":"string"}},"subscription":{"$ref":"#/definitions/sharesSubscription"}}},"shareResult":{"required":["success"],"properties":{"notFoundGroups":{"type":"array","items":{"type":"string"}},"notFoundUsers":{"type":"array","items":{"type":"string"}},"success":{"type":"boolean"}}},"sharesSubscription":{"properties":{"context":{"properties":{"dashboardid":{"type":"string"}}},"emailSettings":{"properties":{"isEmail":{"type":"boolean"},"isPdf":{"type":"boolean"}}},"executionPerDay":{"type":"number"},"isDataChange":{"type":"boolean"},"reportType":{"properties":{"inline":{"type":"boolean"},"pdf":{"type":"object","required":["renderingInfo"],"properties":{"includeDS":{"type":"boolean"},"includeFilters":{"type":"boolean"},"includeTitle":{"type":"boolean"},"renderingInfo":{"type":"object","required":["paperFormat","paperOrientation"],"properties":{"layout":{"type":"string","enum":["asis","feed"]},"paperFormat":{"type":"string","enum":["A0","A1","A2","A3","A4","A5","LEGAL","LETTER","TABLOID"]},"paperOrientation":{"type":"string","enum":["portrait","landscape"]}}}}}}},"schedule":{"type":"string"},"startAt":{"type":"string"},"subscribe":{"type":"boolean"},"timezone":{"type":"number"},"type":{"type":"string","enum":["daily","monthly","onUpdate"]},"tzName":{"type":"string"}}},"sharesToNewObject":{"required":["email"],"properties":{"email":{"type":"string"},"rule":{"type":"string","enum":["view","edit"]},"subscribe":{"type":"boolean"}}},"sharesToObject":{"required":["shareId","subscription"],"properties":{"rule":{"type":"string","enum":["view","edit"]},"shareId":{"type":"string"},"subscribe":{"type":"boolean"},"type":{"type":"string","enum":["user","group"]}}},"widget":{"required":["type"],"properties":{"_id":{"type":"string"},"created":{"type":"string","format":"date-time"},"datasource":{"type":"string"},"desc":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"},"layout":{"type":"string"},"metadata":{"type":"object","properties":{"panels":{"type":"array","items":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"jaql":{"type":"object","properties":{"filter":{"type":"object","properties":{"exclude":{"type":"object","properties":{"members":{"type":"array","items":{}}}},"members":{"type":"array","items":{}}}}}}}}},"name":{"type":"string"}}}}}},"oid":{"type":"string"},"owner":{"type":"string"},"selection":{"type":"string"},"source":{"type":"string"},"subtype":{"type":"string"},"type":{"type":"string"},"userId":{"type":"string"}}}},"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](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"type":"string","pattern":"^Bearer .*"}}}