category: Database
provider: MongoDB Inc.
fromversion: 5.0.0
commonfields:
  id: MongoDB Key Value Store
  version: -1
configuration:
- display: MongoDB username
  name: credentials
  required: true
  type: 9
- display: URI (mongodb://<IP/FQDN>:<Port Number>)
  name: uri
  required: true
  type: 0
- display: MongoDB database name
  name: database
  required: true
  type: 0
- defaultvalue: generic
  display: MongoDB collection name
  name: collection
  required: true
  type: 0
- display: Use an SSL/TLS secured connection
  name: use_ssl
  type: 8
  required: false
- display: Trust any certificate (not secure)
  name: insecure
  type: 8
  required: false
description: Manipulates key/value pairs according to an incident utilizing the MongoDB collection.
display: MongoDB Key Value Store
name: MongoDB Key Value Store
script:
  commands:
  - arguments:
    - description: The Demisto incident number.
      name: id
    - description: Name/Key.
      name: key
      required: true
    - description: Assigns a value to the name/key.
      name: value
      required: true
    description: Adds a key/value record for the incident. If the key exists, the existing value is overwritten.
    name: mongodb-write-key-value
    outputs:
    - contextPath: MongoDB.Entry.ID
      description: Entry ID.
      type: String
    - contextPath: MongoDB.Entry.Incident
      description: Incident ID.
      type: String
    - contextPath: MongoDB.Entry.Key
      description: Incident key.
      type: String
    - contextPath: MongoDB.Entry.Value
      description: Incident value.
      type: String
    - contextPath: MongoDB.Entry.Modified
      description: Incident modified date.
      type: Date
  - arguments:
    - description: The Demisto incident number.
      name: id
    - description: Name/Key.
      name: key
      required: true
    description: Returns the value of the specified name/key of an incident.
    name: mongodb-get-key-value
    outputs:
    - contextPath: MongoDB.Entry.Incident
      description: Incident ID.
      type: String
    - contextPath: MongoDB.Entry.Key
      description: Incident key.
      type: String
    - contextPath: MongoDB.Entry.Value
      description: The value of the key.
      type: String
  - arguments:
    - description: The Demisto incident number.
      name: id
    description: Lists the keys and their values for the specified incident.
    name: mongodb-list-key-values
    outputs:
    - contextPath: MongoDB.Incident.Incident
      description: Incident ID.
      type: String
    - contextPath: MongoDB.Incident.Key
      description: Incident key.
      type: String
    - contextPath: MongoDB.Incident.Value
      description: The value of the key.
      type: String
  - arguments:
    - description: The Demisto incident number.
      name: id
    - description: Name/Key.
      name: key
      required: true
    description: Deletes the key/value record for an incident.
    name: mongodb-delete-key
  - arguments:
    - description: The Demisto incident number.
      name: id
    description: Purges all keys/values for an incident. A common use case for this command is when closing an incident. This command clears the entries for the closed incident from the database.
    name: mongodb-purge-entries
  - arguments:
    - description: The Demisto incident number.
      name: id
    description: Returns the number of key/value pairs for an incident.
    name: mongodb-get-keys-number
  - description: Lists all incidents in the collection.
    name: mongodb-list-incidents
  dockerimage: demisto/py3-tools:1.0.0.114656
  runonce: false
  script: '-'
  type: python
  subtype: python3
tests:
- MongoDB KeyValueStore - Test