Options
All
  • Public
  • Public/Protected
  • All
Menu

@sentinel-one/management-node-sdk

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

BooleanCallback

BooleanCallback: function

Type declaration

    • (data: any): boolean

    • Parameters

      • Optional data: any

      Returns boolean

CredGroupRequest

CredGroupRequest: WindowsCredGroupRequest | OsxLinuxCredGroupRequest

SortBy

SortBy: "name" | "rank" | "siteId" | "updatedAt" | "type" | "id" | "createdAt"

UserEndPointsTypeKeys

UserEndPointsTypeKeys: keyof UserEndPointsType

deviceControlInterfaces

deviceControlInterfaces: "USB" | "Bluetooth"

dv2EventType

dv2EventType: "dns" | "process" | "ip" | "file" | "url" | "events"

scopesType

scopesType: "global" | "group" | "site"

status

status: "canceled" | "acknowledged" | "pending" | "sent"

Variables

Const AccountsEndPointsNames

AccountsEndPointsNames: AccountsEndPointsTypes = AccountsEndPointsTypes

Const ActiveDirectoryEndPointsNames

ActiveDirectoryEndPointsNames: ActiveDirectoryEndPointsTypes = ActiveDirectoryEndPointsTypes

Const ActivitiesEndPointsNames

ActivitiesEndPointsNames: ActivitiesEndPointsTypes = ActivitiesEndPointsTypes

Const AgentActionsEndPointsNames

AgentActionsEndPointsNames: AgentActionsEndPointsTypes = AgentActionsEndPointsTypes

Const AgentsEndPointsName

AgentsEndPointsName: AgentsEndPointsTypes = AgentsEndPointsTypes

Const ApplicationsRiskEndPointsNames

ApplicationsRiskEndPointsNames: applicationsRiskEndPointsTypes = applicationsRiskEndPointsTypes

Const AuthenticatorEndPointNames

AuthenticatorEndPointNames: AuthenticatorEndPointTypes = AuthenticatorEndPointTypes

Const CommandsEndpointsNames

CommandsEndpointsNames: CommandsEndpointsTypes = CommandsEndpointsTypes

Const ConfigOverrideEndPointsNames

ConfigOverrideEndPointsNames: ConfigEndPointsTypes = ConfigEndPointsTypes

Const CredGroupDetailsEndPointsNames

CredGroupDetailsEndPointsNames: credGroupDetailsEndPointsTypes = credGroupDetailsEndPointsTypes

Const CredGroupEndPointsNames

CredGroupEndPointsNames: credGroupsEndPointsTypes = credGroupsEndPointsTypes

Const DV2QueryFields

DV2QueryFields: object = ((preMappedfields, preMappedOperators) => {let fildResults = {};preMappedfields.map(elemnt => {const type = elemnt.type;const fieldId = elemnt.fieldId;const Operators = preMappedOperators[type];fildResults = { ...fildResults, [fieldId]: Operators, type };});return fildResults;})(fields, operators)

Type declaration

Const DeepVisibilityEndpointsNames

DeepVisibilityEndpointsNames: DeepVisibilityEndpointsTypes = DeepVisibilityEndpointsTypes

Const DeepVisibilityV2EndPointsNames

DeepVisibilityV2EndPointsNames: DeepVisibilityV2EndPointsTypes = DeepVisibilityV2EndPointsTypes

Const ExclusionsEndPointsNames

ExclusionsEndPointsNames: ExclusionsEndPointsTypes = ExclusionsEndPointsTypes

Const FilterEndPointsNames

FilterEndPointsNames: filterEndPointsTypes = filterEndPointsTypes

Const ForensicsEndpointsNames

ForensicsEndpointsNames: ForensicsEndpointsTypes = ForensicsEndpointsTypes

Const GroupsEndPointsNames

GroupsEndPointsNames: GroupsEndPointsTypes = GroupsEndPointsTypes

Const HashEndPointsNames

HashEndPointsNames: HashEndPointsTypes = HashEndPointsTypes

Const IocTimeOptions

IocTimeOptions: object[] = [{title: 'Last One Hour',value: 'LastOneHour'},{title: 'Last 24 Hours',value: 'Last24Hours'},{title: 'Today',value: 'Today'},{title: 'Last 48 Hours',value: 'Last48Hours'},{title: 'Last 7 Days',value: 'Last7Days'},{title: 'Last 30 Days',value: 'Last30Days'},{title: 'This Month',value: 'ThisMonth'},{title: 'Last 2 Months',value: 'Last2Months'},{title: 'Last 3 Months',value: 'Last3Months'},{title: 'Custom Range',value: 'CustomRange'}]

Const NotificationEndPointsNames

NotificationEndPointsNames: NotificationEndPointsTypes = NotificationEndPointsTypes

Const PolicyEndPointsNames

PolicyEndPointsNames: PolicyEndPointsTypes = PolicyEndPointsTypes

Const QueryError

QueryError: "Error Getting DV2 Query Request" = "Error Getting DV2 Query Request"

Const RBACEndPointsNames

RBACEndPointsNames: rbacEndPointsType = rbacEndPointsType

Const ReportsEndPointsNames

ReportsEndPointsNames: ReportsEndPointsTypes = ReportsEndPointsTypes

Const SMTPEndPointsNames

SMTPEndPointsNames: SMTPEndPointsTypes = SMTPEndPointsTypes

Const SSOEndPointsNames

