openapi: 3.0.0
info:
  title: Sumo Logic accessKeyManagement threatIntelIngestProducer API
  description: "# Getting Started\nWelcome to the Sumo Logic API reference. You can use these APIs to interact with the Sumo Logic platform. For information on Collector and Search Job APIs, see our [API home page](https://help.sumologic.com/docs/api).\n## API Endpoints\nSumo Logic has several deployments in different geographic locations. You'll need to use the Sumo Logic API endpoint corresponding to your geographic location. See the table below for the different API endpoints by deployment. For details determining your account's deployment, see [API endpoints](https://help.sumologic.com/?cid=3011).\n\n  <table>\n    <tr>\n      <td> <strong>Deployment</strong> </td>\n      <td> <strong>Endpoint</strong> </td>\n    </tr>\n    <tr>\n      <td> AU </td>\n      <td> https://api.au.sumologic.com/api/ </td>\n    </tr>\n    <tr>\n      <td> CA </td>\n      <td> https://api.ca.sumologic.com/api/ </td>\n    </tr>\n    <tr>\n      <td> DE </td>\n      <td> https://api.de.sumologic.com/api/ </td>\n    </tr>\n    <tr>\n      <td> EU </td>\n      <td> https://api.eu.sumologic.com/api/ </td>\n    </tr>\n    <tr>\n      <td> FED </td>\n      <td> https://api.fed.sumologic.com/api/ </td>\n    </tr>\n    <tr>\n      <td> IN </td>\n      <td> https://api.in.sumologic.com/api/ </td>\n    </tr>\n    <tr>\n      <td> JP </td>\n      <td> https://api.jp.sumologic.com/api/ </td>\n    </tr>\n    <tr>\n      <td> KR </td>\n      <td> https://api.kr.sumologic.com/api/ </td>\n    </tr>\n    <tr>\n      <td> US1 </td>\n      <td> https://api.sumologic.com/api/ </td>\n    </tr>\n    <tr>\n      <td> US2 </td>\n      <td> https://api.us2.sumologic.com/api/ </td>\n    </tr>\n  </table>\n\n## Authentication\nSumo Logic supports the following options for API authentication:\n- Access ID and Access Key\n- Base64 encoded Access ID and Access Key\n\nSee [Access Keys](https://help.sumologic.com/docs/manage/security/access-keys) to generate an Access Key. Make sure to copy the key you create, because it is displayed only once.\nWhen you have an Access ID and Access Key you can execute requests such as the following:\n  ```bash\n  curl -u \"<accessId>:<accessKey>\" -X GET https://api.<deployment>.sumologic.com/api/v1/users\n  ```\n\nWhere `deployment` is either `au`, `ca`, `de`, `eu`, `fed`, `in`, `jp`, `us1`, or `us2`. See [API endpoints](#section/API-Endpoints) for details.\n\nIf you prefer to use basic access authentication, you can do a Base64 encoding of your `<accessId>:<accessKey>` to authenticate your HTTPS request. The following is an example request, replace the placeholder `<encoded>` with your encoded Access ID and Access Key string:\n  ```bash\n  curl -H \"Authorization: Basic <encoded>\" -X GET https://api.<deployment>.sumologic.com/api/v1/users\n  ```\n\n\nRefer to [API Authentication](https://help.sumologic.com/?cid=3012) for a Base64 example.\n\n## Status Codes\nGeneric status codes that apply to all our APIs. See the [HTTP status code registry](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml) for reference.\n  <table>\n    <tr>\n      <td> <strong>HTTP Status Code</strong> </td>\n      <td> <strong>Error Code</strong> </td>\n      <td> <strong>Description</strong> </td>\n    </tr>\n    <tr>\n      <td> 301 </td>\n      <td> moved </td>\n      <td> The requested resource SHOULD be accessed through returned URI in Location Header. See [troubleshooting](https://help.sumologic.com/docs/api/troubleshooting/#api---301-error---moved) for details.</td>\n    </tr>\n    <tr>\n      <td> 401 </td>\n      <td> unauthorized </td>\n      <td> Credential could not be verified.</td>\n    </tr>\n    <tr>\n      <td> 403 </td>\n      <td> forbidden </td>\n      <td> This operation is not allowed for your account type or the user doesn't have the role capability to perform this action. See [troubleshooting](https://help.sumologic.com/docs/api/troubleshooting/#api---401-error---credential-could-not-be-verified) for details.</td>\n    </tr>\n    <tr>\n      <td> 404 </td>\n      <td> notfound </td>\n      <td> Requested resource could not be found. </td>\n    </tr>\n    <tr>\n      <td> 405 </td>\n      <td> method.unsupported </td>\n      <td> Unsupported method for URL. </td>\n    </tr>\n    <tr>\n      <td> 415 </td>\n      <td> contenttype.invalid </td>\n      <td> Invalid content type. </td>\n    </tr>\n    <tr>\n      <td> 429 </td>\n      <td> rate.limit.exceeded </td>\n      <td> The API request rate is higher than 4 request per second or inflight API requests are higher than 10 request per second. </td>\n    </tr>\n    <tr>\n      <td> 500 </td>\n      <td> internal.error </td>\n      <td> Internal server error. </td>\n    </tr>\n    <tr>\n      <td> 503 </td>\n      <td> service.unavailable </td>\n      <td> Service is currently unavailable. </td>\n    </tr>\n  </table>\n\n## Filtering\nSome API endpoints support filtering results on a specified set of fields. Each endpoint that supports filtering will list the fields that can be filtered. Multiple fields can be combined by using an ampersand `&` character.\n\nExample: To get user with email `john@demo.com`:\n  ```bash\n  api.sumologic.com/v1/users?email=john@demo.com\n  ```\n\n## Sorting\nSome API endpoints support sorting fields by using the `sortBy` query parameter. The default sort order is ascending. Prefix the field with a minus sign `-` to sort in descending order.\n\nFor example, to get 20 users sorted by their `email` in descending order:\n  ```bash\n  api.sumologic.com/v1/users?limit=20&sort=-email\n  ```\n\n## Asynchronous Request\nAsynchronous requests do not wait for results, instead they immediately respond back with a job identifier while the job runs in the background. You can use the job identifier to track the status of the asynchronous job request. Here is a typical flow for an asynchronous request.\n1. Start an asynchronous job. On success, a job identifier is returned. The job identifier uniquely identifies\n  your asynchronous job.\n\n2. Once started, use the job identifier from step 1 to track the status of your asynchronous job. An asynchronous\n  request will typically provide an endpoint to poll for the status of asynchronous job. A successful response\n  from the status endpoint will have the following structure:\n  ```json\n  {\n      \"status\": \"Status of asynchronous request\",\n      \"statusMessage\": \"Optional message with additional information in case request succeeds\",\n      \"error\": \"Error object in case request fails\"\n  }\n  ```\n  The `status` field can have one of the following values:\n    1. `Success`: The job succeeded. The `statusMessage` field might have additional information.\n    2. `InProgress`: The job is still running.\n    3. `Failed`: The job failed. The `error` field in the response will have more information about the failure.\n\n3. Some asynchronous APIs may provide a third endpoint (like [export result](#operation/getAsyncExportResult))\n  to fetch the result of an asynchronous job.\n\n\n### Example\nLet's say we want to export a folder with the identifier `0000000006A2E86F`. We will use the [async export](#operation/beginAsyncExport) API to export all the content under the folder with `id=0000000006A2E86F`.\n1. Start an export job for the folder\n  ```bash\n  curl -X POST -u \"<accessId>:<accessKey>\" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export\n  ```\n  See [authentication section](#section/Authentication) for more details about `accessId`, `accessKey`, and\n  `deployment`.\n  On success, you will get back a job identifier. In the response below, `C03E086C137F38B4` is the job identifier.\n  ```bash\n  {\n      \"id\": \"C03E086C137F38B4\"\n  }\n  ```\n\n2. Now poll for the status of the asynchronous job with the [status](#operation/getAsyncExportStatus) endpoint.\n  ```bash\n  curl -X GET -u \"<accessId>:<accessKey>\" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export/C03E086C137F38B4/status\n  ```\n  You may get a response like\n  ```json\n  {\n      \"status\": \"InProgress\",\n      \"statusMessage\": null,\n      \"error\": null\n  }\n  ```\n  It implies the job is still in progress. Keep polling till the status is either `Success` or `Failed`.\n\n3. When the asynchronous job completes (`status != \"InProgress\"`), you can fetch the results with the\n  [export result](#operation/getAsyncExportResult) endpoint.\n  ```bash\n  curl -X GET -u \"<accessId>:<accessKey>\" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export/C03E086C137F38B4/result\n  ```\n\n  The asynchronous job may fail (`status == \"Failed\"`). You can look at the `error` field for more details.\n  ```json\n  {\n      \"status\": \"Failed\",\n      \"errors\": {\n          \"code\": \"content1:too_many_items\",\n          \"message\": \"Too many objects: object count(1100) was greater than limit 1000\"\n      }\n  }\n  ```\n\n\n## Rate Limiting\n* A rate limit of four API requests per second (240 requests per minute) applies to all API calls from a user.\n* A rate limit of 10 concurrent requests to any API endpoint applies to an access key.\n\nIf a rate is exceeded, a rate limit exceeded 429 status code is returned.\n\n## Generating Clients\nYou can use [OpenAPI Generator](https://openapi-generator.tech) to generate clients from the YAML file to access the API.\n\n### Using [NPM](https://www.npmjs.com/get-npm)\n1. Install [NPM package wrapper](https://github.com/openapitools/openapi-generator-cli) globally, exposing the CLI\n  on the command line:\n  ```bash\n  npm install @openapitools/openapi-generator-cli -g\n  ```\n  You can see detailed instructions [here](https://openapi-generator.tech/docs/installation#npm).\n\n2. Download the [YAML file](/docs/sumologic-api.yaml) and save it locally. Let's say the file is saved as `sumologic-api.yaml`.\n3. Use the following command to generate `python` client inside the `sumo/client/python` directory:\n  ```bash\n  openapi-generator generate -i sumologic-api.yaml -g python -o sumo/client/python\n  ```\n\n\n### Using [Homebrew](https://brew.sh/)\n1. Install OpenAPI Generator\n  ```bash\n  brew install openapi-generator\n  ```\n\n2. Download the [YAML file](/docs/sumologic-api.yaml) and save it locally. Let's say the file is saved as `sumologic-api.yaml`.\n3. Use the following command to generate `python` client side code inside the `sumo/client/python` directory:\n  ```bash\n  openapi-generator generate -i sumologic-api.yaml -g python -o sumo/client/python\n  ```\n"
  version: 1.0.0
  x-logo:
    url: ./sumologic_logo.png
