Malwarebytes Installation Tokens API

openapi: 3.2.0
info:
  title: Malwarebytes Installation Tokens API
  version: 1.0.0
  description: 'Operations tagged Installation Tokens across 2 of this provider''s published API definitions: malwarebytes-threatdown-nebula-openapi.json, malwarebytes-threatdown-oneview-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.threatdown.com
tags:
- name: Installation Tokens
  description: Use these APIs to generate, send, and revoke installation tokens used to activate Mobile Security for Business.
paths:
  /nebula/v1/installation-token/{token}:
    servers:
    - url: https://api.threatdown.com
    delete:
      description: Revoke an installation token that has not been used yet.
      summary: Revoke installation token
      security:
      - client_credentials:
        - execute
      - user_permissions:
        - endpoints.install
      status:
        outage:
        - auth
      parameters:
      - name: token
        required: true
        in: path
        description: The token id that is going to be revoked
        schema:
          type: string
      - name: authorization
        required: true
        in: header
        description: Authorization token
        schema:
          type: string
      - name: accountid
        required: true
        in: header
        description: Your Nebula account id (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
        schema:
          type: string
          pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
      responses:
        '200':
          description: response schema
          content:
            application/json:
              schema:
                type: object
                title: Installation token
                examples:
                - account_id: 550a20b8-6d36-4222-afbc-54d100f2e894
                  id: 7qM4
                  token: 7qM4-aSdF
                  created_by: 5583ddb6-bb2f-42f1-b455-819d373a1b15
                  created_at: '2022-09-14T15:10:48.68866Z'
                  used_at: null
                  expires_at: '2022-10-14T15:10:48.68866Z'
                  sent_to: aatakan@malwarebytes.com
                properties:
                  account_id:
                    type: string
                    title: Account ID (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
                    pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
                    examples:
                    - 9256034b-7967-4253-a5d9-260663e4fa4f
                  id:
                    type: string
                    title: ID of the Token
                  token:
                    type: string
                    title: Token (only visible during creation)
                  created_by:
                    type: string
                    title: User ID that created the token (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
                    pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
                    examples:
                    - 9256034b-7967-4253-a5d9-260663e4fa4f
                  created_at:
                    type: string
                    title: The time when token is created
                  used_at:
                    type:
                    - string
                    - 'null'
                    title: The time when token is used
                  expires_at:
                    type: string
                    title: The time when token will be expired
                  sent_to:
                    type:
                    - string
                    - 'null'
                    title: The email address token is sent to
      tags:
      - Installation Tokens
      operationId: api.nebula.delete.installation-token
  /nebula/v1/installation-token:
    servers:
    - url: https://api.threatdown.com
    get:
      description: List the installation tokens generated or used
      summary: Get installation tokens
      security:
      - client_credentials:
        - read
      - user_permissions:
        - endpoints.install
      status:
        outage:
        - auth
      parameters:
      - name: authorization
        required: true
        in: header
        description: Authorization token
        schema:
          type: string
      - name: accountid
        required: true
        in: header
        description: Your Nebula account id (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
        schema:
          type: string
          pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
      - name: sort_by
        required: false
        in: query
        description: Field to sort with
        schema:
          type: string
          enum:
          - created_at
          - used_at
          - expires_at
      - name: sort_order
        required: false
        in: query
        description: Sort order
        schema:
          type: string
          enum:
          - asc
          - desc
      - name: include_used
        required: false
        in: query
        description: Include or exclude the used tokens
        schema:
          type: boolean
      - name: include_expired
        required: false
        in: query
        description: Include or exclude the expired tokens
        schema:
          type: boolean
      - name: populate
        required: false
        in: query
        description: Specify whether you need to populate the server's response with additional data, like account info or last task
        schema:
          type: object
      - name: page_size
        required: false
        in: query
        description: The size of the page
        schema:
          type: string
          pattern: ^1?\d{1,3}$
      - name: start_index
        required: false
        in: query
        description: The index of the first element
        schema:
          type: string
          pattern: \d+$
      responses:
        '200':
          description: response schema
          content:
            application/json:
              schema:
                type: object
                title: List all installation tokens
                required:
                - installation_tokens
                - total_count
                properties:
                  installation_tokens:
                    type: array
                    title: List of installation tokens
                    items:
                      type: object
                      title: Installation token
                      examples:
                      - account_id: 550a20b8-6d36-4222-afbc-54d100f2e894
                        id: 7qM4
                        token: 7qM4-aSdF
                        created_by: 5583ddb6-bb2f-42f1-b455-819d373a1b15
                        created_at: '2022-09-14T15:10:48.68866Z'
                        used_at: null
                        expires_at: '2022-10-14T15:10:48.68866Z'
                        sent_to: aatakan@malwarebytes.com
                      properties:
                        account_id:
                          type: string
                          title: Account ID (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
                          pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
                          examples:
                          - 9256034b-7967-4253-a5d9-260663e4fa4f
                        id:
                          type: string
                          title: ID of the Token
                        token:
                          type: string
                          title: Token (only visible during creation)
                        created_by:
                          type: string
                          title: User ID that created the token (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
                          pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
                          examples:
                          - 9256034b-7967-4253-a5d9-260663e4fa4f
                        created_at:
                          type: string
                          title: The time when token is created
                        used_at:
                          type:
                          - string
                          - 'null'
                          title: The time when token is used
                        expires_at:
                          type: string
                          title: The time when token will be expired
                        sent_to:
                          type:
                          - string
                          - 'null'
                          title: The email address token is sent to
                  total_count:
                    type: integer
                    title: Total Count
                    description: Total count of results.
      tags:
      - Installation Tokens
      operationId: api.nebula.get.installation-token
    post:
      description: Generate an installation token to be used. The token will be only visible during this operation.
      summary: Generate an installation tokens
      security:
      - client_credentials:
        - read
      - user_permissions:
        - endpoints.install
      status:
        outage:
        - auth
      parameters:
      - name: authorization
        required: true
        in: header
        description: Authorization token
        schema:
          type: string
      - name: accountid
        required: true
        in: header
        description: Your Nebula account id (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
        schema:
          type: string
          pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
      responses:
        '200':
          description: response schema
          content:
            application/json:
              schema:
                type: object
                title: Installation token
                examples:
                - account_id: 550a20b8-6d36-4222-afbc-54d100f2e894
                  id: 7qM4
                  token: 7qM4-aSdF
                  created_by: 5583ddb6-bb2f-42f1-b455-819d373a1b15
                  created_at: '2022-09-14T15:10:48.68866Z'
                  used_at: null
                  expires_at: '2022-10-14T15:10:48.68866Z'
                  sent_to: aatakan@malwarebytes.com
                properties:
                  account_id:
                    type: string
                    title: Account ID (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
                    pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
                    examples:
                    - 9256034b-7967-4253-a5d9-260663e4fa4f
                  id:
                    type: string
                    title: ID of the Token
                  token:
                    type: string
                    title: Token (only visible during creation)
                  created_by:
                    type: string
                    title: User ID that created the token (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
                    pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
                    examples:
                    - 9256034b-7967-4253-a5d9-260663e4fa4f
                  created_at:
                    type: string
                    title: The time when token is created
                  used_at:
                    type:
                    - string
                    - 'null'
                    title: The time when token is used
                  expires_at:
                    type: string
                    title: The time when token will be expired
                  sent_to:
                    type:
                    - string
                    - 'null'
                    title: The email address token is sent to
      tags:
      - Installation Tokens
      operationId: api.nebula.post.installation-token
  /nebula/v1/installation-token/send:
    servers:
    - url: https://api.threatdown.com
    post:
      description: Send installation tokens to batches of emails
      summary: Send installation tokens
      security:
      - client_credentials:
        - write
        - execute
      - user_permissions:
        - endpoints.install
      status:
        outage:
        - auth
      parameters:
      - name: authorization
        required: true
        in: header
        description: Authorization token
        schema:
          type: string
      - name: accountid
        required: true
        in: header
        description: Your Nebula account id (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
        schema:
          type: string
          pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              title: List of emails that installation tokens will be delivered to
              additionalProperties: false
              required:
              - emails
              properties:
                emails:
                  type: array
                  title: List of emails
                  items:
                    type: string
                    pattern: ^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$
      responses: {}
      tags:
      - Installation Tokens
      operationId: api.nebula.post.send-installation-token
  /oneview/v1/installation-token/{account_id}/{token}:
    servers:
    - url: https://api.threatdown.com
    delete:
      description: Revoke an installation token that has not been used yet.
      summary: Revoke installation token
      security:
      - client_credentials:
        - execute
      - user_permissions:
        - endpoints.install
      status:
        outage:
        - auth
      parameters:
      - name: token
        required: false
        in: path
        description: The token id that is going to be revoked
        schema:
          type: string
      - name: account_id
        required: false
        in: path
        description: Account ID (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
        schema:
          type: string
          pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
      - name: authorization
        required: true
        in: header
        description: Authorization token
        schema:
          type: string
      responses:
        '200':
          description: response schema
          content:
            application/json:
              schema:
                type: object
                title: Installation token
                examples:
                - account_id: 550a20b8-6d36-4222-afbc-54d100f2e894
                  id: 7qM4
                  token: 7qM4-aSdF
                  created_by: 5583ddb6-bb2f-42f1-b455-819d373a1b15
                  created_at: '2022-09-14T15:10:48.68866Z'
                  used_at: null
                  expires_at: '2022-10-14T15:10:48.68866Z'
                  sent_to: aatakan@malwarebytes.com
                properties:
                  account_id:
                    type: string
                    title: Account ID (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
                    pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
                    examples:
                    - 9256034b-7967-4253-a5d9-260663e4fa4f
                  id:
                    type: string
                    title: ID of the Token
                  token:
                    type: string
                    title: Token (only visible during creation)
                  created_by:
                    type: string
                    title: User ID that created the token (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
                    pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
                    examples:
                    - 9256034b-7967-4253-a5d9-260663e4fa4f
                  created_at:
                    type: string
                    title: The time when token is created
                  used_at:
                    type:
                    - string
                    - 'null'
                    title: The time when token is used
                  expires_at:
                    type: string
                    title: The time when token will be expired
                  sent_to:
                    type:
                    - string
                    - 'null'
                    title: The email address token is sent to
      tags:
      - Installation Tokens
      operationId: api.v2.rmm.revoke.installation-token
  /oneview/v1/installation-token/{account_id}:
    servers:
    - url: https://api.threatdown.com
    post:
      description: Generate an installation token to be used. The token will be only visible during this operation.
      summary: Generate an installation token
      security:
      - client_credentials:
        - read
      - user_permissions:
        - endpoints.install
      status:
        outage:
        - auth
      parameters:
      - name: account_id
        required: true
        in: path
        description: Account ID (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
        schema:
          type: string
          pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
      - name: authorization
        required: true
        in: header
        description: Authorization token
        schema:
          type: string
      responses:
        '200':
          description: response schema
          content:
            application/json:
              schema:
                type: object
                title: Installation token
                examples:
                - account_id: 550a20b8-6d36-4222-afbc-54d100f2e894
                  id: 7qM4
                  token: 7qM4-aSdF
                  created_by: 5583ddb6-bb2f-42f1-b455-819d373a1b15
                  created_at: '2022-09-14T15:10:48.68866Z'
                  used_at: null
                  expires_at: '2022-10-14T15:10:48.68866Z'
                  sent_to: aatakan@malwarebytes.com
                properties:
                  account_id:
                    type: string
                    title: Account ID (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
                    pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
                    examples:
                    - 9256034b-7967-4253-a5d9-260663e4fa4f
                  id:
                    type: string
                    title: ID of the Token
                  token:
                    type: string
                    title: Token (only visible during creation)
                  created_by:
                    type: string
                    title: User ID that created the token (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
                    pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
                    examples:
                    - 9256034b-7967-4253-a5d9-260663e4fa4f
                  created_at:
                    type: string
                    title: The time when token is created
                  used_at:
                    type:
                    - string
                    - 'null'
                    title: The time when token is used
                  expires_at:
                    type: string
                    title: The time when token will be expired
                  sent_to:
                    type:
                    - string
                    - 'null'
                    title: The email address token is sent to
      tags:
      - Installation Tokens
      operationId: api.v2.rmm.create.installation-token
  /oneview/v1/installation-token:
    servers:
    - url: https://api.threatdown.com
    post:
      description: List the installation tokens generated or used across multiple accounts
      summary: Get installation tokens across multiple accounts
      security:
      - client_credentials:
        - read
      - user_permissions:
        - endpoints.install
      status:
        outage:
        - auth
      parameters:
      - name: authorization
        required: true
        in: header
        description: Authorization token
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              title: Get installation tokens for multiple account ids
              allOf:
              - type: object
                title: Paging parameters for listing installation tokens
                properties:
                  sort_by:
                    type: string
                    title: Field to sort with
                    enum:
                    - created_at
                    - used_at
                    - expires_at
                  sort_order:
                    type: string
                    title: Sort order
                    enum:
                    - asc
                    - desc
                  include_used:
                    type: boolean
                    title: Include or exclude the used tokens
                    default: true
                  include_expired:
                    type: boolean
                    title: Include or exclude the expired tokens
                    default: true
                  populate:
                    type: object
                    title: Specify whether you need to populate the server's response with additional data, like account info or last task
                    properties:
                      account:
                        type: boolean
                        title: The account data
                  page_size:
                    type: string
                    title: The size of the page
                    pattern: ^1?\d{1,3}$
                  start_index:
                    type: string
                    title: The index of the first element
                    pattern: \d+$
              - type: object
                required:
                - account_ids
                properties:
                  account_ids:
                    type: array
                    title: The account ids to filter your search
                    minItems: 1
                    items:
                      type: string
                      title: Account id items (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
                      pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
                      examples:
                      - 9256034b-7967-4253-a5d9-260663e4fa4f
      responses:
        '200':
          description: response schema
          content:
            application/json:
              schema:
                type: object
                title: List all installation tokens
                required:
                - installation_tokens
                - total_count
                properties:
                  installation_tokens:
                    type: array
                    title: List of installation tokens
                    items:
                      type: object
                      title: Installation token
                      examples:
                      - account_id: 550a20b8-6d36-4222-afbc-54d100f2e894
                        id: 7qM4
                        token: 7qM4-aSdF
                        created_by: 5583ddb6-bb2f-42f1-b455-819d373a1b15
                        created_at: '2022-09-14T15:10:48.68866Z'
                        used_at: null
                        expires_at: '2022-10-14T15:10:48.68866Z'
                        sent_to: aatakan@malwarebytes.com
                      properties:
                        account_id:
                          type: string
                          title: Account ID (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
                          pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
                          examples:
                          - 9256034b-7967-4253-a5d9-260663e4fa4f
                        id:
                          type: string
                          title: ID of the Token
                        token:
                          type: string
                          title: Token (only visible during creation)
                        created_by:
                          type: string
                          title: User ID that created the token (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
                          pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
                          examples:
                          - 9256034b-7967-4253-a5d9-260663e4fa4f
                        created_at:
                          type: string
                          title: The time when token is created
                        used_at:
                          type:
                          - string
                          - 'null'
                          title: The time when token is used
                        expires_at:
                          type: string
                          title: The time when token will be expired
                        sent_to:
                          type:
                          - string
                          - 'null'
                          title: The email address token is sent to
                  total_count:
                    type: integer
                    title: Total Count
                    description: Total count of results.
      tags:
      - Installation Tokens
      operationId: api.v2.rmm.search.installation-token
  /oneview/v1/installation-token/{account_id}/send:
    servers:
    - url: https://api.threatdown.com
    post:
      description: Send installation tokens to batches of emails
      summary: Send installation tokens
      security:
      - client_credentials:
        - read
      - user_permissions:
        - endpoints.install
      status:
        outage:
        - auth
      parameters:
      - name: account_id
        required: true
        in: path
        description: Account ID (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
        schema:
          type: string
          pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
      - name: authorization
        required: true
        in: header
        description: Authorization token
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              title: List of emails that installation tokens will be delivered to
              additionalProperties: false
              required:
              - emails
              properties:
                emails:
                  type: array
                  title: List of emails
                  items:
                    type: string
                    pattern: ^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$
      responses:
        '200':
          description: response schema
          content:
            application/json:
              schema:
                type: object
                title: Installation token
                examples:
                - account_id: 550a20b8-6d36-4222-afbc-54d100f2e894
                  id: 7qM4
                  token: 7qM4-aSdF
                  created_by: 5583ddb6-bb2f-42f1-b455-819d373a1b15
                  created_at: '2022-09-14T15:10:48.68866Z'
                  used_at: null
                  expires_at: '2022-10-14T15:10:48.68866Z'
                  sent_to: aatakan@malwarebytes.com
                properties:
                  account_id:
                    type: string
                    title: Account ID (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
                    pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
                    examples:
                    - 9256034b-7967-4253-a5d9-260663e4fa4f
                  id:
                    type: string
                    title: ID of the Token
                  token:
                    type: string
                    title: Token (only visible during creation)
                  created_by:
                    type: string
                    title: User ID that created the token (Ex. "9256034b-7967-4253-a5d9-260663e4fa4f")
                    pattern: '[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12}$'
                    examples:
                    - 9256034b-7967-4253-a5d9-260663e4fa4f
                  created_at:
                    type: string
                    title: The time when token is created
                  used_at:
                    type:
                    - string
                    - 'null'
                    title: The time when token is used
                  expires_at:
                    type: string
                    title: The time when token will be expired
                  sent_to:
                    type:
                    - string
                    - 'null'
                    title: The email address token is sent to
      tags:
      - Installation Tokens
      operationId: api.v2.rmm.send.installation-token
components:
  securitySchemes:
    client_credentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: /token
          scopes:
            read: Read data of your Nebula account
            write: Write data, such as groups, policies, exclusions. Create Webhook subscriptions
            execute: Issue jobs on your endpoints, like Scan, Reboot or Isolate.
    user_permissions:
      type: http
      scheme: bearer
x-refined-from:
- malwarebytes-threatdown-nebula-openapi.json
- malwarebytes-threatdown-oneview-openapi.json