SSOEndPointsNames: SSOEndPointsTypes = SSOEndPointsTypes

Const SitesEndPointsNames

SitesEndPointsNames: SitesEndPointTypes = SitesEndPointTypes

Const SyslogEndPointsNames

SyslogEndPointsNames: SyslogEndPointsTypes = SyslogEndPointsTypes

Const SystemEndPointsName

SystemEndPointsName: SystemEndPointsTypes = SystemEndPointsTypes

Const ThreatApiEndPointsNames

ThreatApiEndPointsNames: ThreatEndPointsNames = ThreatEndPointsNames

Const TimeOptions

TimeOptions: object[] = [{title: 'Recent',value: 'Recent'},{title: 'Last 24 Hours',value: 'Last24Hours'},{title: 'Today',value: 'Today'},{title: 'Last 48 Hours',value: 'Last48Hours'},{title: 'Last 7 Days',value: 'Last7Days'},{title: 'Last 30 Days',value: 'Last30Days'},{title: 'This Month',value: 'ThisMonth'},{title: 'Last 2 Months',value: 'Last2Months'},{title: 'Last 3 Months',value: 'Last3Months'},{title: 'Last Year',value: 'LastYear'},{title: 'Custom Range',value: 'CustomRange'}]

Const UpdatesEndPointsName

UpdatesEndPointsName: object = updatesEndPointsType

Type declaration

  • deletePackages: string
  • deployPackage: string
  • downloadAgentPackage: string
  • downloadPackage: string
  • latestPackages: string
  • updatePackages: string
  • uploadAgentPackage: string
  • uploadPackage: string

Const UsersEndPointsNames

UsersEndPointsNames: UserEndPointsType = UserEndPointsType

Const WDAPTEndPointEndPointsNames

WDAPTEndPointEndPointsNames: WDAPTEndPointsTypes = WDAPTEndPointsTypes

Const customDetectionRulesEndPointsNames

customDetectionRulesEndPointsNames: customDetectionRulesEndPointsTypes = customDetectionRulesEndPointsTypes

Const deviceControlEndPointsNames

deviceControlEndPointsNames: deviceControlEndPointsTypes = deviceControlEndPointsTypes

Const fields

fields: object[] = [{fieldId: Dv2fieldsTypes.AgentLastOnline,type: 'datetime'},{fieldId: Dv2fieldsTypes.FileSHA1,type: 'string'},{fieldId: Dv2fieldsTypes.FileFullName,type: 'string'},{fieldId: Dv2fieldsTypes.SrcPort,type: 'numeric'},{fieldId: Dv2fieldsTypes.FileMD5,type: 'string'},{fieldId: Dv2fieldsTypes.DNSResponse,type: 'string'},{fieldId: Dv2fieldsTypes.FileSHA256,type: 'string'},{fieldId: Dv2fieldsTypes.ProcessStartTime,type: 'datetime'},{fieldId: Dv2fieldsTypes.NetworkMethod,type: 'string'},{fieldId: Dv2fieldsTypes.PID,type: 'numeric'},{fieldId: Dv2fieldsTypes.ParentProcessPID,type: 'numeric'},{fieldId: Dv2fieldsTypes.FileCreatedAt,type: 'datetime'},{fieldId: Dv2fieldsTypes.ProcessImageSha1Hash,type: 'string'},{fieldId: Dv2fieldsTypes.AgentName,type: 'string'},{fieldId: Dv2fieldsTypes.SrcIP,type: 'string'},{fieldId: Dv2fieldsTypes.DNSRequest,type: 'string'},{fieldId: Dv2fieldsTypes.ProcessImagePath,type: 'string'},{fieldId: Dv2fieldsTypes.ProcessCmd,type: 'string'},{fieldId: Dv2fieldsTypes.AgentOS,type: 'string'},{fieldId: Dv2fieldsTypes.AgentVersion,type: 'string'},{fieldId: Dv2fieldsTypes.NetworkUrl,type: 'string'},{fieldId: Dv2fieldsTypes.ProcessGroupId,type: 'string'},{fieldId: Dv2fieldsTypes.ProcessName,type: 'string'},{fieldId: Dv2fieldsTypes.FileModifyAt,type: 'datetime'},{fieldId: Dv2fieldsTypes.DstIP,type: 'string'},{fieldId: Dv2fieldsTypes.DstPort,type: 'numeric'}]

Const fireWallControlEndPointsNames

fireWallControlEndPointsNames: fireWallControlEndPointsTypes = fireWallControlEndPointsTypes

Const tagsEndPointsNames

tagsEndPointsNames: tagsEndPointsTypes = tagsEndPointsTypes

Const url

url: "ranger/cred-groups" = "ranger/cred-groups"

Functions

Const PassedTimeError

  • PassedTimeError(passedTimePeriod: any, MAX_TIME_OUT: any): string

Const TimeOutError

  • TimeOutError(MAX_TIME_OUT: any): string

getConfigurationObjectForDebug

  • getConfigurationObjectForDebug(): object

Const getEndPoint

  • getEndPoint(entityName: string, apiName: string): any

Const getRequieredFields

  • getRequieredFields(respond: SDKRespond, requieredFieldsName: string[]): any

isFormBody

  • isFormBody(data: any): boolean

  • Parameters

    • data: any

    Returns boolean

Const readFile

  • readFile(path: string, fileName: string): Promise<string>

  • Parameters

    • path: string
    • fileName: string

    Returns Promise<string>

