openapi: 3.2.0
info:
  title: SecurityScorecard Partner API
  version: 0.0.1
  contact:
    name: SecurityScorecard Support
    email: support@securityscorecard.io
  description: 'For onboarding instructions and details on how SecurityScorecard API works,

    please see our Readme guide: https://securityscorecard.readme.io/docs


    For technical support please contact us at

    support@securityscorecard.io. We typically

    respond in 48 hours and operate Monday thru Friday 9am - 5pm EST (excluding

    US federal holidays).'
  x-logo:
    url: https://platform.securityscorecard.io/images/ssc-logo-white-stacked.svg
    backgroundColor: '#222830'
servers:
- url: https://api.securityscorecard.io
security:
- Token: []
tags:
- name: Partner
paths:
  /max/partner/breaches:
    get:
      summary: Get max partner breaches
      description: Gets breaches
      tags:
      - Partner
      parameters:
      - in: query
        name: triaged
        required: false
        example: 'true'
        schema:
          type: string
          enum:
          - 'true'
          - 'false'
        description: Filter findings that are set to be triaged
      - in: query
        name: report
        required: false
        example: 'true'
        schema:
          type: string
          enum:
          - 'true'
          - 'false'
        description: Filter findings that are set to be reported
      - in: query
        name: customer_id
        required: false
        example: aea7dae2-370f-4279-a458-4c7cb9661778
        schema:
          type: string
          format: uuid
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        description: Customer ID filter, accepts single value or comma separated list of customer ids
      - in: query
        name: customer_name
        required: false
        example: SecurityScorecard
        schema:
          type: string
        description: Customer name filter, accepts single value or comma separated list of customer names
      - in: query
        name: customer_domain
        required: false
        example: securityscorecard.com
        schema:
          type: string
        description: Customer domain filter, accepts single value or comma separated list of customer domains
      - in: query
        name: vendor_id
        required: false
        example: aea7dae2-370f-4279-a458-4c7cb9661778
        schema:
          type: string
          format: uuid
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        description: Vendor ID filter, accepts single value or comma separated list of vendor ids
      - in: query
        name: vendor_domain
        required: false
        example: securityscorecard.com
        schema:
          type: string
        description: Vendor domain filter, accepts single value or comma separated list of vendor domains
      - in: query
        name: vendor_name
        required: false
        example: SecurityScorecard
        schema:
          type: string
        description: Vendor name filter, accepts single value or comma separated list of vendor names
      - in: query
        name: published_at
        required: false
        example: '{"operator":"gte","value":"2025-01-01"}'
        schema:
          type: string
        description: Published date filter, accept stringified object with date value and operator
      - in: query
        name: recent_only
        required: false
        example: 'true'
        schema:
          type: string
          enum:
          - 'true'
          - 'false'
        description: Set true to get just recently triaged breaches along with the not triaged ones
      - in: query
        name: search
        required: false
        example: foo bar
        schema:
          type: string
        description: Word or phrase to search records for
      - in: query
        name: sort
        required: false
        example: '{"column":"published_at","order":"desc"}'
        schema:
          type: string
        description: Stringified object with value for column to order by and operator
      - in: query
        name: page
        required: false
        schema:
          type: integer
        description: optionally specify which page of results to return
      - in: query
        name: limit
        required: false
        example: 25
        schema:
          type: integer
          maximum: 1500
        description: optionally specify how many results to return, maximum is 1500
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      responses:
        '200':
          description: Breaches list for the given filters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BreachesList'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: getMaxPartnerBreaches
      x-operation-id-source: derived
    put:
      summary: Update the status of the breach finding as reported to make it available in the…
      description: ''
      tags:
      - Partner
      parameters:
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateBreachesSettings'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      operationId: putMaxPartnerBreaches
      x-operation-id-source: derived
  /max/partner/documents:
    post:
      summary: Create max partner documents
      description: Upload a document.
      tags:
      - Partner
      parameters:
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DocumentToUploadSchema'
        required: true
      responses:
        '201':
          description: A document id.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentIdSchema'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: postMaxPartnerDocuments
      x-operation-id-source: derived
    put:
      summary: Replace max partner documents
      description: Edit a document metadata.
      tags:
      - Partner
      parameters:
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentToUpdateSchema'
        required: true
      responses:
        '200':
          description: An updated document ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentIdSchema'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: putMaxPartnerDocuments
      x-operation-id-source: derived
    delete:
      summary: Delete max partner documents
      description: Delete multiple documents by IDs.
      tags:
      - Partner
      parameters:
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentsToDeleteSchema'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: deleteMaxPartnerDocuments
      x-operation-id-source: derived
  /max/partner/documents/{id}:
    get:
      summary: Get max partner documents by id
      description: Get url of a document.
      tags:
      - Partner
      parameters:
      - in: path
        name: id
        required: true
        example: aea7dae2-370f-4279-a458-4c7cb9661778
        schema:
          type: string
          format: uuid
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        description: Document identifier
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      responses:
        '200':
          description: A url of a document.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentUrlSchema'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: getMaxPartnerDocumentsById
      x-operation-id-source: derived
  /max/partner/findings:
    get:
      summary: Get max partner findings
      description: Gets findings
      tags:
      - Partner
      parameters:
      - in: query
        name: with_hostname
        required: false
        example: 'true'
        schema:
          type: string
          enum:
          - 'true'
          - 'false'
        description: Set true for findings with hostname
      - in: query
        name: domain
        required: false
        example: securityscorecard.com
        schema:
          type: string
        description: Issue domain filter, accepts single value or comma separated list of domains
      - in: query
        name: hostname_matches
        required: false
        example: 'true'
        schema:
          type: string
          enum:
          - 'true'
          - 'false'
        description: Set true for findings that have matching vendor domain and hostname
      - in: query
        name: max_severity
        required: false
        example: Low
        schema:
          type: string
          enum:
          - Low
          - Medium
          - High
          - Critical
        description: Max Severity filter, accepts single value or comma separated list of max severities
      - in: query
        name: issue_category
        required: false
        example: Suspicious Activity
        schema:
          type: string
        description: Category filter, accepts single value or comma separated list of issue categories
      - in: query
        name: issue_name
        required: false
        example: Typosquat
        schema:
          type: string
        description: Issue type name filter, accepts single value or comma separated list of issue type names
      - in: query
        name: issue_type_key
        required: false
        example: typosquat
        schema:
          type: string
        description: Issue type key filter, accepts single value or comma separated list of issue type keys
      - in: query
        name: hostname
        required: false
        example: securityscorecard.com
        schema:
          type: string
        description: Hostname filter, accepts single value or comma separated list of hostnames
      - in: query
        name: last_seen
        required: false
        example: '{"operator":"gte","value":"2025-01-01"}'
        schema:
          type: string
        description: Last seen filter, accepts stringified object with date value and operator
      - in: query
        name: first_seen
        required: false
        example: '{"operator":"gte","value":"2025-01-01"}'
        schema:
          type: string
        description: First seen filter, accepts stringified object with date value and operator
      - in: query
        name: cve_severity
        required: false
        example: low
        schema:
          type: string
          enum:
          - low
          - medium
          - high
          - critical
        description: CVE severity filter, accepts single value or comma separated list of severities
      - in: query
        name: triaged
        required: false
        example: 'true'
        schema:
          type: string
          enum:
          - 'true'
          - 'false'
        description: Filter findings that are set to be triaged
      - in: query
        name: report
        required: false
        example: 'true'
        schema:
          type: string
          enum:
          - 'true'
          - 'false'
        description: Filter findings that are set to be reported
      - in: query
        name: customer_id
        required: false
        example: aea7dae2-370f-4279-a458-4c7cb9661778
        schema:
          type: string
          format: uuid
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        description: Customer ID filter, accepts single value or comma separated list of customer ids
      - in: query
        name: customer_name
        required: false
        example: SecurityScorecard
        schema:
          type: string
        description: Customer name filter, accepts single value or comma separated list of customer names
      - in: query
        name: customer_domain
        required: false
        example: securityscorecard.com
        schema:
          type: string
        description: Customer domain filter, accepts single value or comma separated list of customer domains
      - in: query
        name: vendor_id
        required: false
        example: aea7dae2-370f-4279-a458-4c7cb9661778
        schema:
          type: string
          format: uuid
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        description: Vendor ID filter, accepts single value or comma separated list of vendor ids
      - in: query
        name: vendor_domain
        required: false
        example: securityscorecard.com
        schema:
          type: string
        description: Vendor domain filter, accepts single value or comma separated list of vendor domains
      - in: query
        name: vendor_name
        required: false
        example: SecurityScorecard
        schema:
          type: string
        description: Vendor name filter, accepts single value or comma separated list of vendor names
      - in: query
        name: published_at
        required: false
        example: '{"operator":"gte","value":"2025-01-01"}'
        schema:
          type: string
        description: Published date filter, accept stringified object with date value and operator
      - in: query
        name: recent_only
        required: false
        example: 'true'
        schema:
          type: string
          enum:
          - 'true'
          - 'false'
        description: Set true to get just recently triaged breaches along with the not triaged ones
      - in: query
        name: search
        required: false
        example: foo bar
        schema:
          type: string
        description: Word or phrase to search records for
      - in: query
        name: sort
        required: false
        example: '[{"id":"vendorName","desc":true}]'
        schema:
          type: string
        description: Sort findings by providing a JSON string representing an array of objects; each object should include "id" for the field to sort by in camelCase and "desc" as a boolean indicating descending (true) or ascending (false) order.
      - in: query
        name: page
        required: false
        schema:
          type: integer
        description: optionally specify which page of results to return
      - in: query
        name: limit
        required: false
        example: 25
        schema:
          type: integer
          maximum: 1500
        description: optionally specify how many results to return, maximum is 1500
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      responses:
        '200':
          description: Findings list for the given filters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FindingsList'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: getMaxPartnerFindings
      x-operation-id-source: derived
    put:
      summary: Update the status of the finding as reported to make it available in the…
      description: ''
      tags:
      - Partner
      parameters:
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFindingsSettings'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      operationId: putMaxPartnerFindings
      x-operation-id-source: derived
  /max/partner/findings/report/{id}:
    get:
      summary: Get max partner findings report by id
      description: Gets the findings for the report having the report id
      tags:
      - Partner
      parameters:
      - in: path
        name: id
        required: true
        example: aea7dae2-370f-4279-a458-4c7cb9661778
        schema:
          type: string
          format: uuid
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        description: Report identifier
      - in: query
        name: with_hostname
        required: false
        example: 'true'
        schema:
          type: string
          enum:
          - 'true'
          - 'false'
        description: Set true for findings with hostname
      - in: query
        name: issue_type_key
        required: false
        example: typosquat
        schema:
          type: string
        description: Issue type key filter, accepts single value or comma separated list of issue type keys
      - in: query
        name: cve_severity
        required: false
        example: low
        schema:
          type: string
          enum:
          - low
          - medium
          - high
          - critical
        description: CVE severity filter, accepts single value or comma separated list of severities
      - in: query
        name: cve_exploited
        required: false
        example: true
        schema:
          type: boolean
        description: True for findings related with a known exploited CVE
      - in: query
        name: page
        required: false
        schema:
          type: integer
        description: optionally specify which page of results to return
      - in: query
        name: limit
        required: false
        example: 25
        schema:
          type: integer
          maximum: 1500
        description: optionally specify how many results to return, maximum is 1500
      - in: query
        name: search
        required: false
        example: foo bar
        schema:
          type: string
        description: Word or phrase to search records for
      - in: query
        name: sort
        required: false
        example: '[{"id":"vendorName","desc":true}]'
        schema:
          type: string
        description: Sort findings by providing a JSON string representing an array of objects; each object should include "id" for the field to sort by in camelCase and "desc" as a boolean indicating descending (true) or ascending (false) order.
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      responses:
        '200':
          description: Report findings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FindingsList'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: getMaxPartnerFindingsReportById
      x-operation-id-source: derived
  /max/partner/indicators:
    get:
      summary: Get max partner indicators
      description: Get list of all issue types
      tags:
      - Partner
      parameters:
      - in: query
        name: search
        required: false
        example: foo bar
        schema:
          type: string
        description: Word or phrase to search records for
      - in: query
        name: sort
        required: false
        example: '[{"id":"name","desc":true}]'
        schema:
          type: string
        description: Sort indicators by providing a JSON string representing an array of objects; each object should include "id" for the field to sort by in camelCase and "desc" as a boolean indicating descending (true) or ascending (false) order.
      - in: query
        name: page
        required: false
        schema:
          type: integer
        description: optionally specify which page of results to return
      - in: query
        name: limit
        required: false
        example: 25
        schema:
          type: integer
          maximum: 1500
        description: optionally specify how many results to return, maximum is 1500
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      responses:
        '200':
          description: A list of all issue types
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndicatorsList'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: getMaxPartnerIndicators
      x-operation-id-source: derived
  /max/partner/indicators/exclusion:
    get:
      summary: Get max partner indicators exclusion
      description: Gets list of indicator exclusion for the current partner
      tags:
      - Partner
      parameters:
      - in: query
        name: scope
        required: false
        schema:
          type: string
        description: Scope filter, it can be partner, vendor or customer, also accepts a comma separated list of the previous values
      - in: query
        name: max_severity
        required: false
        example: Low
        schema:
          type: string
          enum:
          - Low
          - Medium
          - High
          - Critical
        description: Max Severity filter, accepts single value or comma separated list of max severities
      - in: query
        name: issue_category
        required: false
        example: Suspicious Activity
        schema:
          type: string
        description: Category filter, accepts single value or comma separated list of issue categories
      - in: query
        name: issue_type_key
        required: false
        example: typosquat
        schema:
          type: string
        description: Issue type key filter, accepts single value or comma separated list of issue type keys
      - in: query
        name: customer_id
        required: false
        example: aea7dae2-370f-4279-a458-4c7cb9661778
        schema:
          type: string
          format: uuid
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        description: Customer ID filter, accepts single value or comma separated list of customer ids
      - in: query
        name: vendor_id
        required: false
        example: aea7dae2-370f-4279-a458-4c7cb9661778
        schema:
          type: string
          format: uuid
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        description: Vendor ID filter, accepts single value or comma separated list of vendor ids
      - in: query
        name: search
        required: false
        example: foo bar
        schema:
          type: string
        description: Word or phrase to search records for
      - in: query
        name: sort
        required: false
        example: '[{"id":"issueTypeName","desc":true}]'
        schema:
          type: string
        description: Sort excluded indicators by providing a JSON string representing an array of objects; each object should include "id" for the field to sort by in camelCase and "desc" as a boolean indicating descending (true) or ascending (false) order.
      - in: query
        name: page
        required: false
        schema:
          type: integer
        description: optionally specify which page of results to return
      - in: query
        name: limit
        required: false
        example: 25
        schema:
          type: integer
          maximum: 1500
        description: optionally specify how many results to return, maximum is 1500
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      responses:
        '200':
          description: A list of all indicator exclusions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndicatorExclusionList'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: getMaxPartnerIndicatorsExclusion
      x-operation-id-source: derived
  /max/partner/managed-customers:
    get:
      summary: Get max partner managed customers
      description: Get a list of managed customers
      tags:
      - Partner
      parameters:
      - in: query
        name: search
        required: false
        example: '[{"id":"customer_name","type":"like","value":["Amazon"]}]'
        schema:
          type: string
        description: Search managed customers by providing a JSON string that represents an array of objects; each object should include “id” for the field to search, “type” for the matching operator (e.g., “like” or “eq”), and “value” as an array of values to compare.
      - in: query
        name: sort
        required: false
        example: '[{"id":"customer_domain","desc":true}]'
        schema:
          type: string
        description: Sort managed customers by providing a JSON string representing an array of objects; each object should include "id" for the column to sort by and "desc" as a boolean indicating descending (true) or ascending (false) order.
      - in: query
        name: page
        required: false
        schema:
          type: integer
        description: optionally specify which page of results to return
      - in: query
        name: limit
        required: false
        example: 25
        schema:
          type: integer
          maximum: 1500
        description: optionally specify how many results to return, maximum is 1500
      - name: filter
        in: query
        description: Filter managed customers by providing a JSON string that represents an array of objects; each object should include “id” for the field to filter, “type” for the operator (e.g., “like” or “eq”), and “value” as an array of values to compare.
        schema:
          type: string
        example: '[{"id":"customer_name","type":"like","value":["test"]}]'
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      responses:
        '200':
          description: Successful response containing a list of managed customers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedCustomersList'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: getMaxPartnerManagedCustomers
      x-operation-id-source: derived
  /max/partner/managed-customers/updates/{id}:
    put:
      summary: Replace max partner managed customers updates by id
      description: Updates a customer communication
      tags:
      - Partner
      parameters:
      - in: path
        name: id
        required: true
        example: aea7dae2-370f-4279-a458-4c7cb9661778
        schema:
          type: string
          format: uuid
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        description: Unique identifier for the resource
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCustomerUpdate'
        required: true
      responses:
        '201':
          description: ID of the updated managed customer update
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCustomerUpdateSchema'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: putMaxPartnerManagedCustomersUpdatesById
      x-operation-id-source: derived
  /max/partner/managed-customers/{customer_domain}/vendor/{vendor_domain}/reports/likelihood-assessments/{date}:
    get:
      summary: Get max partner managed customers by customer domain vendor by vendor domain…
      description: V2 API to get last Likelihood Assessment Report by scorecard and effective date
      tags:
      - Partner
      parameters:
      - in: path
        name: customer_domain
        required: true
        example: amazon.com
        schema:
          type: string
        description: Scorecard
      - in: path
        name: vendor_domain
        required: true
        example: amazon.com
        schema:
          type: string
        description: Scorecard
      - in: path
        name: date
        required: true
        example: '2020-01-01'
        schema:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}$
        description: The effective date in the format YYYY-MM-DD
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      responses:
        '200':
          description: Likelihood Assessment Summary Report
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LikelihoodAssessmentV2GetResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: getMaxPartnerManagedCustomersByCustomerDomainVendorByVendorDomainReportsLikelihoodAssessmentsByDate
      x-operation-id-source: derived
  /max/partner/managed-customers/{customer_id}:
    get:
      summary: Get max partner managed customers by customer id
      description: Get managed customer detail by id
      tags:
      - Partner
      parameters:
      - in: path
        name: customer_id
        required: true
        example: aea7dae2-370f-4279-a458-4c7cb9661778
        schema:
          type: string
          format: uuid
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        description: Customer identifier
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      responses:
        '200':
          description: Successful response containing data of managed customer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedCustomerSchema'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: getMaxPartnerManagedCustomersByCustomerId
      x-operation-id-source: derived
    delete:
      summary: Remove a managed customer and delete its managed portfolio
      description: ''
      tags:
      - Partner
      parameters:
      - in: path
        name: customer_id
        required: true
        example: aea7dae2-370f-4279-a458-4c7cb9661778
        schema:
          type: string
          format: uuid
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        description: Customer identifier
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      operationId: deleteMaxPartnerManagedCustomersByCustomerId
      x-operation-id-source: derived
  /max/partner/managed-customers/{customer_id}/documents:
    get:
      summary: Get max partner managed customers by customer id documents
      description: Get list of documents related to a customer.
      tags:
      - Partner
      parameters:
      - in: path
        name: customer_id
        required: true
        example: aea7dae2-370f-4279-a458-4c7cb9661778
        schema:
          type: string
          format: uuid
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        description: Customer identifier
      - in: query
        name: filter
        required: false
        example: '[{"operator":"like","id":"filename","value":["filename.csv"],"type":"multiValue"},{"operator":"like","id":"description","value":["Testing description"],"type":"multiValue"},{"operator":"lt","id":"date","value":["2025-01-01"],"type":"date"},{"operator":"like","id":"createdBy","value":["John Does"],"type":"multiValue"},{"operator":"like","id":"associatedVendorIds","value":["securityscorecard.com"],"type":"multiValue"}]'
        schema:
          type: string
        description: Filters to apply to the documents
      - in: query
        name: search
        required: false
        example: foo bar
        schema:
          type: string
        description: Word or phrase to search records for
      - in: query
        name: sort
        required: false
        example: '[{"id":"filename","desc":true}]'
        schema:
          type: string
        description: Sort indicators by providing a JSON string representing an array of objects; each object should include "id" for the field to sort by and "desc" as a boolean indicating descending (true) or ascending (false) order.
      - in: query
        name: page
        required: false
        schema:
          type: integer
        description: optionally specify which page of results to return
      - in: query
        name: limit
        required: false
        example: 25
        schema:
          type: integer
          maximum: 1500
        description: optionally specify how many results to return, maximum is 1500
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      responses:
        '200':
          description: A list of documents for the specified customer.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentsListSchema'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: getMaxPartnerManagedCustomersByCustomerIdDocuments
      x-operation-id-source: derived
  /max/partner/managed-customers/{customer_id}/managed-portfolios:
    get:
      summary: Get max partner managed customers by customer id managed portfolios
      description: Get managed portfolios by customer id
      tags:
      - Partner
      parameters:
      - in: path
        name: customer_id
        required: true
        example: aea7dae2-370f-4279-a458-4c7cb9661778
        schema:
          type: string
          format: uuid
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        description: Customer identifier
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      responses:
        '200':
          description: Successful response containing a list of managed portfolios by customer id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedPortfoliosSchema'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: getMaxPartnerManagedCustomersByCustomerIdManagedPortfolios
      x-operation-id-source: derived
  /max/partner/managed-customers/{customer_id}/updates:
    get:
      summary: Get max partner managed customers by customer id updates
      description: Get updates for a managed customer
      tags:
      - Partner
      parameters:
      - in: path
        name: customer_id
        required: true
        example: aea7dae2-370f-4279-a458-4c7cb9661778
        schema:
          type: string
          format: uuid
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        description: Customer identifier
      - in: query
        name: search
        required: false
        example: '[{"id":"summary","type":"like","value":["test"]}]'
        schema:
          type: string
        description: Search updates by providing a JSON string that represents an array of objects; each object should include “id” for the field to search, “type” for the matching operator (e.g., “like” or “eq”), and “value” as an array of values to compare.
      - in: query
        name: sort
        required: false
        example: '[{"id":"date","desc":true}]'
        schema:
          type: string
        description: Sort updates by providing a JSON string representing an array of objects; each object should include "id" for the column to sort by and "desc" as a boolean indicating descending (true) or ascending (false) order.
      - in: query
        name: page
        required: false
        schema:
          type: integer
        description: optionally specify which page of results to return
      - in: query
        name: limit
        required: false
        example: 25
        schema:
          type: integer
          maximum: 1500
        description: optionally specify how many results to return, maximum is 1500
      - name: filter
        in: query
        description: Filter updates by providing a JSON string that represents an array of objects; each object should include “id” for the field to filter, “type” for the operator (e.g., “like” or “eq”), and “value” as an array of values to compare.
        schema:
          type: string
        example: '[{"id":"summary","type":"like","value":["test"]}]'
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      responses:
        '200':
          description: Successfull response with list of customers updates with their associated shared documents
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerUpdatesList'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: getMaxPartnerManagedCustomersByCustomerIdUpdates
      x-operation-id-source: derived
    post:
      summary: Create max partner managed customers by customer id updates
      description: Create an update for a managed customer
      tags:
      - Partner
      parameters:
      - in: path
        name: customer_id
        required: true
        example: aea7dae2-370f-4279-a458-4c7cb9661778
        schema:
          type: string
          format: uuid
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        description: Customer identifier
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomerUpdate'
        required: true
      responses:
        '201':
          description: ID of the created managed customer update
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCustomerUpdateSchema'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: postMaxPartnerManagedCustomersByCustomerIdUpdates
      x-operation-id-source: derived
    delete:
      summary: Delete updates for a managed customer
      description: ''
      tags:
      - Partner
      parameters:
      - in: path
        name: customer_id
        required: true
        example: aea7dae2-370f-4279-a458-4c7cb9661778
        schema:
          type: string
          format: uuid
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        description: Customer identifier
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteCustomerUpdatesRequest'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      operationId: deleteMaxPartnerManagedCustomersByCustomerIdUpdates
      x-operation-id-source: derived
  /max/partner/managed-customers/{customer_id}/vendors/updates:
    get:
      summary: Get max partner managed customers by customer id vendors updates
      description: Get vendor updates for a managed customer
      tags:
      - Partner
      parameters:
      - in: path
        name: customer_id
        required: true
        example: aea7dae2-370f-4279-a458-4c7cb9661778
        schema:
          type: string
          format: uuid
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        description: Customer identifier
      - in: query
        name: search
        required: false
        example: '[{"id":"summary","type":"like","value":["test"]}]'
        schema:
          type: string
        description: Search updates by providing a JSON string that represents an array of objects; each object should include “id” for the field to search, “type” for the matching operator (e.g., “like” or “eq”), and “value” as an array of values to compare.
      - in: query
        name: sort
        required: false
        example: '[{"id":"escalated_date","desc":true}]'
        schema:
          type: string
        description: Sort vendor updates by providing a JSON string representing an array of objects; each object should include "id" for the column to sort by and "desc" as a boolean indicating descending (true) or ascending (false) order.
      - in: query
        name: page
        required: false
        schema:
          type: integer
        description: optionally specify which page of results to return
      - in: query
        name: limit
        required: false
        example: 25
        schema:
          type: integer
          maximum: 1500
        description: optionally specify how many results to return, maximum is 1500
      - name: filter
        in: query
        description: Filter updates by providing a JSON string that represents an array of objects; each object should include “id” for the field to filter, “type” for the operator (e.g., “like” or “eq”), and “value” as an array of values to compare.
        schema:
          type: string
        example: '[{"id":"summary","type":"like","value":["test"]}]'
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      responses:
        '200':
          description: Successful response with list of vendor updates for a managed customer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VendorUpdatesList'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: getMaxPartnerManagedCustomersByCustomerIdVendorsUpdates
      x-operation-id-source: derived
    delete:
      summary: Delete vendor updates for a managed customer
      description: ''
      tags:
      - Partner
      parameters:
      - in: path
        name: customer_id
        required: true
        example: aea7dae2-370f-4279-a458-4c7cb9661778
        schema:
          type: string
          format: uuid
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        description: Customer identifier
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteVendorUpdatesRequest'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      operationId: deleteMaxPartnerManagedCustomersByCustomerIdVendorsUpdates
      x-operation-id-source: derived
  /max/partner/managed-customers/{customer_id}/vendors/{domain}:
    get:
      summary: Get max partner managed customers by customer id vendors by domain
      description: Get vendor for customer by domain
      tags:
      - Partner
      parameters:
      - in: path
        name: customer_id
        required: true
        example: aea7dae2-370f-4279-a458-4c7cb9661778
        schema:
          type: string
          format: uuid
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        description: Customer identifier
      - in: path
        name: domain
        required: true
        example: securityscorecard.com
        schema:
          type: string
        description: ''
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      responses:
        '200':
          description: Successful response containing data of managed customer vendor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedCustomerVendor'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: getMaxPartnerManagedCustomersByCustomerIdVendorsByDomain
      x-operation-id-source: derived
  /max/partner/managed-customers/{customer_id}/vendors/{domain}/updates:
    post:
      summary: Create max partner managed customers by customer id vendors by domain updates
      description: Create an update for a managed customer vendor
      tags:
      - Partner
      parameters:
      - in: path
        name: customer_id
        required: true
        example: aea7dae2-370f-4279-a458-4c7cb9661778
        schema:
          type: string
          format: uuid
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        description: Customer identifier
      - in: path
        name: domain
        required: true
        example: example.com
        schema:
          type: string
        description: Vendor domain
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateVendorUpdate'
        required: true
      responses:
        '201':
          description: ID of the created managed customer vendor update
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateVendorUpdateSchema'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: postMaxPartnerManagedCustomersByCustomerIdVendorsByDomainUpdates
      x-operation-id-source: derived
  /max/partner/managed-customers/{id}/access:
    get:
      summary: Get max partner managed customers by id access
      description: Gets dashboard access for customer
      tags:
      - Partner
      parameters:
      - in: path
        name: id
        required: true
        example: aea7dae2-370f-4279-a458-4c7cb9661778
        schema:
          type: string
          format: uuid
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        description: Organization identifier
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      responses:
        '200':
          description: Dashboard access settings for customer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerAccess'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: getMaxPartnerManagedCustomersByIdAccess
      x-operation-id-source: derived
    post:
      summary: Update the access for the organization
      description: ''
      tags:
      - Partner
      parameters:
      - in: path
        name: id
        required: true
        example: aea7dae2-370f-4279-a458-4c7cb9661778
        schema:
          type: string
          format: uuid
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        description: Organization identifier
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCustomerAccess'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      operationId: postMaxPartnerManagedCustomersByIdAccess
      x-operation-id-source: derived
  /max/partner/managed-customers/{id}/users:
    get:
      summary: Get max partner managed customers by id users
      description: Gets dashboard access for customer users
      tags:
      - Partner
      parameters:
      - in: path
        name: id
        required: true
        example: aea7dae2-370f-4279-a458-4c7cb9661778
        schema:
          type: string
          format: uuid
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        description: Organization identifier
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      responses:
        '200':
          description: Dashboard access settings for customer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerUserList'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: getMaxPartnerManagedCustomersByIdUsers
      x-operation-id-source: derived
  /max/partner/management-requests:
    post:
      summary: Create max partner management requests
      description: Creates new management request for a customer
      tags:
      - Partner
      parameters:
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateManagementRequest'
        required: true
      responses:
        '201':
          description: id of the created request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateManagementRequestSchema'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: postMaxPartnerManagementRequests
      x-operation-id-source: derived
  /max/partner/reports:
    get:
      summary: Get max partner reports
      description: Get a list of generated reports
      tags:
      - Partner
      parameters:
      - in: query
        name: search
        required: false
        example: foo bar
        schema:
          type: string
        description: Word or phrase to search records for
      - in: query
        name: sort
        required: false
        example: '[{"id":"name","desc":true}]'
        schema:
          type: string
        description: Sort reports by providing a JSON string representing an array of objects; each object should include "id" for the column to sort by and "desc" as a boolean indicating descending (true) or ascending (false) order.
      - in: query
        name: page
        required: false
        schema:
          type: integer
        description: optionally specify which page of results to return
      - in: query
        name: limit
        required: false
        example: 25
        schema:
          type: integer
          maximum: 1500
        description: optionally specify how many results to return, maximum is 1500
      - in: query
        name: filter
        required: false
        example: '[{"operator":"eq","id":"customer_name","value":["example.com"],"type":"multiValue"}]'
        schema:
          type: string
        description: 'Used to filter report data by applying one or more conditions. Accepts a URL-encoded JSON array where each object defines a filter with keys: ''operator'', ''id'', ''value'', and ''type''. For example, to filterreports by a specific customer name, use an object like {"operator": "eq", "id": "customer_name", "value": ["example.com"], "type": "multiValue"}.'
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      responses:
        '200':
          description: Successful response containing a list of generated reports for managed services
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportsSchema'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: getMaxPartnerReports
      x-operation-id-source: derived
  /max/partner/reports/bulk-delete:
    delete:
      summary: Delete max partner reports bulk delete
      description: Bulk delete reports for specific IDs
      tags:
      - Partner
      parameters:
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteReportsBulkSchema'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: deleteMaxPartnerReportsBulkDelete
      x-operation-id-source: derived
  /max/partner/reports/likelihood-assessments:
    post:
      summary: Create max partner reports likelihood assessments
      description: Post a request for the creation of Likelihood Assessment Reports providing a list of scorecards
      tags:
      - Partner
      parameters:
      - in: query
        name: date_from
        required: true
        example: '2020-01-01'
        schema:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}$
        description: Effective start date in the format YYYY-MM-DD
      - in: query
        name: date_to
        required: true
        example: '2020-01-01'
        schema:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}$
        description: Effective end date in the format YYYY-MM-DD
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LikelihoodAssessmentBulkPostRequest'
        required: true
      responses:
        '201':
          description: Data was stored successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LikelihoodAssessmentV2PostResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: postMaxPartnerReportsLikelihoodAssessments
      x-operation-id-source: derived
  /max/partner/reports/likelihood-assessments/logs:
    get:
      summary: Get max partner reports likelihood assessments logs
      description: Retrieves bulk logs for likelihood assessment reports associated with the authenticated partner organization
      tags:
      - Partner
      parameters:
      - in: query
        name: managed_customer
        required: false
        example: example.com
        schema:
          type: string
        description: Customer scorecard domain
      - in: query
        name: vendor
        required: false
        example: example.com
        schema:
          type: string
        description: Vendor scorecard domain
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      responses:
        '200':
          description: Logs for the bulk generation for likelihood-assessment reports
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LikelihoodAssessmentBulkPartnerLogs'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: getMaxPartnerReportsLikelihoodAssessmentsLogs
      x-operation-id-source: derived
  /max/partner/reports/managed-customers:
    get:
      summary: Get max partner reports managed customers
      description: Get a list of customers from the generated reports
      tags:
      - Partner
      parameters:
      - in: query
        name: search
        required: false
        example: Amazon
        schema:
          type: string
        description: Search text to look into customer name or domain
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      responses:
        '200':
          description: Successful response containing a list of searched customers from the generated reports
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportsCustomersSchema'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: getMaxPartnerReportsManagedCustomers
      x-operation-id-source: derived
  /max/partner/reports/remediation-plans:
    get:
      summary: Get max partner reports remediation plans
      description: Get list of managed action plans for all vendors
      tags:
      - Partner
      parameters:
      - name: filter
        in: query
        description: Filter action plans by specific criteria. The filter should be a JSON string that contains an array of objects, each representing a filter condition.
        schema:
          type: string
        example: '[{"operator":"like","id":"managed_scorecard","value":["securityscorecard.com"],"type":"multiValue"},{"operator":"eq","id":"is_customer","value":[true],"type":"boolean"}]'
      - in: query
        name: search
        required: false
        example: '[{"id":"name","value":"test"}]'
        schema:
          type: string
        description: 'Search remediation plans by providing a JSON string that represents an array of objects; each object should include “id” for the field to search and “value” as the term to match. For example, to search plans by name, use { "id": "name", "value": "test" }.'
      - in: query
        name: sort
        required: false
        example: '[{"id":"name","desc":true}]'
        schema:
          type: string
        description: Sort remediation plans by providing a JSON string representing an array of objects; each object should include "id" for the column to sort by and "desc" as a boolean indicating descending (true) or ascending (false) order.
      - in: query
        name: page
        required: false
        schema:
          type: integer
        description: optionally specify which page of results to return
      - in: query
        name: limit
        required: false
        example: 25
        schema:
          type: integer
          maximum: 1500
        description: optionally specify how many results to return, maximum is 1500
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      responses:
        '200':
          description: A list of action plans visible by the user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionPlansList'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: getMaxPartnerReportsRemediationPlans
      x-operation-id-source: derived
  /max/partner/reports/vendors:
    get:
      summary: Get max partner reports vendors
      description: Get a list of vendors from the generated reports
      tags:
      - Partner
      parameters:
      - in: query
        name: search
        required: false
        example: Amazon
        schema:
          type: string
        description: Search text to look into vendor name or domain
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      responses:
        '200':
          description: Successful response containing a list of searched vendors from the generated reports
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportsVendorsSchema'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: getMaxPartnerReportsVendors
      x-operation-id-source: derived
  /max/partner/unmanaged-customers:
    get:
      summary: Get max partner unmanaged customers
      description: Get a list of unmanaged customers
      tags:
      - Partner
      parameters:
      - in: query
        name: search
        required: false
        example: '[{"id":"customer_name","type":"like","value":["Amazon"]}]'
        schema:
          type: string
        description: Search unmanaged customers by providing a JSON string that represents an array of objects; each object should include “id” for the field to search, “type” for the matching operator (e.g., “like” or “eq”), and “value” as an array of values to compare.
      - in: query
        name: sort
        required: false
        example: '[{"id":"customer_domain","desc":true}]'
        schema:
          type: string
        description: Sort unmanaged customers by providing a JSON string representing an array of objects; each object should include "id" for the column to sort by and "desc" as a boolean indicating descending (true) or ascending (false) order.
      - in: query
        name: page
        required: false
        schema:
          type: integer
        description: optionally specify which page of results to return
      - in: query
        name: limit
        required: false
        example: 25
        schema:
          type: integer
          maximum: 1500
        description: optionally specify how many results to return, maximum is 1500
      - name: filter
        in: query
        description: Filter unmanaged customers by providing a JSON string that represents an array of objects; each object should include “id” for the field to filter, “type” for the operator (e.g., “like” or “eq”), and “value” as an array of values to compare.
        schema:
          type: string
        example: '[{"id":"customer_name","type":"like","value":["test"]}]'
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      responses:
        '200':
          description: Successful response containing a list of unmanaged customers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnmanagedCustomersList'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: getMaxPartnerUnmanagedCustomers
      x-operation-id-source: derived
  /max/partner/vendor-onboarding/add-vendor-domains/{domain_or_portfolio_id}:
    post:
      summary: Create max partner vendor onboarding add vendor domains by domain or portfolio…
      description: Add vendor domains via JSON
      tags:
      - Partner
      parameters:
      - in: path
        name: domain_or_portfolio_id
        required: true
        example: securityscorecard.com
        schema:
          type: string
        description: Portfolio or domain identifier
      - in: query
        name: local_portfolio_id
        required: false
        schema:
          type: string
        description: Local portfolio identifier
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UploadVendorDomainsRequest'
        required: true
      responses:
        '200':
          description: Add vendor domains result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddVendorDomainsResult'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: postMaxPartnerVendorOnboardingAddVendorDomainsByDomainOrPortfolioId
      x-operation-id-source: derived
    put:
      summary: Replace max partner vendor onboarding add vendor domains by domain or portfolio…
      description: Add vendor domains via CSV upload
      tags:
      - Partner
      parameters:
      - in: path
        name: domain_or_portfolio_id
        required: true
        example: securityscorecard.com
        schema:
          type: string
        description: Portfolio or domain identifier
      - in: query
        name: local_portfolio_id
        required: false
        schema:
          type: string
        description: Local portfolio identifier
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UploadVendorDomainsFileRequest'
        required: true
      responses:
        '200':
          description: Vendor domains uploaded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddVendorDomainsResult'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: putMaxPartnerVendorOnboardingAddVendorDomainsByDomainOrPortfolioId
      x-operation-id-source: derived
  /max/partner/vendor-onboarding/negotiate-vendor-list:
    post:
      summary: Create max partner vendor onboarding negotiate vendor list
      description: Upload vendor list for negotiation
      tags:
      - Partner
      parameters:
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NegotiateVendorListRequest'
        required: true
      responses:
        '200':
          description: Vendor negotiation result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UploadJsonNegotiateVendorListSchema'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: postMaxPartnerVendorOnboardingNegotiateVendorList
      x-operation-id-source: derived
    put:
      summary: Replace max partner vendor onboarding negotiate vendor list
      description: Upload vendor list for negotiation
      tags:
      - Partner
      parameters:
      - in: query
        name: with_hierarchy
        required: false
        schema:
          type: boolean
        description: Includes hierarchy data about found scorecards
      - in: query
        name: has_header
        required: false
        schema:
          type: boolean
        description: Ignores the first row in case the file contains a header
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/NegotiateVendorListFileRequest'
        required: true
      responses:
        '200':
          description: Vendor negotiation result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UploadJsonNegotiateVendorListSchema'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: putMaxPartnerVendorOnboardingNegotiateVendorList
      x-operation-id-source: derived
  /max/partner/vendors:
    get:
      summary: Get max partner vendors
      description: Get all customers' vendors for current partner
      tags:
      - Partner
      parameters:
      - in: query
        name: search
        required: false
        example: ''
        schema:
          type: string
        description: Search text to look for vendor name, vendor domain or customer name.
      - in: query
        name: sort
        required: false
        example: '[{"id":"tier","desc":true}]'
        schema:
          type: string
        description: Sort vendors by providing a JSON string representing an array of objects; each object should include "id" for the column to sort by and "desc" as a boolean indicating descending (true) or ascending (false) order.
      - in: query
        name: page
        required: false
        schema:
          type: integer
        description: optionally specify which page of results to return
      - in: query
        name: limit
        required: false
        example: 25
        schema:
          type: integer
          maximum: 1500
        description: optionally specify how many results to return, maximum is 1500
      - in: query
        name: vendor_name
        required: false
        schema:
          type: string
        description: Vendor name filter, accepts single value or comma separated list of vendor names.
      - in: query
        name: customer_name
        required: false
        schema:
          type: string
        description: Customer name filter, accepts single value or comma separated list of customer names.
      - in: query
        name: tier
        required: false
        example: platinum, gold, silver
        schema:
          type: string
        description: Tier filter, accepts single value or comma separated list of tiers.
      - in: query
        name: lifecycle
        required: false
        example: assess, monitor, respond, maintain
        schema:
          type: string
        description: Lifecycle filter, accepts single value or comma separated list of lifecycle values.
      - in: query
        name: status
        required: false
        example: ok, at_significant_risk, needs_attention, risk_escalating, active_breach
        schema:
          type: string
        description: Status filter, accepts single value or comma separated list of status values.
      - in: query
        name: incident_likelihood
        required: false
        example: none, low, medium, high, critical
        schema:
          type: string
        description: Incident likelihood filter, accepts single value or comma separated list of values.
      - in: query
        name: business_impact
        required: false
        example: none, low, medium, high, critical
        schema:
          type: string
        description: Business impact filter, accepts single value or comma separated list of business impact values.
      - in: query
        name: incident_likelihood_trend
        required: false
        example: doing_well, improved, did_not_improve, worsened, only_once
        schema:
          type: string
        description: Incident likelihood trend filter, accepts single value or comma separated list of values.
      - in: query
        name: initial_assessment
        required: false
        example: none, low, medium, high, critical
        schema:
          type: string
        description: Initial assessment filter, accepts single value or comma separated list of values.
      - in: query
        name: previous_assessment
        required: false
        example: none, low, medium, high, critical
        schema:
          type: string
        description: Previous assessment filter, accepts single value or comma separated list of values.
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      responses:
        '200':
          description: Successful response containing a list of vendors for current partner
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VendorsList'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: getMaxPartnerVendors
      x-operation-id-source: derived
    delete:
      summary: Delete max partner vendors
      description: Removes vendors from the managed portfolios
      tags:
      - Partner
      parameters:
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemoveVendorsSchema'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: deleteMaxPartnerVendors
      x-operation-id-source: derived
  /max/partner/vendors/statuses:
    put:
      summary: Replace max partner vendors statuses
      description: Set tags and statuses for customers vendors by domains
      tags:
      - Partner
      parameters:
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateVendorsStatusesRequest'
        required: true
      responses:
        '200':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: putMaxPartnerVendorsStatuses
      x-operation-id-source: derived
  /max/partner/vendors/updates/{id}:
    put:
      summary: Replace max partner vendors updates by id
      description: Update a communication for a managed customers vendor
      tags:
      - Partner
      parameters:
      - in: path
        name: id
        required: true
        example: aea7dae2-370f-4279-a458-4c7cb9661778
        schema:
          type: string
          format: uuid
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        description: Unique identifier for the resource
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateVendorUpdate'
        required: true
      responses:
        '201':
          description: ID of the updated managed customer vendor update
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateVendorUpdateSchema'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: putMaxPartnerVendorsUpdatesById
      x-operation-id-source: derived
  /max/partner/vendors/{domain}/managed-customers:
    get:
      summary: Get max partner vendors by domain managed customers
      description: Get all customers associated with a vendor that is part of a managed portfolio
      tags:
      - Partner
      parameters:
      - in: path
        name: domain
        required: true
        example: example.com
        schema:
          type: string
        description: Vendor domain
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      responses:
        '200':
          description: Customers associated with a vendor that is part of a managed portfolio
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomersByVendorSchema'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: getMaxPartnerVendorsByDomainManagedCustomers
      x-operation-id-source: derived
  /max/partner/{customer_id}/vendors-improvements:
    get:
      summary: Get max partner by customer id vendors improvements
      description: Returns the customer vendors grouped by their status on vendor improvement
      tags:
      - Partner
      parameters:
      - in: path
        name: customer_id
        required: true
        example: aea7dae2-370f-4279-a458-4c7cb9661778
        schema:
          type: string
          format: uuid
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        description: Customer identifier
      - name: version
        in: header
        schema:
          type: string
          example: beta
        description: API version header
      responses:
        '200':
          description: Customer vendors grouped by their status on vendor improvement
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerVendorsTrends'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRateLimit'
      x-summary-source: derived
      operationId: getMaxPartnerByCustomerIdVendorsImprovements
      x-operation-id-source: derived