servers:
- url: https://api.au.sumologic.com/api/
  description: AU deployment API server
- url: https://api.ca.sumologic.com/api/
  description: CA deployment API server
- url: https://api.de.sumologic.com/api/
  description: DE deployment API server
- url: https://api.eu.sumologic.com/api/
  description: EU deployment API server
- url: https://api.fed.sumologic.com/api/
  description: FED deployment API server
- url: https://api.jp.sumologic.com/api/
  description: JP deployment API server
- url: https://api.kr.sumologic.com/api/
  description: KR deployment API server
- url: https://api.in.sumologic.com/api/
  description: IN deployment API server
- url: https://api.sumologic.com/api/
  description: US1 deployment API server
- url: https://api.us2.sumologic.com/api/
  description: US2 deployment API server
security:
- basicAuth: []
tags:
- name: threatIntelIngestProducer
  description: 'Threat Intel Ingestion API


    The Threat Intel Ingestion API allows you to:

    * Upload threat intel indicators in STIX 2.x or Sumo normalized format.

    * Delete indicators by ID or source.


    For more information, see [Threat Intel Ingest Management](https://help.sumologic.com/Manage/Threat-Intel-Ingest).

    '
  x-displayName: Threat Intel Ingestion
paths:
  /v1/threatIntel/datastore/indicators/normalized:
    post:
      tags:
      - threatIntelIngestProducer
      summary: Uploads Indicators In A Sumo Normalized Format.
      description: Uploads a list indicators in a Sumo normalized format.
      operationId: uploadNormalizedIndicators
      parameters: []
      requestBody:
        description: The list of normalized threat intel indicators to upload.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UploadNormalizedIndicatorRequest'
        required: true
      responses:
        '204':
          description: Normalized indicators successfully uploaded.
        default:
          description: Operation failed with an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/threatIntel/datastore/indicators/stix:
    post:
      tags:
      - threatIntelIngestProducer
      summary: Uploads Indicators In A STIX 2.x Json Format.
      description: Uploads a list indicators in in a STIX 2.x json format.
      operationId: uploadStixIndicators
      parameters: []
      requestBody:
        description: Upload stix indicators request body.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UploadStixIndicatorsRequest'
        required: true
      responses:
        '200':
          description: Stix indicators successfully uploaded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UploadStixIndicatorsResponse'
        default:
          description: Operation failed with an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/threatIntel/datastore/indicators:
    delete:
      tags:
      - threatIntelIngestProducer
      summary: Removes Indicators By Their IDS
      description: Removes indicators by specifying a list of indicator IDs
      operationId: removeIndicators
      parameters: []
      requestBody:
        description: The list of indicator IDs to remove
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemoveIndicatorsRequest'
        required: true
      responses:
        '204':
          description: Indicators successfully removed
        default:
          description: Operation failed with an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    UploadStixIndicatorsRequest:
      required:
      - indicators
      - source
      type: object
      properties:
        source:
          type: string
          description: User-provided text to identify the source of the indicator
          example: FreeTAXII
        indicators:
          type: array
          description: The list of stix threat intel indicators to upload.
          items:
            $ref: '#/components/schemas/StixIndicator'
    NormalizedIndicator:
      required:
      - confidence
      - id
      - indicator
      - source
      - threatType
      - type
      - validFrom
      type: object
      properties:
        id:
          type: string
          description: ID of the indicator
          example: indicator--d81f86b9-975b-4c0b-875e-810c5ad45a4f
        indicator:
          type: string
          description: Value of the indicator
          example: 182.158.1.1
        type:
          type: string
          description: Type of indicator
          example: ipv4-addr
        source:
          type: string
          description: User-provided text to identify the source of the indicator
          example: FreeTAXII
        updated:
          type: string
          description: When this indicator was most recently updated in Sumo. Timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format.
          format: date-time
          example: 2023-03-21 12:00:00+00:00
        validFrom:
          type: string
          description: Beginning time this indicator is valid. Timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format.
          format: date-time
          example: 2023-03-21 12:00:00+00:00
        validUntil:
          type: string
          description: 'Time at which this indicator expires. If not set, a default TTL is applied based on indicator type and confidence. File hash indicators (type prefix `file:hashes`): 30/365/730 days for low/medium/high confidence. All other indicator types: 30/90/180 days for low/medium/high confidence. Confidence bands: low 0-49, medium 50-74, high 75-100. Timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format.'
          format: date-time
          example: 2023-03-21 12:00:00+00:00
        confidence:
          maximum: 100
          minimum: 1
          type: integer
          description: Confidence that the creator has in the correctness of their data, where 100 is highest
        threatType:
          type: string
          description: Type of indicator ( https://docs.oasis-open.org/cti/stix/v2.1/os/stix-v2.1-os.html#_cvhfwe3t9vuo )
          example: benign
        actors:
          type: string
          description: Actors as a comma separated list.
          example: actor1,actor2
        killChain:
          type: string
          description: Kill Chain as a comma separated list.
          example: KC1,KC2
        fields:
          maxProperties: 1000
          type: object
          additionalProperties:
            type: string
          description: Flattened fields from the original indicator object (e.g. flattened STIX fields)
    StixIndicator:
      required:
      - created
      - id
      - modified
      - pattern
      - pattern_type
      - spec_version
      - type
      - valid_from
      type: object
      properties:
        type:
          type: string
          description: The type property identifies the type of STIX Object.
          example: indicator
        spec_version:
          type: string
          description: The STIX version
          example: '2.1'
        id:
          type: string
          description: The ID of the indicator
          example: acme:indicator-bf8bc5d5-c7e6-46b0-8d22-7500fea77196
        created:
          type: string
          description: The time from which this Indicator is considered a valid indicator of the behaviors it is related or represents.
          format: date-time
          example: 2023-03-21 12:00:00+00:00
        modified:
          type: string
          description: The time from which this Indicator is considered a valid indicator of the behaviors it is related or represents.
          format: date-time
          example: 2023-03-21 12:00:00+00:00
        created_by_ref:
          type: string
          description: Identifier of type identity
          example: identity--f431f809-377b-45e0-aa1c-6a4751cae5ff
        revoked:
          type: boolean
          description: The revoked property is only used by STIX Objects that support versioning and indicates whether the object has been revoked.
        labels:
          type: array
          description: The labels property specifies a set of terms used to describe this object. The terms are user-defined or trust-group defined and their meaning is outside the scope of this specification and MAY be ignored.
          example:
          - heartbleed
          - has-logo
          items:
            type: string
        confidence:
          maximum: 100
          minimum: 1
          type: integer
          description: Confidence that the creator has in the correctness of their data, where 100 is highest
        lang:
          type: string
          description: The lang property identifies the language of the text content in this object. When present, it MUST be a language code conformant to [RFC5646]. If the property is not present, then the language of the content is en (English)
          example: en
        external_references:
          type: array
          description: A list of external references which refer to non-STIX information. This property MAY be used to provide one or more Vulnerability identifiers, such as a CVE ID
          items:
            $ref: '#/components/schemas/ExternalReference'
        object_marking_refs:
          type: array
          description: The object_marking_refs property specifies a list of id properties of marking-definition objects that apply to this object.
          example:
          - marking-definition--089a6ecb-cc15-43cc-9494-767639779123
          items:
            type: string
        granular_markings:
          type: array
          description: The granular_markings property specifies a list of granular markings applied to this object
          items:
            $ref: '#/components/schemas/GranularMarkingType'
        extensions:
          maxProperties: 1000
          type: object
          additionalProperties:
            $ref: '#/components/schemas/Extension'
          description: Specifies any extensions of the object, as a dictionary
        name:
          type: string
          description: The name of the object
        description:
          type: string
          description: A human readable description
        indicator_types:
          type: array
          description: A set of categorizations for this indicator.
          example:
          - malicious-activity
          items:
            type: string
        pattern:
          type: string
          description: The detection pattern for this Indicator expressed as a STIX patter.
          example: '[ipv4-addr:value = ''1.2.3.4'']'
        pattern_type:
          type: string
          description: The type of pattern
          example: stix
        pattern_version:
          type: string
          description: The version of the pattern language that is used for the data in the pattern property which MUST match the type of pattern data included in the pattern property.
        valid_from:
          type: string
          description: The time from which this Indicator is considered a valid indicator of the behaviors it is related or represents.
          format: date-time
          example: 2023-03-21 12:00:00+00:00
        valid_until:
          type: string
          description: 'The time at which this Indicator should no longer be considered a valid indicator of the behaviors it is related to or represents. If not set, a default TTL is applied based on indicator type and confidence. File hash indicators (type prefix `file:hashes`): 30/365/730 days for low/medium/high confidence. All other indicator types: 30/90/180 days for low/medium/high confidence. Confidence bands: low 0-49, medium 50-74, high 75-100.'
          format: date-time
          example: 2023-03-21 12:00:00+00:00
        kill_chain_phases:
          type: array
          description: The list of Kill Chain Phases for which this Attack Pattern is used
          items:
            $ref: '#/components/schemas/KillChainPhase'
    UploadNormalizedIndicatorRequest:
      required:
      - indicators
      type: object
      properties:
        indicators:
          type: array
          description: The list of normalized threat intel indicators to upload.
          items:
            $ref: '#/components/schemas/NormalizedIndicator'
    GranularMarkingType:
      required:
      - selectors
      type: object
      properties:
        lang:
          type: string
          description: The lang property identifies the language of the text identified by this marking
          example: en
        marking_ref:
          type: string
          description: The marking_ref property specifies the ID of the marking-definition object that describes the marking
          example: marking-definition--089a6ecb-cc15-43cc-9494-767639779123
        selectors:
          type: array
          description: The selectors property specifies a list of selectors for content contained within the STIX Object in which this property appears
          example:
          - description
          - labels
          items:
            type: string
    RemoveIndicatorsRequest:
      required:
      - indicatorIds
      - source
      type: object
      properties:
        source:
          type: string
          description: The source of the indicator ID to match against
          example: Crowdstrike
        indicatorIds:
          type: array
          description: The list of indicator IDs to match against
          example:
          - indicator--abcd
          - indicator--ef012
          items:
            type: string
    UploadStixIndicatorsResponse:
      required:
      - invalidIndicators
      type: object
      properties:
        invalidIndicators:
          type: array
          description: A list of invalid indicator IDs that were not ingested
          example:
          - indicator--foo
          - indicator--bar
          items:
            type: string
    ErrorDescription:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
          description: An error code describing the type of error.
          example: auth:password_too_short
        message:
          type: string
          description: A short English-language description of the error.
          example: Your password was too short.
        detail:
          type: string
          description: An optional fuller English-language description of the error.
          example: Your password was 5 characters long, the minimum length is 12 characters. See http://example.com/password for more information.
        meta:
          type: object
          description: An optional list of metadata about the error.
          example:
            minLength: 12
            actualLength: 5
    ErrorResponse:
      required:
      - errors
      - id
      type: object
      properties:
        id:
          type: string
          description: An identifier for the error; this is unique to the specific API request.
          example: IUUQI-DGH5I-TJ045
        errors:
          type: array
          description: A list of one or more causes of the error.
          example:
          - code: auth:password_too_short
            message: Your password was too short.
          - code: auth:password_character_classes
            message: Your password did not contain any non-alphanumeric characters
          items:
            $ref: '#/components/schemas/ErrorDescription'
    ExternalReference:
      required:
      - source_name
      type: object
      properties:
        source_name:
          type: string
          description: The name of the source that the external-reference is defined within
          example: system
        description:
          type: string
          description: A human readable description
        url:
          type: string
          description: A URL reference to an external resource
          example: https://github.com/vz-risk/0001AA7F-C601-424A-B2B8-BE6C9F5164E7.json
        hashes:
          maxProperties: 1000
          type: object
          additionalProperties:
            type: string
          description: Specifies a dictionary of hashes for the contents of the url
          example:
            SHA-256: 6db12788c37247f2316052e142f42f4b259d6561751e5f401a1ae2a6df9c674b
        external_id:
          type: string
          description: An identifier for the external reference content
          example: 0001AA7F-C601-424A-B2B8-BE6C9F5164E7
    Extension:
      required:
      - created
      - created_by_ref
      - extension_types
      - id
      - modified
      - name
      - schema
      - spec_version
      - type
      - version
      type: object
      properties:
        type:
          type: string
          description: The type property identifies the type of object
          example: indicator
        spec_version:
          type: string
          description: The STIX version
          example: '2.1'
        id:
          type: string
          description: The ID of the indicator
          example: acme:indicator-bf8bc5d5-c7e6-46b0-8d22-7500fea77196
        created:
          type: string
          description: The time from which this Indicator is considered a valid indicator of the behaviors it is related or represents.
          format: date-time
          example: 2023-03-21 12:00:00+00:00
        modified:
          type: string
          description: The time from which this Indicator is considered a valid indicator of the behaviors it is related or represents.
          format: date-time
          example: 2023-03-21 12:00:00+00:00
        created_by_ref:
          type: string
          description: Identifier of type identity
          example: identity--f431f809-377b-45e0-aa1c-6a4751cae5ff
        revoked:
          type: boolean
          description: The revoked property is only used by STIX Objects that support versioning and indicates whether the object has been revoked.
        labels:
          type: array
          description: The labels property specifies a set of terms used to describe this object. The terms are user-defined or trust-group defined and their meaning is outside the scope of this specification and MAY be ignored.
          example:
          - heartbleed
          - has-logo
          items:
            type: string
        external_references:
          type: array
          description: A list of external references which refer to non-STIX information. This property MAY be used to provide one or more Vulnerability identifiers, such as a CVE ID
          items:
            $ref: '#/components/schemas/ExternalReference'
        object_marking_refs:
          type: array
          description: The object_marking_refs property specifies a list of id properties of marking-definition objects that apply to this object.
          example:
          - marking-definition--089a6ecb-cc15-43cc-9494-767639779123
          items:
            type: string
        granular_markings:
          type: array
          description: The granular_markings property specifies a list of granular markings applied to this object
          items:
            $ref: '#/components/schemas/GranularMarkingType'
        name:
          type: string
          description: The name of the object
        description:
          type: string
          description: A human readable description
        schema:
          type: string
          description: The normative definition of the extension, either as a URL or as plain text explaining the definition
          example: https://www.example.com/schema-my-favorite-sdo-1/v1
        version:
          type: string
          description: The version of this extension
        extension_types:
          type: array
          description: This property specifies one or more extension types contained within this extension
          items:
            type: string
            enum:
            - new-sdo
            - new-sco
            - new-sro
            - property-extension
            - toplevel-property-extension
        extension_properties:
          type: array
          description: This property contains the list of new property names that are added to an object by an extension
          items:
            type: string
    KillChainPhase:
      required:
      - kill_chain_name
      type: object
      properties:
        kill_chain_name:
          type: string
          description: The name of the kill chain. The value of this property SHOULD be all lowercase and SHOULD use hyphens instead of spaces or underscores as word separators
          example: lockheed-martin-cyber-kill-chain
        phase_name:
          type: string
          description: The name of the phase in the kill chain. The value of this property SHOULD be all lowercase and SHOULD use hyphens instead of spaces or underscores as word separators
          example: reconnaissance
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
x-tagGroups:
- name: Archive Management
  tags:
  - archiveManagement
- name: Health Events
  tags:
  - healthEvents
- name: Infrequent Data Tier
  tags:
  - logSearchesEstimatedUsage
- name: Ingest Budgets Management V2
  tags:
  - ingestBudgetManagementV2
- name: Library Management
  tags:
  - appManagement
  - appManagementV2
  - contentManagement
  - dashboardManagement
  - folderManagement
  - lookupManagement
  - contentPermissions
  - logSearchesManagement
  - parsersLibraryManagement
- name: Metrics
  tags:
  - metricsSearchesManagement
  - transformationRuleManagement
  - metricsQuery
  - metricsSearchesManagementV2
- name: Security Management
  tags:
  - accessKeyManagement
  - oauthManagement
  - accountManagement
  - passwordPolicy
  - policiesManagement
  - samlConfigurationManagement
  - serviceAllowlistManagement
  - serviceAccountManagement
  - scimUserManagement
- name: Organizations Management
  tags:
  - orgsManagement
- name: Settings Management
  tags:
  - connectionManagement
  - dynamicParsingRuleManagement
  - extractionRuleManagement
  - fieldManagementV1
  - partitionManagement
  - scheduledViewManagement
  - logsDataForwardingManagement
  - dataDeletionRules
- name: Tokens Management
  tags:
  - tokensLibraryManagement
- name: Tracing
  tags:
  - traces
  - spanAnalytics
  - serviceMap
- name: Users and Roles Management
  tags:
  - roleManagement
  - roleManagementV2
  - userManagement
- name: Threat Intel Ingest Management
  tags:
  - threatIntelIngest
  - threatIntelIngestProducer
- name: OpenTelemetry Collector Management
  tags:
  - otCollectorManagementExternal
- name: Source Template Management
  tags:
  - sourceTemplateManagementExternal
- name: Schema Base Management
  tags:
  - schemaBaseManagement
- name: Event Analytics Management
  tags:
  - eventAnalytics
- name: Budget Management
  tags:
  - budgetManagement
- name: Macro Management
  tags:
  - macroManagement
- name: Muting Schedules Management
  tags:
  - mutingSchedulesLibraryManagement
- name: SLO Management
  tags:
  - slosLibraryManagement
- name: Monitor Management
  tags:
  - monitorsLibraryManagement