Const setCurentDateTime

  • setCurentDateTime(): string

Object literals

Const ConfigurationObject

ConfigurationObject: object

apiPath

apiPath: string = `web/api/v2.1`

hostName

hostName: string = "http://localhost:4200"

proxyHostName

proxyHostName: string = ""

auth

auth: object

by

by: object

apiToken

apiToken: string = ""

app

app: object

code

code: string = ""

login

login: object

password

password: string = ""

username

username: string = ""

Const SettingsEndPointsNames

SettingsEndPointsNames: object

Const accounts

accounts: object

createAccount

createAccount: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `accounts`

getAccounts

getAccounts: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `private/accounts`

getAccountsFull

getAccountsFull: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `accounts`

getAccountsPolicy

getAccountsPolicy: object

method

method: HttpMethod = HttpMethod.GET

url

  • url(account_id: string): string

Const activities

activities: object

activityType

activityType: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `activities/types`

appInventoryCount

appInventoryCount: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `application-inventory-counts`

getActivities

getActivities: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `activities`

groupedAppInventory

groupedAppInventory: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `application-inventory`

Const agentActions

agentActions: object

abortScan

abortScan: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `agents/actions/abort-scan`

approveUninstall

approveUninstall: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `agents/actions/approve-uninstall`

broadcastMessage

broadcastMessage: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `agents/actions//broadcast`

connectToNetwork

connectToNetwork: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `agents/actions/connect`

decommission

decommission: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `agents/actions/Decommission`

disconnectFromNetwork

disconnectFromNetwork: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `agents/actions/disconnect`

fetchFiels

fetchFiels: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `agents/actions/fetch-files`

fetchLogs

fetchLogs: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `agents/actions/fetch-logs`

initiateScan

initiateScan: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `agents/actions/initiate-scan`

moveAgentsToSite

moveAgentsToSite: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `agents/actions/move-to-site`

rejectUninstall

rejectUninstall: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `agents/actions/reject-uninstall`

resetLocalConfig

resetLocalConfig: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `agents/actions/reset-local-config`

restart

restart: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `agents/actions/restart-machine`

setPersistentConfigOverrides

setPersistentConfigOverrides: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `agents/actions/set-config`

shutdown

shutdown: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `agents/actions/shutdown`

uninstall

uninstall: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `agents/actions/uninstall`

updateSoftware

updateSoftware: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `agents/actions/update-software`

Const agents

agents: object

agentCountSummery

agentCountSummery: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `private/agents/summary`

countAgents

countAgents: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `agents/count`

countAgentsByFilters

countAgentsByFilters: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `private/agents/filters-count`

exportLogs

exportLogs: object

method

method: HttpMethod = HttpMethod.GET

url

  • url(agentId: string, activityId: string): string

getAgents

getAgents: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `agents`

getApplications

getApplications: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `agents/applications`

getPassphrases

getPassphrases: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `agents/passphrases`

getProcesses

getProcesses: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `agents/processes`

Const applicationsRisk

applicationsRisk: object

getApplicationCVE

getApplicationCVE: object

method

method: HttpMethod = HttpMethod.GET

url

  • url(applicationAgentId: string): string

getApplicationsList

getApplicationsList: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = "installed-applications"

getApplicationsRiskLevels

getApplicationsRiskLevels: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = "private/installed-applications/risk-levels-count"

Const authenticator

authenticator: object

authBySso

authBySso: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `users/login/sso-saml2/`

authWithApp

authWithApp: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `users/auth/app`

login

login: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `users/login`

loginByApiToken

loginByApiToken: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `users/login/by-api-token`

loginByRecoveryCode

loginByRecoveryCode: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `users/auth/recovery-code`

loginByToken

loginByToken: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `users/login/by-token`

logout

logout: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `users/logout`

Const commands

commands: object

getCommands

getCommands: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `private/commands`

Const configOverride

configOverride: object

createConfigOverRrides

createConfigOverRrides: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = "config-override"

deleteConfigOverRide

deleteConfigOverRide: object

method

method: HttpMethod = HttpMethod.DELETE

url

  • url(payloadQuery: string): string

getConfigOverRrides

getConfigOverRrides: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = "config-override"

updateConfigOverRide

updateConfigOverRide: object

method

method: HttpMethod = HttpMethod.PUT

url

  • url(payloadQuery: string): string

Const credGroupDetails

credGroupDetails: object

createCredGroupDetails

createCredGroupDetails: object

method

method: HttpMethod = HttpMethod.POST

url

url: string

deleteCredGroupDetails

deleteCredGroupDetails: object

method

method: HttpMethod = HttpMethod.DELETE

url

  • url(groupDetailsId: any): string

getCredGroupDetails

getCredGroupDetails: object

method

method: HttpMethod = HttpMethod.GET

url

url: string

Const credGroups

credGroups: object

createCredGroup

createCredGroup: object

method

method: HttpMethod = HttpMethod.POST

url

url: string

deleteCredGroup

deleteCredGroup: object

method

method: HttpMethod = HttpMethod.DELETE

url

  • url(credGroupId: any): string

getCredGroups

getCredGroups: object

method

method: HttpMethod = HttpMethod.GET

url

url: string

Const customDetectionRules

customDetectionRules: object

createRule

createRule: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = "cloud-detection/rules"

deleteRule

deleteRule: object

method

method: HttpMethod = HttpMethod.DELETE

url

url: string = "cloud-detection/rules"

getRules

getRules: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = "cloud-detection/rules?limit=100"