components:
  schemas:
    ManagedCustomersList:
      type: object
      additionalProperties: false
      properties:
        entries:
          type: array
          description: A list of managed customers
          items:
            description: A managed customer
            allOf:
            - type: object
              description: A customer
              properties:
                customer_id:
                  example: aea7dae2-370f-4279-a458-4c7cb9661778
                  pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
                  description: Identifier
                  type: string
                customer_name:
                  example: SecurityScorecard
                  type: string
                customer_domain:
                  example: securityscorecard.com
                  type: string
              required:
              - customer_id
              - customer_name
              - customer_domain
            - type: object
              properties:
                customer_id:
                  example: aea7dae2-370f-4279-a458-4c7cb9661778
                  pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
                  description: Identifier
                  type: string
                customer_name:
                  example: SecurityScorecard
                  type: string
                customer_domain:
                  example: securityscorecard.com
                  type: string
                managed_vendors:
                  type: number
                available_slots:
                  type: number
                last_update_sent:
                  type: string
                engagement_active_breach:
                  type: number
                engagement_risk_escalating:
                  type: number
                engagement_needs_attention:
                  type: number
                engagement_trending_down:
                  type: number
                engagement_ok:
                  type: number
                request_status:
                  type: string
              required:
              - request_status
        total:
          description: The total number of records matching the given query
          example: 999
          type: integer
      required:
      - entries
      - total
    CreateManagementRequestSchema:
      type: object
      properties:
        id:
          example: aea7dae2-370f-4279-a458-4c7cb9661778
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          description: Management request identifier
          type: string
      required:
      - id
    UpdateVendorsStatusesRequest:
      type: object
      description: settings for tags and statuses for vendors
      properties:
        vendors:
          type: array
          items:
            type: object
            properties:
              domain:
                example: securityscorecard.com
                type: string
              customer_id:
                example: aea7dae2-370f-4279-a458-4c7cb9661778
                pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
                description: Identifier
                type: string
            required:
            - domain
            - customer_id
        custom_tags:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
            required:
            - name
        business_impact:
          type: string
        incident_likelihood:
          type: string
        engagement:
          type: string
        lifecycle:
          type: string
        tier:
          type: string
        assessment_scheduled_at:
          example: '2020-01-01T00:00:00.000Z'
          format: date-time
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}[0-9]*Z$
      required:
      - vendors
    UnmanagedCustomersList:
      type: object
      additionalProperties: false
      properties:
        entries:
          type: array
          description: A list of unmanaged customers
          items:
            type: object
            description: An unmanaged customer
            properties:
              customer_id:
                example: aea7dae2-370f-4279-a458-4c7cb9661778
                pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
                description: Identifier
                type: string
              customer_name:
                example: SecurityScorecard
                type: string
              customer_domain:
                example: securityscorecard.com
                type: string
              managed:
                type: boolean
                example: false
            required:
            - customer_id
            - customer_name
            - customer_domain
            - managed
        total:
          description: The total number of records matching the given query
          example: 999
          type: integer
      required:
      - entries
      - total
    DeleteVendorUpdatesRequest:
      type: object
      properties:
        ids:
          type: array
          items:
            example: aea7dae2-370f-4279-a458-4c7cb9661778
            pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
            description: Vendor update identifier
            type: string
      required:
      - ids
      description: Array of vendor update ids to remove
    LikelihoodAssessmentV2PostResponse:
      type: object
      properties:
        managed_customer_scorecards:
          type: array
          items:
            type: object
            properties:
              managed_customer:
                type: string
              scorecard:
                type: string
            required:
            - managed_customer
            - scorecard
        vendors_not_managed:
          type: array
          items:
            type: string
        customers_not_managed:
          type: array
          items:
            type: string
        request_id:
          example: aea7dae2-370f-4279-a458-4c7cb9661778
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          description: Unique identifier for the created request
          type: string
      required:
      - managed_customer_scorecards
      - vendors_not_managed
      - customers_not_managed
      - request_id
    CreateManagementRequest:
      type: object
      properties:
        customer_id:
          example: aea7dae2-370f-4279-a458-4c7cb9661778
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          description: Identifier
          type: string
        email:
          example: johndoe@securityscorecard.io
          type: string
        first_name:
          example: John
          type: string
        last_name:
          example: Doe
          type: string
      required:
      - customer_id
      - email
      - first_name
      - last_name
      description: request to add a managed customer
    LikelihoodAssessmentBulkPartnerLogs:
      type: object
      properties:
        partner:
          type: string
          description: The partner id
        progress:
          type: object
          description: Progress of the request
          properties:
            completed:
              type: integer
              minimum: 0
              description: amount of completed tasks
            failed:
              type: integer
              minimum: 0
              description: amount of failed tasks
            total:
              type: integer
              minimum: 0
              description: total amount of tasks
            percentage:
              type: number
              description: percentage of completed tasks
              minimum: 0
              maximum: 100
          required:
          - completed
          - failed
          - total
      required:
      - progress
    ErrorBadRequest:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              description: Human readable message, suitable for showing in some UI
              type: string
            statusCode:
              type: integer
              default: 400
          required:
          - message
          - statusCode
    CreateVendorUpdate:
      type: object
      description: Settings for creating a new vendor update, including metadata fields required for submission
      properties:
        summary:
          type: string
          description: A brief summary of the vendor update
        escalated_date:
          example: '2020-01-01T00:00:00.000Z'
          format: date-time
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}[0-9]*Z$
          description: The date and time when this update was escalated
        priority:
          type: string
          description: Priority level of the vendor update
        responsive:
          type: boolean
          description: Indicates whether the vendor has responded to this update
        action_needed:
          type: boolean
          description: Indicates if any further action is required
      required:
      - summary
      - escalated_date
      - priority
      - responsive
      - action_needed
    UpdateBreachesSettings:
      type: object
      properties:
        breaches:
          type: array
          items:
            type: object
            properties:
              breach_id:
                type: string
                format: uuid
                description: id(issueId) of the breach for which the report status needs to be updated
              vendor_id:
                type: string
                format: uuid
                description: id of the vendor associated with the breach for which the report status needs to be updated
              report:
                type: boolean
                description: if true the breach/breaches will be used for the likelihood report generation
              triaged:
                type: boolean
                description: if true the breach/breaches is considered triaged
            required:
            - breach_id
            - vendor_id
            - report
            - triaged
      required:
      - breaches
      description: Array of breach ids/id and the vendor ids which needs to be marked as reported
    ActionPlansList:
      type: object
      additionalProperties: false
      properties:
        entries:
          type: array
          items:
            type: object
            properties:
              id:
                example: aea7dae2-370f-4279-a458-4c7cb9661778
                pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
                description: action plan identifier
                type: string
              remediation_version:
                type: string
              roles:
                type: array
                items:
                  type: string
              name:
                type: string
                description: action plan name
                example: Example action plan
              description:
                type: string
                description: description
                example: Example description
              due_date:
                anyOf:
                - example: '2020-01-01T00:00:00.000Z'
                  format: date-time
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}[0-9]*Z$
                - type: string
                  maxLength: 0
                  example: ''
                description: due date
              scorecard:
                description: scorecard identifier
                example: example.com
                type: string
                anyOf:
                - example: example.com
                  type: string
                  description: primary domain of the company
                - example: aea7dae2-370f-4279-a458-4c7cb9661778
                  pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
                  description: Identifier
                  type: string
              guests:
                type: array
                items:
                  type: string
                description: list of emails of guest users
              editors:
                type: array
                items:
                  type: string
                description: list of emails of editors
              created_by:
                type: string
                example: user@example.com
                description: user who created the object
              created_at:
                example: '2020-01-01T00:00:00.000Z'
                format: date-time
                type: string
                pattern: ^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}[0-9]*Z$
                description: created date
              updated_by:
                type: string
                example: user@example.com
                description: user who updated the object
              updated_at:
                example: '2020-01-01T00:00:00.000Z'
                format: date-time
                type: string
                pattern: ^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}[0-9]*Z$
                description: created date
              type:
                type: string
                description: action plan type
                example: overall_score_improvement
                enum:
                - overall_score_improvement
                - remediation
                - issue_resolution
                - factor_score_improvement
              status:
                type: string
                description: action plan status
                example: active
                enum:
                - active
                - completed
              organization_domain:
                example: example.com
                type: string
                description: primary domain of the company
              archived_at:
                anyOf:
                - example: '2020-01-01T00:00:00.000Z'
                  format: date-time
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}[0-9]*Z$
                - type: string
                  maxLength: 0
                  example: ''
                description: archived date
              synchronized_at:
                anyOf:
                - example: '2020-01-01T00:00:00.000Z'
                  format: date-time
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}[0-9]*Z$
                - type: string
                  maxLength: 0
                  example: ''
                description: synchronized date
              is_custom_scorecard:
                type: boolean
                description: true if this action plan is based on a custom scorecard, false otherwise
              company_name:
                example: Example Ltd.
                type: string
              company_score:
                type: integer
                description: security score from 0 to 100
                example: 95
              factor_scores:
                type: array
                items:
                  type: object
                  properties:
                    factor:
                      type: string
                      description: factor name/id
                      example: network_security
                    score:
                      type: integer
                      description: security score from 0 to 100
                      example: 95
                  additionalProperties: false
              target:
                type: object
                properties:
                  factor_score_targets:
                    type: array
                    items:
                      type: object
                      properties:
                        factor:
                          type: string
                          description: factor name/id
                          example: network_security
                        score:
                          type: integer
                          description: security score from 0 to 100
                          example: 95
                      additionalProperties: false
                  overall_score:
                    type: number
                    description: overall score of the action plan if applies
                    example: 90
              criteria:
                type: object
                properties:
                  factors:
                    type: array
                    items:
                      type: string
                      description: factor name/id
                      example: network_security
                    description: factors associated to the action plan if applies
                  issues:
                    type: array
                    items:
                      description: issue type (permanent key)
                      type: string
                      example: cookie_secure_flag
                    description: issues associated to the action plan if applies
              is_managed:
                type: boolean
              is_published:
                type: boolean
              managed_scorecard:
                type: string
              total_issues:
                type: number
                example: 36
                description: number of issues associated to the action plan
              closed_issues:
                type: number
                example: 0
                description: number of closed issues associated to the action plan
              progress:
                type: number
                example: 0
                description: percentage of progress
        size:
          description: The number of records to be returned per page
          example: 100
          type: integer
        page:
          description: The page number to be returned
          example: 1
          type: integer
        total:
          description: The total number of records matching the given query
          example: 999
          type: integer
      required:
      - entries
      - size
      - page
      - total
    CreateCustomerUpdateSchema:
      type: object
      properties:
        id:
          example: aea7dae2-370f-4279-a458-4c7cb9661778
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          description: Customer update identifier
          type: string
      required:
      - id
    CustomersByVendorSchema:
      description: List of customers associated with a vendor that is part of a managed portfolio
      type: object
      properties:
        entries:
          type: array
          description: Array of customer objects
          items:
            type: object
            description: Represents customers associated with a vendor that is part of a managed portfolio
            properties:
              customer_id:
                type: string
                description: Unique identifier of the customer
              customer_name:
                type: string
                description: Customer name
              customer_domain:
                type: string
                description: Customer domain
            required:
            - customer_id
            - customer_name
            - customer_domain
      required:
      - entries
    UploadJsonNegotiateVendorListSchema:
      type: object
      description: a list of vendors
      properties:
        scorecards:
          type: array
          items:
            type: object
            description: Result of vendor negociation - scorecard found
            properties:
              domain:
                example: securityscorecard.com
                type: string
              id:
                example: aea7dae2-370f-4279-a458-4c7cb9661778
                pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
                description: Identifier
                type: string
              original_query:
                type: string
              hierarchy:
                type: array
                items:
                  type: object
                  description: Vendor negotiation hierarchy node, outline relationships between companies
                  properties:
                    industry:
                      type: string
                    domain:
                      example: securityscorecard.com
                      type: string
                    name:
                      example: SecurityScorecard
                      type: string
                    hierarchy:
                      properties:
                        parent_domain:
                          example: securityscorecard.com
                          type: string
                        root_domain:
                          example: securityscorecard.com
                          type: string
              reason:
                type: string
              confidence:
                type: number
            required:
            - domain
            - original_query
            - confidence
        not_found:
          type: array
          items:
            type: object
            description: Result of vendor negociation - scorecard not found
            properties:
              order:
                type: number
              attempts:
                type: array
                items:
                  type: object
                  description: not found scorecard attempt
                  properties:
                    query:
                      type: string
                    reason:
                      type: string
                    attempt:
                      type: number
                    category:
                      type: string
            required:
            - attempts
      required:
      - scorecards
      - not_found
    DocumentsListSchema:
      type: object
      additionalProperties: false
      properties:
        entries:
          type: array
          description: A list of documents for the specified customer.
          items:
            type: object
            description: Document
            properties:
              id:
                type: string
                format: uuid
              customerId:
                type: string
                format: uuid
              filename:
                type: string
              description:
                type: string
              createdAt:
                type: string
                format: date-time
              createdBy:
                type: string
              associatedVendorIds:
                type: array
                items:
                  type: string
            required:
            - id
            - filename
        total:
          description: The total number of records matching the given query
          example: 999
          type: integer
      required:
      - entries
      - total
    ErrorRateLimit:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              description: Human readable message, suitable for showing in some UI
              type: string
            statusCode:
              type: integer
              default: 429
          required:
          - message
          - statusCode
    NegotiateVendorListRequest:
      type: object
      properties:
        with_hierarchy:
          type: boolean
          description: includes hierarchy data about found scorecards
        queries:
          description: collection of domain queries
          type: array
          items:
            type: string
      required:
      - queries
      description: settings and attachments for the vendor update
    FindingsList:
      type: object
      additionalProperties: false
      properties:
        entries:
          type: array
          items:
            allOf:
            - type: object
              properties:
                vendor_id:
                  example: aea7dae2-370f-4279-a458-4c7cb9661778
                  pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
                  description: vendor identifier
                  type: string
                vendor_domain:
                  example: securityscorecard.com
                  type: string
                  description: domain of the vendor
                vendor_name:
                  type: string
                  description: name of the vendor
                  example: SecurityScorecard
                customers:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        example: aea7dae2-370f-4279-a458-4c7cb9661778
                        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
                        description: id of the customer
                        type: string
                      domain:
                        example: securityscorecard.com
                        type: string
                        description: domain of the customer
                      name:
                        example: SecurityScorecard
                        type: string
                        description: name of the customer
                    required:
                    - id
                    - domain
                    - name
                report:
                  type: boolean
                  description: is reported
                triaged:
                  type: boolean
                  description: is triaged
                is_active_breach:
                  type: boolean
                  description: vendor has breach
                edited_at:
                  example: '2020-01-01T00:00:00.000Z'
                  type: string
                  pattern: ^(?:\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}\d*Z)?$
                  description: last edition of report or trigger fields
              required:
              - vendor_id
              - vendor_domain
              - vendor_name
              - customers
              - report
              - triaged
              - is_active_breach
              - edited_at
            - type: object
              properties:
                description:
                  type: string
                  description: description of the finding
                finding_id:
                  example: aea7dae2-370f-4279-a458-4c7cb9661778
                  pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
                  description: an uuid of an existing finding
                  type: string
                information:
                  type: array
                  description: Finding information of the finding
                  items:
                    type: object
                    properties:
                      title:
                        type: string
                        description: Title of the field
                      value:
                        type: string
                        description: value of the field
                    required:
                    - title
                    - value
                extra_information:
                  type: array
                  description: extra information fields with not empty value
                  items:
                    type: object
                    properties:
                      title:
                        type: string
                        description: Title of the field
                      value:
                        type: string
                        description: value of the field
                    required:
                    - title
                    - value
                first_observed_at:
                  example: '2020-01-01T00:00:00.000Z'
                  format: date-time
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}[0-9]*Z$
                  description: first observed date time
                last_observed_at:
                  example: '2020-01-01T00:00:00.000Z'
                  format: date-time
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}[0-9]*Z$
                  description: last observed date time
                issue_name:
                  type: string
                  description: Issue Name
                issue_type:
                  type: string
                  description: Issue Type
                category:
                  type: string
                  description: Max Finding category
                max_severity:
                  type: string
                  description: Max severity
                breach_risk:
                  type: string
                  description: Breach risk
                threat_level:
                  type: string
                  description: Threat level
                hostname:
                  type: string
                  description: Asset hostname
                ip_address:
                  type: string
                  description: the asset IP address
                product_name:
                  type: string
                  description: Product Name
                product_version:
                  type: string
                  description: Product Version
                port:
                  type: number
                  description: Port number
                cve:
                  type: object
                  description: CVE information
                  properties:
                    id:
                      type: string
                      description: CVE ID
                    known_exploit:
                      type: boolean
                      description: true if it is known the CVE was exploited
                    last_modified_date:
                      example: '2020-01-01T00:00:00.000Z'
                      format: date-time
                      type: string
                      pattern: ^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}[0-9]*Z$
                      description: Last modified date
                    severity:
                      type: string
                      description: Nvd severity
                    score:
                      type: number
                      description: Nvd score
                    description:
                      type: string
                      description: CVE description
                  required:
                  - id
                  - known_exploit
                  - last_modified_date
                  - severity
                  - score
                  - description
                malware:
                  type: object
                  description: Malware information
                  properties:
                    family:
                      type: string
                      description: Malware family
                    detection_method:
                      type: string
                      description: Malware Detection Methods
                  required:
                  - family
                  - detection_method
                last_breach:
                  type: object
                  description: Last breach information
                  properties:
                    description:
                      type: string
                      description: Breach description
                    source_type:
                      type: string
                      description: Source type
                    news_source:
                      type: string
                      description: Source url (news)
                    source:
                      type: string
                      description: Source url (official)
                    published_at:
                      type: string
                      format: date
                      example: '2020-01-01'
                      pattern: ^\d{4}-\d{2}-\d{2}$
                      description: Breach published date
                  required:
                  - description
                  - published_at
              required:
              - max_severity
              - category
              - issue_type
              - issue_name
              - last_observed_at
              - first_observed_at
              - information
              - finding_id
              - description
        size:
          description: The number of records to be returned per page
          example: 100
          type: integer
        page:
          description: The page number to be returned
          example: 1
          type: integer
        total:
          description: The total number of records matching the given query
          example: 999
          type: integer
      required:
      - entries
      - size
      - page
      - total
    AddVendorDomainsResult:
      type: object
      description: Vendor risk profiles for uploaded domains
      properties:
        customer_id:
          example: aea7dae2-370f-4279-a458-4c7cb9661778
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          description: Identifier
          type: string
        managed_portfolio_id:
          example: aea7dae2-370f-4279-a458-4c7cb9661778
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          description: Identifier
          type: string
        local_portfolio_ids:
          type: array
          items:
            example: aea7dae2-370f-4279-a458-4c7cb9661778
            pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
            description: Identifier
            type: string
        added_vendors:
          type: array
          items:
            type: object
            description: Vendor risk profile information
            properties:
              domain:
                example: securityscorecard.com
                type: string
              company_name:
                example: SecurityScorecard
                type: string
              business_impact:
                type: string
                description: The effect a vendor breach would have on the organization.
              tier:
                type: string
                description: The level of service provided for the vendor.
              custom_tags:
                type: array
                items:
                  type: string
                description: Extra tags to label and organize the vendor.
              incident_likelihood:
                type: string
                description: The chance of the vendor having a breach.
              engagement:
                type: string
                description: The status of the latest score or factor changes of the vendor.
              assessment_scheduled_at:
                type: string
                format: date
                example: '2020-01-01'
                pattern: ^\d{4}-\d{2}-\d{2}$
                description: The date of the next vendor assessment.
            required:
            - domain
            - company_name
        updated_vendors:
          type: array
          items:
            type: object
            description: Vendor risk profile information
            properties:
              domain:
                example: securityscorecard.com
                type: string
              company_name:
                example: SecurityScorecard
                type: string
              business_impact:
                type: string
                description: The effect a vendor breach would have on the organization.
              tier:
                type: string
                description: The level of service provided for the vendor.
              custom_tags:
                type: array
                items:
                  type: string
                description: Extra tags to label and organize the vendor.
              incident_likelihood:
                type: string
                description: The chance of the vendor having a breach.
              engagement:
                type: string
                description: The status of the latest score or factor changes of the vendor.
              assessment_scheduled_at:
                type: string
                format: date
                example: '2020-01-01'
                pattern: ^\d{4}-\d{2}-\d{2}$
                description: The date of the next vendor assessment.
            required:
            - domain
            - company_name
        ignored_domains:
          type: array
          items:
            type: object
            properties:
              domain:
                type: string
              index:
                type: number
              errors:
                type: array
                items:
                  type: string
            required:
            - index
            - errors
      required:
      - customer_id
      - managed_portfolio_id
      - added_vendors
      - updated_vendors
    UpdateCustomerAccess:
      type: object
      properties:
        organization_access_type:
          type: string
          enum:
          - none
          - full
          - limited
        organization_access_scope:
          type: string
          enum:
          - org
          - user
        users:
          type: array
          items:
            type: string
            format: email
            pattern: ^.+@.+$
            example: john.smith@example.com
      required:
      - organization_access_type
      - organization_access_scope
      - users
      description: settings for customer access
    CreateCustomerUpdate:
      type: object
      properties:
        is_featured:
          type: boolean
          description: is this update featured
        summary:
          type: string
          description: summary of the update
        attachment_url:
          type: string
          description: url of the attachment
        documents:
          type: array
          description: IDs of documents to include in the update
          items:
            example: aea7dae2-370f-4279-a458-4c7cb9661778
            pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
            description: document identifier
            type: string
      required:
      - is_featured
      - summary
      - documents
      description: settings and attachments for the customer update
    DocumentIdSchema:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
      description: Unique ID of the document
      required:
      - id
    IndicatorsList:
      type: object
      additionalProperties: false
      properties:
        entries:
          type: array
          items:
            type: object
            properties:
              issue_type:
                type: string
                description: ID of the indicator and Issue Type
              name:
                type: string
              severity:
                type: string
              category:
                type: string
              breach_risk:
                type: string
                description: Breach risk
              threat_level:
                type: string
                description: Threat level
            required:
            - issue_type
            - name
            - severity
            - breach_risk
            - threat_level
            - category
        size:
          description: The number of records to be returned per page
          example: 100
          type: integer
        page:
          description: The page number to be returned
          example: 1
          type: integer
        total:
          description: The total number of records matching the given query
          example: 999
          type: integer
      required:
      - entries
      - size
      - page
      - total
    DocumentToUpdateSchema:
      type: object
      description: Document
      properties:
        documentId:
          type: string
          format: uuid
          example: 690cba40-cddd-4c61-b18e-63b0230512b5
        filename:
          type: string
          example: updated-name.csv
        description:
          type: string
          example: This is a description
        associatedVendorIds:
          type: array
          items:
            type: string
            format: uuid
          example:
          - 5a935701-9960-5895-882a-08e6284f0f58
      required:
      - documentId
    UpdateCustomerUpdateSchema:
      type: object
      properties:
        id:
          example: aea7dae2-370f-4279-a458-4c7cb9661778
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          description: Customer update identifier
          type: string
      required:
      - id
    VendorsList:
      type: object
      additionalProperties: false
      properties:
        entries:
          type: array
          description: List of vendors
          items:
            type: object
            properties:
              vendor_id:
                example: aea7dae2-370f-4279-a458-4c7cb9661778
                pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
                description: Unique identifier of vendor
                type: string
              vendor_name:
                example: SecurityScorecard
                type: string
                description: Vendor name
              vendor_domain:
                example: securityscorecard.com
                type: string
                description: Vendor domain
              customer_id:
                example: aea7dae2-370f-4279-a458-4c7cb9661778
                pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
                description: Identifier
                type: string
              customer_name:
                example: SecurityScorecard
                type: string
              customer_domain:
                example: securityscorecard.com
                type: string
              business_impact:
                type: string
              incident_likelihood:
                type: string
              engagement:
                type: string
              lifecycle:
                type: string
              tier:
                type: string
              custom_tags:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      example: aea7dae2-370f-4279-a458-4c7cb9661778
                      pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
                      description: Identifier
                      type: string
                    name:
                      type: string
                  required:
                  - name
              incident_likelihood_report_id:
                example: aea7dae2-370f-4279-a458-4c7cb9661778
                pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
                description: Identifier
                type: string
              deleted_at:
                example: '2020-01-01T00:00:00.000Z'
                format: date-time
                type: string
                pattern: ^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}[0-9]*Z$
              created_at:
                example: '2020-01-01T00:00:00.000Z'
                format: date-time
                type: string
                pattern: ^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}[0-9]*Z$
            required:
            - vendor_id
            - vendor_name
            - vendor_domain
            - customer_id
            - customer_name
            - customer_domain
            - business_impact
            - incident_likelihood
            - engagement
            - lifecycle
            - tier
            - custom_tags
        total:
          description: The total number of records matching the given query
          example: 999
          type: integer
      required:
      - entries
      - total
    BreachesList:
      type: object
      additionalProperties: false
      properties:
        entries:
          type: array
          items:
            allOf:
            - type: object
              properties:
                vendor_id:
                  example: aea7dae2-370f-4279-a458-4c7cb9661778
                  pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
                  description: vendor identifier
                  type: string
                vendor_domain:
                  example: securityscorecard.com
                  type: string
                  description: domain of the vendor
                vendor_name:
                  type: string
                  description: name of the vendor
                  example: SecurityScorecard
                customers:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        example: aea7dae2-370f-4279-a458-4c7cb9661778
                        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
                        description: id of the customer
                        type: string
                      domain:
                        example: securityscorecard.com
                        type: string
                        description: domain of the customer
                      name:
                        example: SecurityScorecard
                        type: string
                        description: name of the customer
                    required:
                    - id
                    - domain
                    - name
                report:
                  type: boolean
                  description: is reported
                triaged:
                  type: boolean
                  description: is triaged
                is_active_breach:
                  type: boolean
                  description: vendor has breach
                edited_at:
                  example: '2020-01-01T00:00:00.000Z'
                  type: string
                  pattern: ^(?:\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}\d*Z)?$
                  description: last edition of report or trigger fields
              required:
              - vendor_id
              - vendor_domain
              - vendor_name
              - customers
              - report
              - triaged
              - is_active_breach
              - edited_at
            - type: object
              properties:
                breach_id:
                  example: aea7dae2-370f-4279-a458-4c7cb9661778
                  pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
                  description: breach identifier
                  type: string
                description:
                  type: string
                  description: description of the breach
                link:
                  example: https://www.example.com/resource/123
                  type: string
                  description: source URL of the breach
                published_date:
                  type: string
                  format: date
                  example: '2020-01-01'
                  pattern: ^\d{4}-\d{2}-\d{2}$
                  description: published date of the breach
              required:
              - breach_id
              - description
              - link
              - published_date
        size:
          description: The number of records to be returned per page
          example: 100
          type: integer
        page:
          description: The page number to be returned
          example: 1
          type: integer
        total:
          description: The total number of records matching the given query
          example: 999
          type: integer
      required:
      - entries
      - size
      - page
      - total
    NegotiateVendorListFileRequest:
      type: object
      properties:
        vendorList:
          description: vendor list csv
          type: string
          format: binary
      required:
      - vendorList
      description: settings and attachments for the vendor update
    UpdateCustomerUpdate:
      type: object
      properties:
        is_featured:
          type: boolean
          description: is this update featured
        summary:
          type: string
          description: summary of the update
        attachment_url:
          type: string
          description: url of the attachment
        documents:
          type: array
          description: IDs of documents to include in the update
          items:
            example: aea7dae2-370f-4279-a458-4c7cb9661778
            pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
            description: document identifier
            type: string
      required:
      - is_featured
      - summary
      - documents
      description: settings and attachments for the customer update
    RemoveVendorsSchema:
      description: Removes vendor-customer relations
      type: object
      additionalProperties: false
      properties:
        vendor_customer_relations:
          type: array
          description: List of vendor-customer relations
          items:
            type: object
            properties:
              domain:
                type: string
                description: The domain associated with the vendor
              customer_id:
                type: string
                description: The ID of the customer related to the vendor
            required:
            - domain
            - customer_id
      required:
      - vendor_customer_relations
    ErrorUnauthorized:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              description: Human readable message, suitable for showing in some UI
              type: string
            statusCode:
              type: integer
              default: 401
          required:
          - message
          - statusCode
    VendorUpdatesList:
      type: object
      additionalProperties: false
      properties:
        entries:
          type: array
          description: A list of vendor updates for the current customer
          items:
            type: object
            properties:
              id:
                example: aea7dae2-370f-4279-a458-4c7cb9661778
                pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
                description: Identifier
                type: string
              summary:
                type: string
                description: summary of the vendor update
              escalated_date:
                example: '2020-01-01T00:00:00.000Z'
                format: date-time
                type: string
                pattern: ^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}[0-9]*Z$
              priority:
                type: string
                description: priority of the vendor update
              responsive:
                type: boolean
                description: is responsive
              action_needed:
                type: boolean
                description: is any action needed
              date:
                example: '2020-01-01T00:00:00.000Z'
                format: date-time
                type: string
                pattern: ^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}[0-9]*Z$
              updated_at:
                example: '2020-01-01T00:00:00.000Z'
                format: date-time
                type: string
                pattern: ^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}[0-9]*Z$
              vendor_domain:
                example: securityscorecard.com
                type: string
                description: domain of the vendor
              vendor_name:
                example: SecurityScorecard
                type: string
                description: name of the vendor
            required:
            - id
            - summary
            - escalated_date
            - priority
            - responsive
            - action_needed
            - date
            - vendor_domain
            - vendor_name
        total:
          description: The total number of records matching the given query
          example: 999
          type: integer
      required:
      - entries
      - total
    ManagedCustomerSchema:
      description: Managed customer details
      type: object
      properties:
        customer_id:
          example: aea7dae2-370f-4279-a458-4c7cb9661778
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          description: Identifier
          type: string
        domain:
          example: securityscorecard.com
          type: string
        name:
          example: SecurityScorecard
          type: string
        availableSlots:
          type: integer
          example: 0
          description: Number of available slots for this managed customer
        status:
          type: string
        requestId:
          example: aea7dae2-370f-4279-a458-4c7cb9661778
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          description: Identifier
          type: string
      required:
      - customer_id
      - domain
      - name
      - status
      - requestId
    DocumentToUploadSchema:
      type: object
      description: Document to upload.
      properties:
        description:
          type: string
          description: description of the document
          example: This is a description
        associatedVendorIds:
          type: string
          description: Array of associated vendor IDs (sent as a JSON-stringified array in form-data)
          example: '{}'
        customerId:
          type: string
          description: customer id
          example: 123e4567-e89b-12d3-a456-426614174000
        file:
          type: string
          format: binary
          description: document file
      required:
      - customerId
      - file
    ErrorForbidden:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              description: Human readable message, suitable for showing in some UI
              type: string
            statusCode:
              type: integer
              default: 403
          required:
          - message
          - statusCode
    UpdateVendorUpdateSchema:
      type: object
      properties:
        id:
          example: aea7dae2-370f-4279-a458-4c7cb9661778
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          description: Vendor update identifier
          type: string
      required:
      - id
    LikelihoodAssessmentBulkPostRequest:
      type: object
      properties:
        is_likelihood_report:
          type: boolean
          description: If true, triggers generation of a likelihood assessment report
          default: false
        is_remediation_plan_report:
          type: boolean
          description: If true, a remediation plan report will be generated
          default: false
        list:
          description: List of scorecards and managed customers for which report needs to be generated
          type: array
          items:
            type: object
            properties:
              managed_customer_id:
                type: string
                description: Optional internal identifier for the managed customer
              managed_customer:
                type: string
                description: managed customer domain
              scorecard:
                type: string
                description: scorecard
            required:
            - managed_customer
            - scorecard
      required:
      - list
    ManagedPortfoliosSchema:
      description: List of managed portfolios associated with the specified customer ID
      type: object
      properties:
        entries:
          type: array
          description: Array of portfolios objects
          items:
            type: object
            description: Represents managed portfolios associated with the specified customer ID
            properties:
              id:
                type: string
                description: Unique identifier of the portfolio
              name:
                type: string
                description: Portfolio name
              created_at:
                example: '2020-01-01T00:00:00.000Z'
                format: date-time
                type: string
                pattern: ^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}[0-9]*Z$
                description: Timestamp when the portfolio was created
            required:
            - id
            - name
            - created_at
      required:
      - entries
    CustomerAccess:
      type: object
      properties:
        organization_access_type:
          type: string
          enum:
          - none
          - full
          - limited
        organization_access_scope:
          type: string
          enum:
          - org
          - user
        users:
          type: array
          items:
            type: string
            format: email
            pattern: ^.+@.+$
            example: john.smith@example.com
      required:
      - organization_access_type
      - organization_access_scope
      - users
    DocumentsToDeleteSchema:
      type: object
      description: Document ids to delete.
      properties:
        documentIds:
          type: array
          items:
            type: string
            format: uuid
          example:
          - 690cba40-cddd-4c61-b18e-63b0230512b5
      required:
      - documentIds
      additionalProperties: false
    DeleteReportsBulkSchema:
      type: object
      additionalProperties: false
      properties:
        ids:
          type: array
          description: List of report IDs to delete
          items:
            type: string
            pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
            description: Identifier
            example: aea7dae2-370f-4279-a458-4c7cb9661778
      required:
      - ids
    UploadVendorDomainsFileRequest:
      type: object
      properties:
        vendorList:
          description: vendor list csv
          type: string
          format: binary
      required:
      - vendorList
      description: vendor domains for upload
    ReportsCustomersSchema:
      description: List of customers from the generated reports
      type: object
      properties:
        entries:
          type: array
          description: Array of customer objects
          items:
            type: object
            description: Represents a customer from the report
            properties:
              id:
                type: string
                description: Unique identifier of the customer
              name:
                description: Customer name
                type: string
              domain:
                description: Customer domain
                type: string
            required:
            - id
            - name
            - domain
      required:
      - entries
    DocumentUrlSchema:
      type: object
      properties:
        url:
          type: string
          example: https://example.com/document.csv
    DeleteCustomerUpdatesRequest:
      type: object
      properties:
        ids:
          type: array
          items:
            example: aea7dae2-370f-4279-a458-4c7cb9661778
            pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
            description: Customer update identifier
            type: string
      required:
      - ids
      description: Array of customer update ids to remove
    ManagedCustomerVendor:
      type: object
      properties:
        vendor_id:
          example: aea7dae2-370f-4279-a458-4c7cb9661778
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          description: Unique identifier of vendor
          type: string
        vendor_name:
          example: SecurityScorecard
          type: string
          description: Vendor name
        vendor_domain:
          example: securityscorecard.com
          type: string
          description: Vendor domain
        customer_id:
          example: aea7dae2-370f-4279-a458-4c7cb9661778
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          description: Identifier
          type: string
        customer_name:
          example: SecurityScorecard
          type: string
        customer_domain:
          example: securityscorecard.com
          type: string
        business_impact:
          type: string
        incident_likelihood:
          type: string
        engagement:
          type: string
        lifecycle:
          type: string
        tier:
          type: string
        custom_tags:
          type: array
          items:
            type: object
            properties:
              id:
                example: aea7dae2-370f-4279-a458-4c7cb9661778
                pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
                description: Identifier
                type: string
              name:
                type: string
            required:
            - name
        assessment_scheduled_at:
          example: '2020-01-01T00:00:00.000Z'
          format: date-time
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}[0-9]*Z$
        scoring_started_at:
          example: '2020-01-01T00:00:00.000Z'
          format: date-time
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}[0-9]*Z$
        grade:
          type: string
          description: a security scorecard grade (A to F), or '?' if it's calculating.
          example: A
          enum:
          - A
          - B
          - C
          - D
          - F
          - '?'
        score:
          type: integer
          description: security score from 0 to 100
          example: 95
      required:
      - vendor_id
      - vendor_name
      - vendor_domain
      - customer_id
      - customer_name
      - customer_domain
      - business_impact
      - incident_likelihood
      - engagement
      - lifecycle
      - tier
      - custom_tags
      description: Managed customer vendor details
    UploadVendorDomainsRequest:
      type: object
      properties:
        vendor_list:
          description: List of vendors risk profiles
          type: array
          items:
            type: object
            description: Vendor risk profile information
            properties:
              domain:
                example: securityscorecard.com
                type: string
              company_name:
                example: SecurityScorecard
                type: string
              business_impact:
                type: string
                description: The effect a vendor breach would have on the organization.
              tier:
                type: string
                description: The level of service provided for the vendor.
              custom_tags:
                type: array
                items:
                  type: string
                description: Extra tags to label and organize the vendor.
              incident_likelihood:
                type: string
                description: The chance of the vendor having a breach.
              engagement:
                type: string
                description: The status of the latest score or factor changes of the vendor.
              assessment_scheduled_at:
                type: string
                format: date
                example: '2020-01-01'
                pattern: ^\d{4}-\d{2}-\d{2}$
                description: The date of the next vendor assessment.
            required:
            - domain
            - company_name
      required:
      - vendor_list
      description: List of vendors risk profiles
    ErrorNotFound:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              description: Human readable message, suitable for showing in some UI
              type: string
            statusCode:
              type: integer
              default: 404
          required:
          - message
          - statusCode
    CustomerVendorsTrends:
      type: object
      description: Vendor risk profiles for uploaded domains
      properties:
        vendors_doing_well:
          type: object
          description: Vendors trend metadata
          properties:
            count:
              type: number
              description: Total number of vendors in the trend
            percentage:
              type: number
              description: Percentage of vendors in the trend
          required:
          - count
          - percentage
        vendors_improved:
          type: object
          description: Vendors trend metadata
          properties:
            count:
              type: number
              description: Total number of vendors in the trend
            percentage:
              type: number
              description: Percentage of vendors in the trend
          required:
          - count
          - percentage
        vendors_didnt_improve:
          type: object
          description: Vendors trend metadata
          properties:
            count:
              type: number
              description: Total number of vendors in the trend
            percentage:
              type: number
              description: Percentage of vendors in the trend
          required:
          - count
          - percentage
        vendors_worsened:
          type: object
          description: Vendors trend metadata
          properties:
            count:
              type: number
              description: Total number of vendors in the trend
            percentage:
              type: number
              description: Percentage of vendors in the trend
          required:
          - count
          - percentage
        vendors_first_assessment:
          type: object
          description: Vendors trend metadata
          properties:
            count:
              type: number
              description: Total number of vendors in the trend
            percentage:
              type: number
              description: Percentage of vendors in the trend
          required:
          - count
          - percentage
      required:
      - vendors_doing_well
      - vendors_improved
      - vendors_didnt_improve
      - vendors_worsened
      - vendors_first_assessment
    ReportsSchema:
      description: Represents a report for managed services
      type: object
      properties:
        entries:
          type: array
          description: Array of report objects
          items:
            type: object
            description: Represents a report for managed services
            properties:
              id:
                type: string
                description: Unique identifier for the report
              name:
                description: Name of the report
                type: string
              description:
                description: Description of the report
                type: string
              created_by:
                type: string
                description: Identifier of the user who created the report
              created_at:
                example: '2020-01-01T00:00:00.000Z'
                format: date-time
                type: string
                pattern: ^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}[0-9]*Z$
                description: Timestamp when the report was created
              updated_at:
                example: '2020-01-01T00:00:00.000Z'
                format: date-time
                type: string
                pattern: ^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}[0-9]*Z$
                description: Timestamp when the report was last updated
              updated_by:
                type: string
                description: Identifier of the user who last updated the report
              vendor:
                type: string
                description: Vendor associated with the report
              customer:
                type: string
                description: Customer associated with the report
              vendor_name:
                type: string
                description: Name of the vendor
              business_impact:
                type: string
                description: Business impact rating of the report
              incident_likelihood:
                type: string
                description: Incident likelihood rating of the report
              customer_name:
                type: string
                description: Name of the customer
              is_published:
                type: boolean
                description: Indicates whether the report is published
              published_at:
                example: '2020-01-01T00:00:00.000Z'
                format: date-time
                type: string
                pattern: ^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}[0-9]*Z$
                description: Timestamp when the report was published
              published_by:
                type: string
                description: Identifier of the user who published the report
            required:
            - id
            - created_by
            - created_at
            - updated_at
            - updated_by
            - vendor
            - customer
            - vendor_name
            - customer_name
        page:
          type: integer
          description: The page number to be returned
          example: 1
        size:
          type: integer
          description: The number of all records
          example: 100
      required:
      - entries
      - page
      - size
    CustomerUserList:
      type: array
      items:
        type: object
        properties:
          username:
            type: string
            description: Username
          email:
            type: string
            description: email of the user
        required:
        - username
        - email
    ReportsVendorsSchema:
      description: List of vendors from the generated reports
      type: object
      properties:
        entries:
          type: array
          description: Array of vendors objects
          items:
            type: object
            description: Represents a vendors from the report
            properties:
              id:
                type: string
                description: Unique identifier of the vendors
              name:
                description: Vendor name
                type: string
              domain:
                description: Vendor domain
                type: string
            required:
            - id
            - name
            - domain
      required:
      - entries
    LikelihoodAssessmentV2GetResponse:
      allOf:
      - title: LikelihoodAssessmentV2Base
        type: object
        properties:
          request_id:
            example: aea7dae2-370f-4279-a458-4c7cb9661778
            pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
            description: Unique identifier for the request
            type: string
          score:
            type: object
            properties:
              start:
                type: number
                description: Initial score
              end:
                type: number
                description: End score
              rating:
                type: string
                description: Rating type
            required:
            - start
            - end
            - rating
          rating_breakdown:
            type: array
            items:
              type: object
              properties:
                info_security_objective:
                  type: string
                  description: Information Security Objective
                score:
                  type: number
                  description: Score
                rating:
                  type: string
                  description: Rating
              required:
              - info_security_objective
              - score
              - rating
          rating_breakdown_info:
            type: array
            items:
              type: object
              properties:
                info_security_objective:
                  type: string
                  description: Information Security Objective
                info_security_activity:
                  type: string
                  description: Information Security Activity
                score:
                  type: number
                  description: Score
                rating:
                  type: string
                  description: Rating
              required:
              - info_security_objective
              - score
              - rating
              - info_security_activity
          enhance_information_security_activity:
            type: array
            items:
              type: object
              properties:
                info_security_activity:
                  type: string
                  description: Information security activity
                info_security_objective:
                  type: string
                  description: Information security objective
                recommendation:
                  type: string
                  description: Recommendation
                criticality:
                  type: string
                  description: Criticality
                current_information:
                  type: array
                  items:
                    type: object
                    properties:
                      title:
                        type: string
                        description: title of the issue type
                      key:
                        type: string
                        description: key of the issue type
                    required:
                    - title
                    - key
                findings_count:
                  type: number
                  description: Finding count
              required:
              - info_security_objective
              - info_security_activity
              - recommendation
              - criticality
              - current_information
          ransomware_and_data_breach_incidents:
            type: array
            items:
              type: object
              properties:
                severity:
                  type: string
                  description: Current information
                no_of_issues:
                  type: number
                  description: Current information
                indicator_key:
                  type: string
                  description: indicator key
                information_security_indicator:
                  type: string
                  description: Information security indicator
              required:
              - severity
              - no_of_issues
              - indicator_key
              - information_security_indicator
          suspicious_activity:
            type: array
            items:
              type: object
              properties:
                severity:
                  type: string
                  description: Severity
                no_of_issues:
                  type: number
                  description: No of issues
                indicator_key:
                  type: string
                  description: indicator key
                information_security_indicator:
                  type: string
                  description: Information security indicator
              required:
              - severity
              - no_of_issues
              - indicator_key
              - information_security_indicator
          exposed_services_to_investigate:
            type: array
            items:
              type: object
              properties:
                severity:
                  type: string
                  description: Severity
                no_of_issues:
                  type: number
                  description: No of issues
                indicator_key:
                  type: string
                  description: indicator key
                information_security_indicator:
                  type: string
                  description: Information security indicator
              required:
              - severity
              - no_of_issues
              - indicator_key
              - information_security_indicator
        required:
        - score
        - rating_breakdown
        - rating_breakdown_info
        - enhance_information_security_activity
        - ransomware_and_data_breach_incidents
        - suspicious_activity
        - exposed_services_to_investigate
      - type: object
        properties:
          vulnerabilities_to_address:
            type: array
            items:
              type: object
              properties:
                cve_nvd_severity:
                  type: string
                  description: Current information
                no_of_vulnerabilities:
                  type: number
                  description: Current information
                no_of_cisa_known_vulnerabilities:
                  type: number
                  description: Information security indicator
              required:
              - cve_nvd_severity
              - no_of_vulnerabilities
              - no_of_cisa_known_vulnerabilities
    UpdateFindingsSettings:
      type: object
      properties:
        findings:
          type: array
          items:
            type: object
            properties:
              finding_id:
                type: string
                format: uuid
                description: id(issueId) of the finding for which the report and triage status needs to be updated
              vendor_id:
                type: string
                format: uuid
                description: id of the vendor associated with the finding for which the report status needs to be updated
              report:
                type: boolean
                description: if true the findings/finding will be used for the likelihood report generation
              triaged:
                type: boolean
                description: if true the findings/finding will be considered triaged
            required:
            - finding_id
            - vendor_id
            - report
            - triaged
      required:
      - findings
      description: Array of finding ids/id and the vendor ids which needs to be marked as reported
    UpdateVendorUpdate:
      description: Settings for updating an existing vendor update, including metadata fields and optional vendor domain
      type: object
      properties:
        summary:
          type: string
          description: A brief summary of the vendor update
        escalated_date:
          example: '2020-01-01T00:00:00.000Z'
          format: date-time
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}[0-9]*Z$
          description: The date and time when this update was escalated
        priority:
          type: string
          description: Priority level of the vendor update
        responsive:
          type: boolean
          description: Indicates whether the vendor has responded to this update
        action_needed:
          type: boolean
          description: Indicates if any further action is required
        vendor_domain:
          type: string
          description: Domain of the vendor associated with this update
      required:
      - summary
      - escalated_date
      - priority
      - responsive
      - action_needed
      - vendor_domain
    CustomerUpdatesList:
      type: object
      additionalProperties: false
      properties:
        entries:
          type: array
          description: A list of customer updates with their associated shared documents for the current customer
          items:
            type: object
            properties:
              id:
                example: aea7dae2-370f-4279-a458-4c7cb9661778
                pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
                description: Identifier
                type: string
              date:
                example: '2020-01-01T00:00:00.000Z'
                format: date-time
                type: string
                pattern: ^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}[0-9]*Z$
              summary:
                type: string
                description: summary of the customer update
              featured:
                type: boolean
                description: is it featured update
              link:
                example: https://www.example.com/resource/123
                type: string
                description: source URL
              created_by:
                type: string
                description: user who created the update
            required:
            - id
            - date
            - summary
            - featured
            - link
            - created_by
        total:
          description: The total number of records matching the given query
          example: 999
          type: integer
      required:
      - entries
      - total
    CreateVendorUpdateSchema:
      type: object
      properties:
        id:
          example: aea7dae2-370f-4279-a458-4c7cb9661778
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          description: Vendor update identifier
          type: string
      required:
      - id
    IndicatorExclusionList:
      type: object
      additionalProperties: false
      properties:
        entries:
          type: array
          items:
            type: object
            properties:
              id:
                format: uuid
                type: string
              issue_type:
                type: string
                description: ID of the indicator and Issue Type
              scope:
                type: string
                enum:
                - partner
                - customer
                - vendor
                description: 'Scope of the exclusion, can be: partner (everybody), vendor or customer'
              customer_id:
                type: string
                description: ID of the customer if the scope is customer
              customer_name:
                type: string
                description: Name of the customer if the scope is customer
              vendor_id:
                type: string
                description: ID of the vendor if the scope is vendor
              vendor_name:
                type: string
                description: Name of the vendor if the scope is vendor
              vendor_domain:
                type: string
                description: Domain of the vendor if the scope is vendor
              redundant:
                type: boolean
                description: If the exclusion is redundant
              edited_at:
                type: string
                description: Date of the last edition
              edited_by:
                type: string
                description: User Email of the last editor
              reason:
                type: string
                description: Reason for the exclusion
              issue_type_name:
                type: string
                description: Name of the issue type
              issue_type_severity:
                type: string
                description: Severity of the issue type
              issue_type_category:
                type: string
                description: Category of the issue type
              issue_type_breach_risk:
                type: string
                description: Breach risk
              issue_type_threat_level:
                type: string
                description: Threat level
            required:
            - id
            - issue_type
            - scope
            - redundant
            - edited_at
            - edited_by
            - issue_type_name
            - issue_type_severity
            - issue_type_category
            - issue_type_breach_risk
            - issue_type_threat_level
        size:
          description: The number of records to be returned per page
          example: 100
          type: integer
        page:
          description: The page number to be returned
          example: 1
          type: integer
        total:
          description: The total number of records matching the given query
          example: 999
          type: integer
      required:
      - entries
      - size
      - page
      - total
  securitySchemes:
    Token:
      type: apiKey
      in: header
      name: Authorization
      description: "SecurityScorecard API endpoints require an authentication token to be passed\nin an authorization header in order to return data. If you do not already\nhave a token, you can create one by going to the API Access area in your\n[Settings page](https://platform.securityscorecard.io/#/settings/api) and then\nclicking Generate New Token. Please note this tokens have no expiration\nso they can be used until manually revoked. If you have a token and generate\na new one, the previous token will be revoked and can no longer be used.\n\nAdministrators can also revoke API tokens for any user in their account.\n\nOnce you have your token you can pass it in using the `Authorization` http header like this:\n\n```\ncurl -X GET \\\n  https://api.securityscorecard.io/portfolios \\\n  -H 'authorization: Token <your token>'\n```"
