category: Data Enrichment & Threat Intelligence
provider: OctoXLabs
commonfields:
  id: OctoxLabs
  version: -1
configuration:
- defaultvalue: 127.0.0.1
  display: IP
  additionalinfo: Your Octox Labs Platform IP
  name: octox_ip
  required: true
  type: 0
- displaypassword: API Key
  additionalinfo: Your Octox Labs API Key. (https://github.com/octoxlabs/py-octoxlabs#getting-started)
  name: octox_token
  required: true
  hiddenusername: true
  type: 9
- name: https_proxy
  display: HTTPS Proxy
  required: false
  type: 0
  additionalinfo: Your HTTPS Proxy URL
- name: no_verify
  required: false
  type: 8
  display: No Verify
  additionalinfo: Don't Verify SSL

description: 'Octox Labs Cyber Security Asset Management platform.'
display: 'OctoxLabs'
name: OctoxLabs
script:
  commands:
  - name: octoxlabs-get-adapters
    description: 'Fetch octoxlabs all adapters.'
    outputs:
    - contextPath: OctoxLabs.Adapters.count
      description: 'Adapters count.'
      type: Number
    - contextPath: OctoxLabs.Adapters.results.id
      description: 'Adapter id.'
      type: Number
    - contextPath: OctoxLabs.Adapters.results.name
      description: 'Adapter name.'
      type: String
    - contextPath: OctoxLabs.Adapters.results.slug
      description: 'Adapter slug.'
      type: String
    - contextPath: OctoxLabs.Adapters.results.description
      description: 'Adapter description.'
      type: String
    - contextPath: OctoxLabs.Adapters.results.groups
      description: 'List<string> Adapter groups.'
      type: Unknown
    - contextPath: OctoxLabs.Adapters.results.beta
      description: 'Adapter is beta?.'
      type: Boolean
    - contextPath: OctoxLabs.Adapters.results.status
      description: 'Adapter status.'
      type: Number
    - contextPath: OctoxLabs.Adapters.results.hr_status
      description: 'Adapter human readable status.'
      type: String
  - name: octoxlabs-get-connections
    description: 'Fetch octoxlabs connections.'
    arguments:
    - default: true
      description: 'Page number.'
      name: page
    outputs:
    - contextPath: OctoxLabs.Connections.count
      description: 'Connections count.'
      type: Number
    - contextPath: OctoxLabs.Connections.results.id
      description: 'Connection id.'
      type: Number
    - contextPath: OctoxLabs.Connections.results.adapter_id
      description: 'Connection adapter id.'
      type: Number
    - contextPath: OctoxLabs.Connections.results.adapter_name
      description: 'Connection adapter name.'
      type: String
    - contextPath: OctoxLabs.Connections.results.name
      description: 'Connection name.'
      type: String
    - contextPath: OctoxLabs.Connections.results.status
      description: 'Connection status.'
      type: Boolean
    - contextPath: OctoxLabs.Connections.results.description
      description: 'Connection description.'
      type: String
    - contextPath: OctoxLabs.Connections.results.enabled
      description: 'Connection is enabled?.'
      type: Boolean
  - name: octoxlabs-get-discoveries
    description: 'Fetch octoxlabs discoveries.'
    arguments:
    - default: true
      description: 'Page number.'
      name: page
    outputs:
    - contextPath: OctoxLabs.Discoveries.count
      description: 'Total discovery count.'
      type: Number
    - contextPath: OctoxLabs.Discoveries.results.id
      description: 'Discovery id.'
      type: Number
    - contextPath: OctoxLabs.Discoveries.results.start_time
      description: 'Discovery start time.'
      type: String
    - contextPath: OctoxLabs.Discoveries.results.end_time
      description: 'Discovery end time.'
      type: String
    - contextPath: OctoxLabs.Discoveries.results.status
      description: 'Discovery status.'
      type: Number
    - contextPath: OctoxLabs.Discoveries.results.hr_status
      description: 'Discovery human readable status.'
      type: String
    - contextPath: OctoxLabs.Discoveries.results.progress
      description: 'Discovery progress.'
      type: Number
  - name: octoxlabs-get-last-discovery
    description: 'Get last success discovery.'
    outputs:
    - contextPath: OctoxLabs.Discovery.id
      description: 'Last discovery id.'
      type: Number
    - contextPath: OctoxLabs.Discovery.start_time
      description: 'Last discovery start time.'
      type: String
    - contextPath: OctoxLabs.Discovery.end_time
      description: 'Last discovery end time.'
      type: String
    - contextPath: OctoxLabs.Discovery.status
      description: 'Last discovery status.'
      type: Number
    - contextPath: OctoxLabs.Discovery.hr_status
      description: 'Last discovery human readable status.'
      type: String
    - contextPath: OctoxLabs.Discovery.progress
      description: 'Last discovery progress.'
      type: Number
  - name: octoxlabs-search-devices
    description: 'Search in your devices.'
    arguments:
    - default:
      description: 'Query.'
      name: query
    - default:
      description: 'Fields.'
      isArray: true
      name: fields
    - default:
      description: 'Page.'
      name: page
    - default:
      description: 'Size.'
      name: size
    - default:
      description: 'Specific Discovery Id.'
      name: discovery_id
    outputs:
    - contextPath: OctoxLabs.Devices.count
      description: 'Total devices count.'
      type: Number
    - contextPath: OctoxLabs.Devices.results
      description: 'List<Dict> Device information.'
      type: Unknown
  - name: octoxlabs-get-device
    description: 'Fetch your device.'
    arguments:
    - required: true
      name: hostname
      description: 'Your device hostname.'
    - name: discovery_id
      description: 'Your device at specific discovery.'
    outputs:
    - contextPath: OctoxLabs.Device
      description: '<Dict> Octoxlabs Device.'
      type: Unknown
  - name: octoxlabs-get-queries
    description: 'Fetch your queries.'
    arguments:
    - default:
      name: page
      description: 'Query list page.'
    - default:
      name: search
      description: 'Search text.'
    - default:
      name: size
      description: 'Query list size.'
    outputs:
    - contextPath: OctoxLabs.Queries.count
      description: 'Queries count.'
      type: Number
    - contextPath: OctoxLabs.Queries.results.id
      description: 'Query id.'
      type: Number
    - contextPath: OctoxLabs.Queries.results.name
      description: 'Query name.'
      type: String
    - contextPath: OctoxLabs.Queries.results.text
      description: 'Query text.'
      type: String
    - contextPath: OctoxLabs.Queries.results.tags
      description: 'List<str> Query tags.'
      type: Unknown
    - contextPath: OctoxLabs.Queries.results.count
      description: 'Query device count.'
      type: Number
    - contextPath: OctoxLabs.Queries.results.is_public
      description: 'Query is public?.'
      type: Boolean
    - contextPath: OctoxLabs.Queries.results.created_at
      description: 'Query created at.'
      type: String
    - contextPath: OctoxLabs.Queries.results.updated_at
      description: 'Query updated at.'
      type: String
    - contextPath: OctoxLabs.Queries.results.username
      description: 'Query creator.'
      type: String
    - contextPath: OctoxLabs.Queries.results.is_temporary
      description: "Query is temporary."
      type: Boolean
  - name: octoxlabs-get-query-by-id
    description: 'Fetch your queries by id.'
    arguments:
    - required: true
      name: query_id
      description: 'Query id.'
    outputs:
    - contextPath: OctoxLabs.Queries.results.id
      description: 'Query id.'
      type: Number
    - contextPath: OctoxLabs.Queries.results.name
      description: 'Query name.'
      type: String
    - contextPath: OctoxLabs.Queries.results.text
      description: 'Query text.'
      type: String
    - contextPath: OctoxLabs.Queries.results.tags
      description: 'List<str> Query tags.'
      type: Unknown
    - contextPath: OctoxLabs.Queries.results.count
      description: 'Query device count.'
      type: Number
    - contextPath: OctoxLabs.Queries.results.is_public
      description: 'Query is public?.'
      type: Boolean
    - contextPath: OctoxLabs.Queries.results.created_at
      description: 'Query created at.'
      type: String
    - contextPath: OctoxLabs.Queries.results.updated_at
      description: 'Query updated at.'
      type: String
    - contextPath: OctoxLabs.Queries.results.username
      description: 'Query creator.'
      type: String
    - contextPath: OctoxLabs.Queries.results.is_temporary
      description: "Query is temporary."
      type: Boolean
  - name: octoxlabs-get-query-by-name
    description: 'Fetch your queries by id.'
    arguments:
    - required: true
      name: query_name
      description: 'Query name.'
    outputs:
    - contextPath: OctoxLabs.Queries.results.id
      description: 'Query id.'
      type: Number
    - contextPath: OctoxLabs.Queries.results.name
      description: 'Query name.'
      type: String
    - contextPath: OctoxLabs.Queries.results.text
      description: 'Query text.'
      type: String
    - contextPath: OctoxLabs.Queries.results.tags
      description: 'List<str> Query tags.'
      type: Unknown
    - contextPath: OctoxLabs.Queries.results.count
      description: 'Query device count.'
      type: Number
    - contextPath: OctoxLabs.Queries.results.is_public
      description: 'Query is public?.'
      type: Boolean
    - contextPath: OctoxLabs.Queries.results.created_at
      description: 'Query created at.'
      type: String
    - contextPath: OctoxLabs.Queries.results.updated_at
      description: 'Query updated at.'
      type: String
    - contextPath: OctoxLabs.Queries.results.username
      description: 'Query creator.'
      type: String
    - contextPath: OctoxLabs.Queries.results.is_temporary
      description: "Query is temporary."
      type: Boolean
  - name: octoxlabs-get-companies
    description: 'Fetch your Companies.'
    arguments:
    - default:
      name: page
      description: 'Company list page.'
    - default:
      name: search
      description: 'Search text.'
    - default:
      name: size
      description: 'Company list size.'
    outputs:
    - contextPath: OctoxLabs.Companies.count
      description: 'Companies count.'
      type: Number
    - contextPath: OctoxLabs.Companies.results.id
      description: 'Company id.'
      type: Number
    - contextPath: OctoxLabs.Companies.results.name
      description: 'Company name.'
      type: String
    - contextPath: OctoxLabs.Companies.results.domain
      description: 'Company domain.'
      type: String
    - contextPath: OctoxLabs.Companies.results.is_active
      description: 'Company is active.'
      type: Boolean
  - name: octoxlabs-get-company-by-id
    description: 'Fetch your Company by id.'
    arguments:
    - required: true
      name: company_id
      description: 'Company id.'
    outputs:
    - contextPath: OctoxLabs.Company.results.id
      description: 'Company id.'
      type: Number
    - contextPath: OctoxLabs.Company.results.name
      description: 'Company name.'
      type: String
    - contextPath: OctoxLabs.Company.results.domain
      description: 'Company domain.'
      type: String
    - contextPath: OctoxLabs.Company.results.is_active
      description: 'Company is active.'
      type: Boolean
  - name: octoxlabs-get-company-by-name
    description: 'Fetch your Company by name.'
    arguments:
    - required: true
      name: company_name
      description: 'Company name.'
    outputs:
    - contextPath: OctoxLabs.Company.count
      description: 'Companies count.'
      type: Number
    - contextPath: OctoxLabs.Company.results.id
      description: 'Company id.'
      type: Number
    - contextPath: OctoxLabs.Company.results.name
      description: 'Company name.'
      type: String
    - contextPath: OctoxLabs.Company.results.domain
      description: 'Company domain.'
      type: String
    - contextPath: OctoxLabs.Company.results.is_active
      description: 'Company is active.'
      type: Boolean
  - name: octoxlabs-get-domains
    description: 'Fetch your Domains.'
    arguments:
    - default:
      name: page
      description: 'Domain list page.'
    - default:
      name: search
      description: 'Search text.'
    - default:
      name: size
      description: 'Domain list size.'
    outputs:
    - contextPath: OctoxLabs.Domains.count
      description: 'Domains count.'
      type: Number
    - contextPath: OctoxLabs.Domains.results.id
      description: 'Domain id.'
      type: Number
    - contextPath: OctoxLabs.Domains.results.domain
      description: 'Domain domain.'
      type: String
    - contextPath: OctoxLabs.Domains.results.tenant_name
      description: 'Domain tenant name.'
      type: String
    - contextPath: OctoxLabs.Domains.results.tenant
      description: 'Domain tenant.'
      type: Number
  - name: octoxlabs-get-domain-by-id
    description: 'Fetch your Domain by id.'
    arguments:
    - required: true
      name: domain_id
      description: 'Domain id.'
    outputs:
    - contextPath: OctoxLabs.Domain.results.id
      description: 'Domain id.'
      type: Number
    - contextPath: OctoxLabs.Domain.results.domain
      description: 'Domain domain.'
      type: String
    - contextPath: OctoxLabs.Domain.results.tenant_name
      description: 'Domain tenant name.'
      type: String
    - contextPath: OctoxLabs.Domain.results.tenant
      description: 'Domain tenant.'
      type: Number
  - name: octoxlabs-get-domain-by-domain-name
    description: 'Fetch your Domain by Domain name.'
    arguments:
    - required: true
      name: domain_name
      description: 'Domain name.'
    outputs:
    - contextPath: OctoxLabs.Domain.results.id
      description: 'Domain id.'
      type: Number
    - contextPath: OctoxLabs.Domain.results.domain
      description: 'Domain domain.'
      type: String
    - contextPath: OctoxLabs.Domain.results.tenant_name
      description: 'Domain tenant name.'
      type: String
    - contextPath: OctoxLabs.Domain.results.tenant
      description: 'Domain tenant.'
      type: Number
  - name: octoxlabs-get-users
    description: 'Fetch your Users.'
    arguments:
    - default:
      name: page
      description: 'User list page.'
    - default:
      name: search
      description: 'Search text.'
    - default:
      name: size
      description: 'User list size.'
    outputs:
    - contextPath: OctoxLabs.Users.count
      description: 'Users count.'
      type: Number
    - contextPath: OctoxLabs.Users.results.id
      description: 'User id.'
      type: Number
    - contextPath: OctoxLabs.Users.results.email
      description: 'User email.'
      type: String
    - contextPath: OctoxLabs.Users.results.username
      description: 'User username.'
      type: String
    - contextPath: OctoxLabs.Users.results.name
      description: 'User name.'
      type: String
    - contextPath: OctoxLabs.Users.results.first_name
      description: 'User first name.'
      type: String
    - contextPath: OctoxLabs.Users.results.last_name
      description: 'User last name.'
      type: String
    - contextPath: OctoxLabs.Users.results.is_active
      description: 'User is active.'
      type: Boolean
    - contextPath: OctoxLabs.Users.results.is_ldap
      description: 'User is ldap.'
      type: Boolean
    - contextPath: OctoxLabs.Users.results.groups
      description: 'List<Dict> User groups.'
      type: Unknown
  - name: octoxlabs-get-user-by-id
    description: 'Fetch your User by id.'
    arguments:
    - required: true
      name: user_id
      description: 'User id.'
    outputs:
    - contextPath: OctoxLabs.User.results.id
      description: 'User id.'
      type: Number
    - contextPath: OctoxLabs.User.results.email
      description: 'User email.'
      type: String
    - contextPath: OctoxLabs.User.results.username
      description: 'User username.'
      type: String
    - contextPath: OctoxLabs.User.results.name
      description: 'User name.'
      type: String
    - contextPath: OctoxLabs.User.results.first_name
      description: 'User first name.'
      type: String
    - contextPath: OctoxLabs.User.results.last_name
      description: 'User last name.'
      type: String
    - contextPath: OctoxLabs.User.results.is_active
      description: 'User is active.'
      type: Boolean
    - contextPath: OctoxLabs.User.results.is_ldap
      description: 'User is ldap.'
      type: Boolean
    - contextPath: OctoxLabs.User.results.groups
      description: 'List<Dict> User groups.'
      type: Unknown
  - name: octoxlabs-get-user-by-username
    description: 'Fetch your Users by username.'
    arguments:
    - required: true
      name: username
      description: 'User username.'
    outputs:
    - contextPath: OctoxLabs.User.results.id
      description: 'User id.'
      type: Number
    - contextPath: OctoxLabs.User.results.email
      description: 'User email.'
      type: String
    - contextPath: OctoxLabs.User.results.username
      description: 'User username.'
      type: String
    - contextPath: OctoxLabs.User.results.name
      description: 'User name.'
      type: String
    - contextPath: OctoxLabs.User.results.first_name
      description: 'User first name.'
      type: String
    - contextPath: OctoxLabs.User.results.last_name
      description: 'User last name.'
      type: String
    - contextPath: OctoxLabs.User.results.is_active
      description: 'User is active.'
      type: Boolean
    - contextPath: OctoxLabs.User.results.is_ldap
      description: 'User is ldap.'
      type: Boolean
    - contextPath: OctoxLabs.Users.results.groups
      description: 'List<Dict> User groups.'
      type: Unknown
  - name: octoxlabs-get-groups
    description: 'Fetch your Groups.'
    arguments:
    - default:
      name: page
      description: 'Group list page.'
    - default:
      name: search
      description: 'Search text.'
    - default:
      name: size
      description: 'Group list size.'
    outputs:
    - contextPath: OctoxLabs.Groups.count
      description: 'Groups count.'
      type: Number
    - contextPath: OctoxLabs.Groups.results.id
      description: 'Group id.'
      type: Number
    - contextPath: OctoxLabs.Groups.results.name
      description: 'Group name.'
      type: String
    - contextPath: OctoxLabs.Groups.results.users_count
      description: 'Group users count.'
      type: Number
  - name: octoxlabs-get-permissions
    description: 'Fetch your Permissions.'
    arguments:
    - default:
      name: page
      description: 'Permission list page.'
    - default:
      name: search
      description: 'Search text.'
    - default:
      name: size
      description: 'Permission list size.'
    outputs:
    - contextPath: OctoxLabs.Permissions.count
      description: 'Permissions count.'
      type: Number
    - contextPath: OctoxLabs.Permissions.results.id
      description: 'Permission id.'
      type: Number
    - contextPath: OctoxLabs.Permissions.results.name
      description: 'Permission name.'
      type: String
    - contextPath: OctoxLabs.Permissions.results.app
      description: 'Permission app.'
      type: String
  - name: octoxlabs-search-users-inventory
    description: 'Search in your User Inventory.'
    arguments:
      - default:
        description: 'Query.'
        name: query
      - default:
        description: 'Fields.'
        isArray: true
        name: fields
      - default:
        description: 'Page (Default: 1).'
        name: page
      - default:
        description: 'Size (Default: 50).'
        name: size
      - default:
        description: 'Specific Discovery Id.'
        name: discovery_id
    outputs:
      - contextPath: OctoxLabs.UserInventory.count
        description: 'Total users count.'
        type: Number
      - contextPath: OctoxLabs.UserInventory.results
        description: 'List User information.'
        type: Unknown
  - name: octoxlabs-search-applications
    description: 'Search in your Applications'
    arguments:
      - default:
        description: 'Query.'
        name: query
      - default:
        description: 'Fields.'
        isArray: true
        name: fields
      - default:
        description: 'Page (Default: 1).'
        name: page
      - default:
        description: 'Size (Default: 50).'
        name: size
      - default:
        description: 'Specific Discovery Id.'
        name: discovery_id
    outputs:
      - contextPath: OctoxLabs.Applications.count
        description: 'Total applications count.'
        type: Number
      - contextPath: OctoxLabs.Applications.results
        description: 'List Application information.'
        type: Unknown
  - name: octoxlabs-search-avm
    description: 'Search in your AVM'
    arguments:
      - default:
        description: 'Query.'
        name: query
      - default:
        description: 'Fields.'
        isArray: true
        name: fields
      - default:
        description: 'Page (Default: 1).'
        name: page
      - default:
        description: 'Size (Default: 50).'
        name: size
      - default:
        description: 'Specific Discovery Id.'
        name: discovery_id
    outputs:
      - contextPath: OctoxLabs.AVM.count
        description: 'Total vulnerabilities count.'
        type: Number
      - contextPath: OctoxLabs.AVM.results
        description: 'List Vulnerability information.'
        type: Unknown
  - name: octoxlabs-get-user-inventory-detail
    description: 'Fetch your user.'
    arguments:
      - required: true
        name: username
        description: 'Your user username.'
      - name: discovery_id
        description: 'Your device at specific discovery.'
    outputs:
      - contextPath: OctoxLabs.UserInv
        description: '<Dict> Octoxlabs User.'
        type: Unknown
  - name: octoxlabs-get-application-detail
    description: 'Fetch your application.'
    arguments:
      - required: true
        name: application_id
        description: 'Your application id.'
      - name: discovery_id
        description: 'Your device at specific discovery.'
    outputs:
      - contextPath: OctoxLabs.Application
        description: '<Dict> Octoxlabs Application.'
        type: Unknown
  - name: octoxlabs-search-scroll-devices
    description: 'Search in your devices.'
    arguments:
      - default:
        description: 'Query.'
        name: query
      - default:
        description: 'Fields.'
        isArray: true
        name: fields
      - default:
        description: 'Size (Default: 50).'
        name: size
      - default:
        description: 'Specific Discovery Id.'
        name: discovery_id
      - default:
        description: 'Specific Scroll Id.'
        name: scroll_id
    outputs:
      - contextPath: OctoxLabs.ScrolledDevices.count
        description: 'Total devices count.'
        type: Number
      - contextPath: OctoxLabs.ScrolledDevices.scroll_id
        description: 'Specific Scroll Id.'
        type: String
      - contextPath: OctoxLabs.ScrolledDevices.results
        description: 'List Device information.'
        type: Unknown
  - name: octoxlabs-search-scroll-users
    description: 'Search in your users.'
    arguments:
      - default:
        description: 'Query.'
        name: query
      - default:
        description: 'Fields.'
        isArray: true
        name: fields
      - default:
        description: 'Size (Default: 50).'
        name: size
      - default:
        description: 'Specific Discovery Id.'
        name: discovery_id
      - default:
        description: 'Specific Scroll Id.'
        name: scroll_id
    outputs:
      - contextPath: OctoxLabs.ScrolledUsers.count
        description: 'Total users count.'
        type: Number
      - contextPath: OctoxLabs.ScrolledUsers.scroll_id
        description: 'Specific Scroll Id.'
        type: String
      - contextPath: OctoxLabs.ScrolledUsers.results
        description: 'List Users information.'
        type: Unknown
  - name: octoxlabs-search-scroll-applications
    description: 'Search in your applications.'
    arguments:
      - default:
        description: 'Query.'
        name: query
      - default:
        description: 'Fields.'
        isArray: true
        name: fields
      - default:
        description: 'Size (Default: 50).'
        name: size
      - default:
        description: 'Specific Discovery Id.'
        name: discovery_id
      - default:
        description: 'Specific Scroll Id.'
        name: scroll_id
    outputs:
      - contextPath: OctoxLabs.ScrolledApplications.count
        description: 'Total applications count.'
        type: Number
      - contextPath: OctoxLabs.ScrolledApplications.scroll_id
        description: 'Specific Scroll Id.'
        type: String
      - contextPath: OctoxLabs.ScrolledApplications.results
        description: 'List Application information.'
        type: Unknown
  - name: octoxlabs-search-scroll-avm
    description: 'Search in your AVM.'
    arguments:
      - default:
        description: 'Query.'
        name: query
      - default:
        description: 'Size (Default: 50).'
        name: size
      - default:
        description: 'Specific Discovery Id.'
        name: discovery_id
      - default:
        description: 'Specific Scroll Id.'
        name: scroll_id
    outputs:
      - contextPath: OctoxLabs.ScrolledAVM.count
        description: 'Total vulnerabilities count.'
        type: Number
      - contextPath: OctoxLabs.ScrolledAVM.scroll_id
        description: 'Specific Scroll Id.'
        type: String
      - contextPath: OctoxLabs.ScrolledAVM.results
        description: 'List Vulnerability information.'
        type: Unknown
  runonce: false
  script: '-'
  type: python
  subtype: python3
  dockerimage: demisto/octoxlabs:1.0.0.10133006
fromversion: 6.0.0
tests:
- No tests (auto formatted)