updateRule

updateRule: object

method

method: HttpMethod = HttpMethod.PUT

url

  • url(ruleId: any): string

Const deepVisibility

deepVisibility: object

getAgentSeenOnNetwork

getAgentSeenOnNetwork: object

method

method: HttpMethod = HttpMethod.GET

url

  • url(payloadQuery: string): string

getAgentsBreakdown

getAgentsBreakdown: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `ioc/agents`

getAgentsDrillDown

getAgentsDrillDown: object

method

method: HttpMethod = HttpMethod.GET

url

  • url(payloadQuery: string): string

getEventSeenOnNetwork

getEventSeenOnNetwork: object

method

method: HttpMethod = HttpMethod.GET

url

  • url(): string

getEvents

getEvents: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `ioc/events`

getEventsByProcess

getEventsByProcess: object

method

method: HttpMethod = HttpMethod.GET

url

  • url(payloadQuery: string): string

getEventsFiltered

getEventsFiltered: object

method

method: HttpMethod = HttpMethod.GET

url

  • url(projection: string): string

getProcessByAgent

getProcessByAgent: object

method

method: HttpMethod = HttpMethod.GET

url

  • url(payloadQuery: string): string

getProcessByUniqueKey

getProcessByUniqueKey: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `ioc/process-unique-key`

Const deepVisibilityV2

deepVisibilityV2: object

dvV2CancelRunningQuery

dvV2CancelRunningQuery: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `dv/cancel-query`

dvV2CountByType

dvV2CountByType: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `dv/count-by-type`

dvV2CreateQuery

dvV2CreateQuery: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `dv/init-query`

dvV2GetAllEvents

dvV2GetAllEvents: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `dv/events`

dvV2GetAvailableActions

dvV2GetAvailableActions: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = "dv/available-actions"

dvV2GetDistinctFieldsData

dvV2GetDistinctFieldsData: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `dv/distinct-fields-data`

dvV2GetEventTypes

dvV2GetEventTypes: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `dv/count-by-type`

dvV2GetEventsByType

dvV2GetEventsByType: object

method

method: HttpMethod = HttpMethod.GET

url

  • url(eventType: string): string

dvV2GetQueryStatus

dvV2GetQueryStatus: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `dv/query-status`

dvV2GetRecentQueries

dvV2GetRecentQueries: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `dv/queries`

Const deviceControl

deviceControl: object

copyRules

copyRules: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `device-control/copy-rules`

countByFilters

countByFilters: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `private/device-control/filters-count`

createDeviceRule

createDeviceRule: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `device-control`

deleteRules

deleteRules: object

method

method: HttpMethod = HttpMethod.DELETE

url

url: string = "device-control"

enableDisableRules

enableDisableRules: object

method

method: HttpMethod = HttpMethod.PUT

url

url: string = `device-control/enable`

exportRules

exportRules: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `device-control/export`

getConfiguration

getConfiguration: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `/device-control/configuration`

getDeviceRules

getDeviceRules: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `device-control`

getEvents

getEvents: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `device-control/events`

getInterfaces

getInterfaces: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `private/device-control/interfaces`

getUnscopedRules

getUnscopedRules: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `/private/device-control/unscoped`

importRules

importRules: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `device-control/import`

reorderRules

reorderRules: object

method

method: HttpMethod = HttpMethod.PUT

url

url: string = `device-control/reorder`

updateConfiguration

updateConfiguration: object

method

method: HttpMethod = HttpMethod.PUT

url

url: string = `/device-control/configuration`

updateDeviceRule

updateDeviceRule: object

method

method: HttpMethod = HttpMethod.PUT

url

url: string = `device-control/{rule_id}`

Const endPoints

endPoints: object

accounts

accounts: object

Type declaration

activities

activities: object

Type declaration

  • activityType: object
  • appInventoryCount: object
  • getActivities: object
  • groupedAppInventory: object

agentActions

agentActions: object

Type declaration

  • abortScan: object
  • approveUninstall: object
  • broadcastMessage: object
  • connectToNetwork: object
  • decommission: object
  • disconnectFromNetwork: object
  • fetchFiels: object
  • fetchLogs: object
  • initiateScan: object
  • moveAgentsToSite: object
  • rejectUninstall: object
  • resetLocalConfig: object
  • restart: object
  • setPersistentConfigOverrides: object
  • shutdown: object
  • uninstall: object
  • updateSoftware: object

agents

agents: object

Type declaration

applicationsRisk

applicationsRisk: object

Type declaration

authenticator

authenticator: object

Type declaration

  • authBySso: object
  • authWithApp: object
  • login: object
  • loginByApiToken: object
  • loginByRecoveryCode: object
  • loginByToken: object
  • logout: object

commands

commands: object

Type declaration

  • getCommands: object

configOverride

configOverride: object

Type declaration

credGroupDetails

credGroupDetails: object

Type declaration

credGroups

credGroups: object

Type declaration

customDetectionRules

customDetectionRules: object

Type declaration

deepVisibility

deepVisibility: object

Type declaration

deepVisibilityV2

deepVisibilityV2: object

Type declaration

  • dvV2CancelRunningQuery: object
  • dvV2CountByType: object
  • dvV2CreateQuery: object
  • dvV2GetAllEvents: object
  • dvV2GetAvailableActions: object
  • dvV2GetDistinctFieldsData: object
  • dvV2GetEventTypes: object
  • dvV2GetEventsByType: object
  • dvV2GetQueryStatus: object
  • dvV2GetRecentQueries: object