x-provenance:
  method: searched
  source: https://securityscorecard.readme.io/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://securityscorecard.readme.io/reference/delete_max-partner-documents.md
  - https://securityscorecard.readme.io/reference/delete_max-partner-managed-customers-customer-id-updates.md
  - https://securityscorecard.readme.io/reference/delete_max-partner-managed-customers-customer-id-vendors-updates.md
  - https://securityscorecard.readme.io/reference/delete_max-partner-managed-customers-customer-id.md
  - https://securityscorecard.readme.io/reference/delete_max-partner-reports-bulk-delete.md
  - https://securityscorecard.readme.io/reference/delete_max-partner-vendors.md
  - https://securityscorecard.readme.io/reference/get_footprint-parentdomain-attribution-log.md
  - https://securityscorecard.readme.io/reference/get_max-customer-breaches.md
  - https://securityscorecard.readme.io/reference/get_max-customer-documents-id.md
  - https://securityscorecard.readme.io/reference/get_max-customer-documents.md
  - https://securityscorecard.readme.io/reference/get_max-customer-findings.md
  - https://securityscorecard.readme.io/reference/get_max-customer-reports-remediation-plans.md
  - https://securityscorecard.readme.io/reference/get_max-customer-updates.md
  - https://securityscorecard.readme.io/reference/get_max-customer-users-access.md
  - https://securityscorecard.readme.io/reference/get_max-customer-vendors-improvements.md
  - https://securityscorecard.readme.io/reference/get_max-customer-vendors-updates.md
  - https://securityscorecard.readme.io/reference/get_max-customer-vendors.md
  - https://securityscorecard.readme.io/reference/get_max-partner-breaches.md
  - https://securityscorecard.readme.io/reference/get_max-partner-customer-id-vendors-improvements.md
  - https://securityscorecard.readme.io/reference/get_max-partner-documents-id.md
  - https://securityscorecard.readme.io/reference/get_max-partner-findings-report-id.md
  - https://securityscorecard.readme.io/reference/get_max-partner-findings.md
  - https://securityscorecard.readme.io/reference/get_max-partner-indicators-exclusion.md
  - https://securityscorecard.readme.io/reference/get_max-partner-indicators.md
  - https://securityscorecard.readme.io/reference/get_max-partner-managed-customers-customer-domain-vendor-vendor-domain-reports-likelihood-assessments-date.md
  - https://securityscorecard.readme.io/reference/get_max-partner-managed-customers-customer-id-documents.md
  - https://securityscorecard.readme.io/reference/get_max-partner-managed-customers-customer-id-managed-portfolios.md
  - https://securityscorecard.readme.io/reference/get_max-partner-managed-customers-customer-id-updates.md
  - https://securityscorecard.readme.io/reference/get_max-partner-managed-customers-customer-id-vendors-domain.md
  - https://securityscorecard.readme.io/reference/get_max-partner-managed-customers-customer-id-vendors-updates.md
  - https://securityscorecard.readme.io/reference/get_max-partner-managed-customers-customer-id.md
  - https://securityscorecard.readme.io/reference/get_max-partner-managed-customers-id-access.md
  - https://securityscorecard.readme.io/reference/get_max-partner-managed-customers-id-users.md
  - https://securityscorecard.readme.io/reference/get_max-partner-managed-customers.md
  - https://securityscorecard.readme.io/reference/get_max-partner-reports-likelihood-assessments-logs.md
  - https://securityscorecard.readme.io/reference/get_max-partner-reports-managed-customers.md
  - https://securityscorecard.readme.io/reference/get_max-partner-reports-remediation-plans.md
  - https://securityscorecard.readme.io/reference/get_max-partner-reports-vendors.md
  - https://securityscorecard.readme.io/reference/get_max-partner-reports.md
  - https://securityscorecard.readme.io/reference/get_max-partner-unmanaged-customers.md
  - https://securityscorecard.readme.io/reference/get_max-partner-vendors-domain-managed-customers.md
  - https://securityscorecard.readme.io/reference/get_max-partner-vendors.md
  - https://securityscorecard.readme.io/reference/get_v2-portfolios-portfolio-id-companies.md
  - https://securityscorecard.readme.io/reference/post_max-customer-documents.md
  - https://securityscorecard.readme.io/reference/post_max-partner-documents.md
  - https://securityscorecard.readme.io/reference/post_max-partner-managed-customers-customer-id-updates.md
  - https://securityscorecard.readme.io/reference/post_max-partner-managed-customers-customer-id-vendors-domain-updates.md
  - https://securityscorecard.readme.io/reference/post_max-partner-managed-customers-id-access.md
  - https://securityscorecard.readme.io/reference/post_max-partner-management-requests.md
  - https://securityscorecard.readme.io/reference/post_max-partner-reports-likelihood-assessments.md
  - https://securityscorecard.readme.io/reference/post_max-partner-vendor-onboarding-add-vendor-domains-domain-or-portfolio-id.md
  - https://securityscorecard.readme.io/reference/post_max-partner-vendor-onboarding-negotiate-vendor-list.md
  - https://securityscorecard.readme.io/reference/put_max-customer-documents.md
  - https://securityscorecard.readme.io/reference/put_max-partner-breaches.md
  - https://securityscorecard.readme.io/reference/put_max-partner-documents.md
  - https://securityscorecard.readme.io/reference/put_max-partner-findings.md
  - https://securityscorecard.readme.io/reference/put_max-partner-managed-customers-updates-id.md
  - https://securityscorecard.readme.io/reference/put_max-partner-vendor-onboarding-add-vendor-domains-domain-or-portfolio-id.md
  - https://securityscorecard.readme.io/reference/put_max-partner-vendor-onboarding-negotiate-vendor-list.md
  - https://securityscorecard.readme.io/reference/put_max-partner-vendors-statuses.md
  - https://securityscorecard.readme.io/reference/put_max-partner-vendors-updates-id.md
  merge:
    pages: 61
    deduped: 371
    conflicts_kept_first: 0