deviceControl

deviceControl: object

Type declaration

  • copyRules: object
  • countByFilters: object
  • createDeviceRule: object
  • deleteRules: object
  • enableDisableRules: object
  • exportRules: object
  • getConfiguration: object
  • getDeviceRules: object
  • getEvents: object
  • getInterfaces: object
  • getUnscopedRules: object
  • importRules: object
  • reorderRules: object
  • updateConfiguration: object
  • updateDeviceRule: object

exclusions

exclusions: object

Type declaration

  • deleteBlackItem: object
  • deleteWhiteItem: object
  • getBlackItems: object
  • getWhiteItems: object
  • setBlackItem: object
  • setWhiteItem: object
  • updateBlackItem: object
  • updateWhiteItem: object

filters

filters: object

Type declaration

fireWallControl

fireWallControl: object

Type declaration

forensics

forensics: object

Type declaration

groups

groups: object

Type declaration

hash

hash: object

Type declaration

policy

policy: object

Type declaration

rbac

rbac: object

Type declaration

reports

reports: object

Type declaration

settings

settings: object

Type declaration

  • clearPendingNotification: object
  • deleteNotificationRecipient: object
  • getADRoleString: object
  • getADSettings: object
  • getNotificationSettings: object
  • getRecipients: object
  • getSMSettings: object
  • getSMTPSettings: object
  • getSSOSettings: object
  • getSYSLOG: object
  • getSystemConfig: object
  • getWdaptSettings: object
  • setADRoleString: object
  • setADsettings: object
  • setNotificationRecipientsSettings: object
  • setNotificationSettings: object
  • setSMTPSettings: object
  • setSSOsettings: object
  • setSYSLOG: object
  • setWdaptSettings: object
  • testADSettings: object
  • testSMTPSettings: object
  • testSSOSettings: object
  • testSYSLOGSettings: object
  • testSettings: object
  • testWdaptSettings: object

sites

sites: object

Type declaration

system

system: object

Type declaration

  • getEnabledFeature: object
  • getSystemConfig: object
  • getSystemInfo: object
  • getSystemStatus: object
  • setSystemConfig: object

tags

tags: object

Type declaration

threats

threats: object

Type declaration

updates

updates: object

Type declaration

users

users: object

Type declaration

Const endPointsEntities

endPointsEntities: object

accounts

accounts: string = "accounts"

activities

activities: string = "activities"

agentActions

agentActions: string = "agentActions"

agents

agents: string = "agents"

applicationsRisk

applicationsRisk: string = "applicationsRisk"

authenticator

authenticator: string = "authenticator"

commands

commands: string = "commands"

configOverride

configOverride: string = "configOverride"

credGroupDetails

credGroupDetails: string = "credGroupDetails"

credGroups

credGroups: string = "credGroups"

customDetectionRules

customDetectionRules: string = "customDetectionRules"

deepVisibility

deepVisibility: string = "deepVisibility"

deepVisibilityV2

deepVisibilityV2: string = "deepVisibilityV2"

deviceControl

deviceControl: string = "deviceControl"

exlusions

exlusions: string = "exclusions"

filters

filters: string = "filters"

fireWallControl

fireWallControl: string = "fireWallControl"

forensics

forensics: string = "forensics"

groups

groups: string = "groups"

hash

hash: string = "hash"

policy

policy: string = "policy"

rbac

rbac: string = "rbac"

reports

reports: string = "reports"

settings

settings: string = "settings"

sites

sites: string = "sites"

system

system: string = "system"

tags

tags: string = "tags"

threats

threats: string = "threats"

updates

updates: string = "updates"

users

users: string = "users"

Const exclusions

exclusions: object

deleteBlackItem

deleteBlackItem: object

method

method: HttpMethod = HttpMethod.DELETE

url

url: string = "restrictions"

deleteWhiteItem

deleteWhiteItem: object

method

method: HttpMethod = HttpMethod.DELETE

url

url: string = "exclusions"

getBlackItems

getBlackItems: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `restrictions`

getWhiteItems

getWhiteItems: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `exclusions`

setBlackItem

setBlackItem: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = "restrictions"

setWhiteItem

setWhiteItem: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = "exclusions"

updateBlackItem

updateBlackItem: object

method

method: HttpMethod = HttpMethod.PUT

url

url: string = "restrictions"

updateWhiteItem

updateWhiteItem: object

method

method: HttpMethod = HttpMethod.PUT

url

url: string = "exclusions"

Const filters

filters: object

deleteDvFilter

deleteDvFilter: object

method

method: HttpMethod = HttpMethod.DELETE

url

  • url(payloadQuery: string): string

deleteFilter

deleteFilter: object

method

method: HttpMethod = HttpMethod.DELETE

url

  • url(payloadQuery: string): string

getDvFilter

getDvFilter: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `filters/dv`

getFilters

getFilters: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `filters`

saveDvFilter

saveDvFilter: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `filters/dv`

saveFilter

saveFilter: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `filters`

updateDvFilters

updateDvFilters: object

method

method: HttpMethod = HttpMethod.PUT

url

  • url(dvFilters: string): string

updateFilter

updateFilter: object

method

method: HttpMethod = HttpMethod.PUT

url

  • url(filter: string): string

Const fireWallControl

fireWallControl: object

copyRules

copyRules: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `firewall-control/copy-rules`

countByFilters

countByFilters: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `private/firewall-control/filters-count`

createFirewallRule

createFirewallRule: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `firewall-control`

createNetworkQuarantineRule

createNetworkQuarantineRule: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `firewall-control/network-quarantine`

createTag

createTag: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `tags`

deleteRules

deleteRules: object

method

method: HttpMethod = HttpMethod.DELETE

url

url: string = `firewall-control`

enableDisableRules

enableDisableRules: object

method

method: HttpMethod = HttpMethod.PUT

url

url: string = `firewall-control/enable`

exportRules

exportRules: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `firewall-control/export`

getConfiguration

getConfiguration: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `firewall-control/configuration`

getFirewallRules

getFirewallRules: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `firewall-control`

getProtocols

getProtocols: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `firewall-control/protocols`

getUnscopedRules

getUnscopedRules: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `private/firewall-control/unscoped`

importRules

importRules: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `firewall-control/import`

moveRules

moveRules: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `firewall-control/move-rules`

reorderRules

reorderRules: object

method

method: HttpMethod = HttpMethod.PUT

url

url: string = `firewall-control/reorder`

updateConfiguration

updateConfiguration: object

method

method: HttpMethod = HttpMethod.PUT

url

url: string = `firewall-control/configuration`

updateFirewallRule

updateFirewallRule: object

url

  • url(rulId: any): string

Const forensics

forensics: object

exportApplication

exportApplication: object

method

method: HttpMethod = HttpMethod.GET

url

  • url(payloadQuery: string): string

exportThreat

exportThreat: object

method

method: HttpMethod = HttpMethod.GET

url

getApplicationConnections

getApplicationConnections: object

method

method: HttpMethod = HttpMethod.GET

url

  • url(payloadQuery: string): string

getApplicationForensicDetails

getApplicationForensicDetails: object

method

method: HttpMethod = HttpMethod.GET

url

  • url(payloadQuery: string): string

getApplicationForensics

getApplicationForensics: object

method

method: HttpMethod = HttpMethod.GET

url

  • url(payloadQuery: string): string

getThreatConnections

getThreatConnections: object

method

method: HttpMethod = HttpMethod.GET

url

  • url(threat_id: string): string

getThreatForensicDetails

getThreatForensicDetails: object

method

method: HttpMethod = HttpMethod.GET

url

  • url(threat_id: string): string

getThreatForensics

getThreatForensics: object

method

method: HttpMethod = HttpMethod.GET

url

  • url(threat_id: string): string

getThreatSeenOnNetwork

getThreatSeenOnNetwork: object

method

method: HttpMethod = HttpMethod.GET

url

  • url(threat_id: string): string

Const groups

groups: object

countGroups

countGroups: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `private/group-count`

createGroups

createGroups: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `groups`

deleteGroups

deleteGroups: object

method

method: HttpMethod = HttpMethod.DELETE

url

  • url(payloadQuery: string): string

getDefaultGroups

getDefaultGroups: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `private/groups-default`

getGroups

getGroups: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `groups`

getGroupsById

getGroupsById: object

method

method: HttpMethod = HttpMethod.GET

url

  • url(payloadQuery: any): string

moveAgents

moveAgents: object

method

method: HttpMethod = HttpMethod.PUT

url

  • url(payloadQuery: string): string

revertGroupsPolicy

revertGroupsPolicy: object

method

method: HttpMethod = HttpMethod.PUT

url

  • url(group_id: string): string

updateGroups

updateGroups: object

method

method: HttpMethod = HttpMethod.PUT

url

  • url(payloadQuery: string): string

updateRanks

updateRanks: object

method

method: HttpMethod = HttpMethod.PUT

url

url: string = `groups/ranks`

Const hash

hash: object

getHashClassification

getHashClassification: object

method

method: HttpMethod = HttpMethod.GET

url

  • url(payloadQuery: string): string

getHashReputation

getHashReputation: object

method

method: HttpMethod = HttpMethod.GET

url

  • url(payloadQuery: string): string

Const operators

operators: object

datetime

datetime: dv2OperatorsTypes[] = [dv2OperatorsTypes.BiggerThen,dv2OperatorsTypes.BiggerOrEqualsTo,dv2OperatorsTypes.Between,dv2OperatorsTypes.SmallerFrom,dv2OperatorsTypes.SmallerOREqualsTo]

numeric

numeric: dv2OperatorsTypes[] = [dv2OperatorsTypes.EqualsTo,dv2OperatorsTypes.NotEqualsTo,dv2OperatorsTypes.BiggerThen,dv2OperatorsTypes.BiggerOrEqualsTo,dv2OperatorsTypes.SmallerOREqualsTo,dv2OperatorsTypes.SmallerFrom,dv2OperatorsTypes.Between]

string

string: dv2OperatorsTypes[] = [dv2OperatorsTypes.EqualsTo,dv2OperatorsTypes.NotEqualsTo,dv2OperatorsTypes.BiggerThen,dv2OperatorsTypes.BiggerOrEqualsTo,dv2OperatorsTypes.SmallerOREqualsTo,dv2OperatorsTypes.SmallerFrom,dv2OperatorsTypes.Between]

Const policy

policy: object

getGlobalPolicy

getGlobalPolicy: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `tenant/policy`

getGroupPolicy

getGroupPolicy: object

method

method: HttpMethod = HttpMethod.GET

url

  • url(group_id: string): string

getPolicy

getPolicy: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `private/policy`

updateGroupPolicy

updateGroupPolicy: object

method

method: HttpMethod = HttpMethod.PUT

url

  • url(group_id: any): string

updateSitePolicy

updateSitePolicy: object

method

method: HttpMethod = HttpMethod.PUT

url

  • url(site_id: any): string

updateTenantPolicy

updateTenantPolicy: object

method

method: HttpMethod = HttpMethod.PUT

url

url: string = `tenant/policy`

Const rbac

rbac: object

createRole

createRole: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `rbac/role`

deleteRole

deleteRole: object

method

method: HttpMethod = HttpMethod.DELETE

url

url: string = `rbac/role`

getRoleTemplate

getRoleTemplate: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `rbac/role`

getRoles

getRoles: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `rbac/roles`

updateRole

updateRole: object

method

method: HttpMethod = HttpMethod.PUT

url

  • url(role_id: any): string

Const reports

reports: object

createReportTasks

createReportTasks: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `report-tasks`

deleteReports

deleteReports: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `reports/delete-reports`

deleteReportsTask

deleteReportsTask: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `reports/delete-tasks`

getInsightType

getInsightType: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `reports/insights/types`

getReports

getReports: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `reports`

getReportsTask

getReportsTask: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `report-tasks`

getRssFeed

getRssFeed: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `sentinelonerss`

updateReportTask

updateReportTask: object

method

method: HttpMethod = HttpMethod.PUT

url

  • url(task_id: string): string

Const settings

settings: object

clearPendingNotification

clearPendingNotification: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = "settings/notifications/cancel-pending-emails"

deleteNotificationRecipient

deleteNotificationRecipient: object

method

method: HttpMethod = HttpMethod.DELETE

url

  • url(recipient_id: string): string

getADRoleString

getADRoleString: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = "settings/active-directory/scope-mapping"

getADSettings

getADSettings: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `settings/active-directory`

getNotificationSettings

getNotificationSettings: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `settings/notifications`

getRecipients

getRecipients: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `settings/recipients`

getSMSettings

getSMSettings: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `settings/sms`

getSMTPSettings

getSMTPSettings: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `settings/smtp`

getSSOSettings

getSSOSettings: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `settings/sso`

getSYSLOG

getSYSLOG: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `settings/syslog`

getSystemConfig

getSystemConfig: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `private/settings/system-configuration`

getWdaptSettings

getWdaptSettings: object

methode

methode: HttpMethod = HttpMethod.GET

url

url: string = "settings/microsoft"

setADRoleString

setADRoleString: object

method

method: HttpMethod = HttpMethod.PUT

url

url: string = "settings/active-directory/scope-mapping"

setADsettings

setADsettings: object

method

method: HttpMethod = HttpMethod.PUT

url

url: string = "settings/active-directory"

setNotificationRecipientsSettings

setNotificationRecipientsSettings: object

method

method: HttpMethod = HttpMethod.PUT

url

url: string = "settings/recipients"

setNotificationSettings

setNotificationSettings: object

method

method: HttpMethod = HttpMethod.PUT

url

url: string = "settings/notifications"

setSMTPSettings

setSMTPSettings: object

method

method: HttpMethod = HttpMethod.PUT

url

url: string = "settings/smtp"

setSSOsettings

setSSOsettings: object

method

method: HttpMethod = HttpMethod.PUT

url

url: string = "settings/sso"

setSYSLOG

setSYSLOG: object

method

method: HttpMethod = HttpMethod.PUT

url

url: string = `settings/syslog`

setWdaptSettings

setWdaptSettings: object

method

method: HttpMethod = HttpMethod.PUT

url

url: string = "settings/microsoft"

testADSettings

testADSettings: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = "settings/active-directory/test"

testSMTPSettings

testSMTPSettings: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = "settings/smtp/test"

testSSOSettings

testSSOSettings: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = "settings/sso/test"

testSYSLOGSettings

testSYSLOGSettings: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `settings/syslog/test`

testSettings

testSettings: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `settings/smtp/test`

testWdaptSettings

testWdaptSettings: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = "settings/microsoft/test"

Const sites

sites: object

createSite

createSite: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `sites`

createWithAdmin

createWithAdmin: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `site-with-admin`

deleteSite

deleteSite: object

method

method: HttpMethod = HttpMethod.DELETE

url

  • url(payloadQuery: string): string

expireSite

expireSite: object

method

method: HttpMethod = HttpMethod.POST

url

  • url(payloadQuery: string): string

getSiteById

getSiteById: object

method

method: HttpMethod = HttpMethod.GET

url

  • url(payloadQuery: string): string

getSitePolicy

getSitePolicy: object

method

method: HttpMethod = HttpMethod.GET

url

  • url(payloadQuery: string): string

getSites

getSites: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `sites`

reactivateSite

reactivateSite: object

method

method: HttpMethod = HttpMethod.PUT

url

  • url(payloadQuery: string): string

regenerateSiteKey

regenerateSiteKey: object

method

method: HttpMethod = HttpMethod.PUT

url

  • url(payloadQuery: string): string

revertSitePolicy

revertSitePolicy: object

method

method: HttpMethod = HttpMethod.PUT

url

  • url(payloadQuery: string): string

updateSite

updateSite: object

method

method: HttpMethod = HttpMethod.PUT

url

  • url(payloadQuery: string): string

updateSitePolicy

updateSitePolicy: object

method

method: HttpMethod = HttpMethod.PUT

url

  • url(payloadQuery: string): string

Const system

system: object

getEnabledFeature

getEnabledFeature: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `private/system/enabled-features`

getSystemConfig

getSystemConfig: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `system/configuration`

getSystemInfo

getSystemInfo: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `system/info`

getSystemStatus

getSystemStatus: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `system/status`

setSystemConfig

setSystemConfig: object

method

method: HttpMethod = HttpMethod.PUT

url

url: string = `system/configuration`

Const tags

tags: object

createTag

createTag: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `tags`

deleteTagById

deleteTagById: object

method

method: HttpMethod = HttpMethod.DELETE

url

url: string = `tags`

deleteTags

deleteTags: object

method

method: HttpMethod = HttpMethod.DELETE

url

url: string = `tags`

getTags

getTags: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `tags`

updateTag

updateTag: object

url

  • url(tagId: any): string

Const threats

threats: object

addNote

addNote: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = "threats/notes"

addToBlackList

addToBlackList: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `threats/add-to-blacklist`

countByFilters

countByFilters: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `private/threats/filters-count`

deleteNote

deleteNote: object

method

method: HttpMethod = HttpMethod.DELETE

url

  • url(threadId: string, noteId: string): string

disableEngines

disableEngines: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `threats/engines/disable`

editNote

editNote: object

method

method: HttpMethod = HttpMethod.PUT

url

  • url(threadId: string, noteId: string): string

getNotes

getNotes: object

method

method: HttpMethod = HttpMethod.GET

url

  • url(threadId: string): string

markAsBenign

markAsBenign: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `threats/mark-as-benign`

markAsResolved

markAsResolved: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `threats/mark-as-resolved`

markAsThreat

markAsThreat: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `threats/mark-as-threat`

mitigateThreats

mitigateThreats: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `threats/mitigate`

threatGroups

threatGroups: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `private/threat-groups`

threatsSummery

threatsSummery: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `private/threats/summary`

updateThreat

updateThreat: object

method

method: HttpMethod = HttpMethod.PUT

url

url: string = `threats`

Const updates

updates: object

deletePackages

deletePackages: object

method

method: HttpMethod = HttpMethod.DELETE

url

url: string = `update/agent/packages`

deployPackage

deployPackage: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `upload/software/deploy`

downloadAgentPackage

downloadAgentPackage: object

method

method: HttpMethod = HttpMethod.GET

url

  • url(package_id: string): string

downloadPackage

downloadPackage: object

method

method: HttpMethod = HttpMethod.GET

url

  • url(site_id: string, package_id: string): string

latestPackages

latestPackages: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `update/agent/packages`

updatePackages

updatePackages: object

method

method: HttpMethod = HttpMethod.PUT

url

  • url(package_id: string): string

uploadAgentPackage

uploadAgentPackage: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `upload/agent/software`

uploadPackage

uploadPackage: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `upload/software`

Const updatesEndPointsType

updatesEndPointsType: object

deletePackages

deletePackages: string = "deletePackages"

deployPackage

deployPackage: string = "deployPackage"

downloadAgentPackage

downloadAgentPackage: string = "downloadAgentPackage"

downloadPackage

downloadPackage: string = "downloadPackage"

latestPackages

latestPackages: string = "latestPackages"

updatePackages

updatePackages: string = "updatePackages"

uploadAgentPackage

uploadAgentPackage: string = "uploadAgentPackage"

uploadPackage

uploadPackage: string = "uploadPackage"

Const users

users: object

apiTokenDetails

apiTokenDetails: object

method

method: HttpMethod = HttpMethod.GET

url

  • url(userId: string): string

changePassword

changePassword: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `users/change-password`

checkTenantAdmin

checkTenantAdmin: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `users/tenant-admin-auth-check`

checkViewerAuth

checkViewerAuth: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `users/viewer-auth-check`

createUsers

createUsers: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `users`

deleteUser

deleteUser: object

method

method: HttpMethod = HttpMethod.DELETE

url

url: string = `users/`

disableToFa

disableToFa: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `users/2fa/disable`

enableTwoFa

enableTwoFa: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `users/2fa/enable`

enableTwoFaApp

enableTwoFaApp: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `users/enable-app`

enroll2fa

enroll2fa: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `users/enroll-2fa`

generateApiToken

generateApiToken: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `users/generate-api-token`

generateIframeToken

generateIframeToken: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `users/generate-iframe-token`

generateRecoveryCode

generateRecoveryCode: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `users/generate-recovery-codes`

getUserById

getUserById: object

method

method: HttpMethod = HttpMethod.GET

url

  • url(token: any): string

getUsers

getUsers: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `users`

requestTwoFaApp

requestTwoFaApp: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `/users/request-app`

resetPasswordOnNextLogin

resetPasswordOnNextLogin: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = "users/login/force-reset-password-on-login"

revokeApiToken

revokeApiToken: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `users/revoke-api-token`

singInWithEula

singInWithEula: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `users/auth/eula`

updateUser

updateUser: object

method

method: HttpMethod = HttpMethod.PUT

url

  • url(user_id: any): string

userByToken

userByToken: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `user`

userInfo

userInfo: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `private/user-info`

verifyCode

verifyCode: object

method

method: HttpMethod = HttpMethod.GET

url

url: string = `users/user-code-verification`

verifyEmail

verifyEmail: object

method

method: HttpMethod = HttpMethod.POST

url

url: string = `users/send-verification-email`

Generated using TypeDoc