Mend Internal Organizations API

openapi: 3.2.0
info:
  title: Mend Internal Organizations API
  description: 'Mend''s enhanced SCA API enables automation of workflows in a REST compliant format. The API features:

    + Access for any user with Mend credentials, via a user key available in the user''s profile page in the Mend App.

    + Improved security with a JWT token per organization, which expires every 10 minutes.

    + Added scalability with support for pagination, filtering and sorting search results.

    + Broader functionality available programmatically.

    + New standard API documentation for easy navigation and search.


    **Note:** To help you get started with the Mend SCA API 2.0, we recommend reviewing our onboarding guide -> Getting Started with Mend SCA API 2.0.

    This resource covers initial setup, authentication instructions, and helpful tips to help you successfully begin working with the Mend SCA API 2.0. If you have a dedicated instance of Mend, contact your Mend representative to access this API on your instance.'
  version: 3.0.1
servers:
- url: https://api-saas.mend.io
  description: Generated server url
security:
- bearer-key: []
tags:
- name: Internal Organizations
paths:
  /api/v3.0/internal/orgs/{orgUuid}/settings:
    get:
      tags:
      - Internal Organizations
      summary: Get Organization Settings
      operationId: getDomainSettings
      parameters:
      - name: orgUuid
        in: path
        description: 'org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).'
        required: true
        schema:
          type: string
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalDomainSettingsDTO'
    post:
      tags:
      - Internal Organizations
      summary: Update Organization Settings
      operationId: updateDomainSetting
      parameters:
      - name: orgUuid
        in: path
        description: 'org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).'
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InternalDomainSettingsDTO'
        required: true
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalDomainSettingsDTO'
  /api/v2.0/internal/orgs/{orgUuid}/statistics:
    post:
      tags:
      - Internal Organizations
      summary: Calculate Organization Statistics
      operationId: calculateDomainStatistics
      parameters:
      - name: orgUuid
        in: path
        description: 'org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).'
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StatisticsTypesDTO'
        required: true
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseMessageDTO'
  /api/v2.0/internal/orgs/{orgUuid}/settings:
    get:
      tags:
      - Internal Organizations
      summary: Get Organization Settings
      operationId: getDomainSettings_2
      parameters:
      - name: orgUuid
        in: path
        description: 'org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).'
        required: true
        schema:
          type: string
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalDomainSettingsDTO'
    post:
      tags:
      - Internal Organizations
      summary: Update Organization Settings
      operationId: updateDomainSetting_1
      parameters:
      - name: orgUuid
        in: path
        description: 'org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).'
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InternalDomainSettingsDTO'
        required: true
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalDomainSettingsDTO'
  /api/v2.0/internal/orgs/{orgUuid}/risk-reduction-timeframe-filter:
    post:
      tags:
      - Internal Organizations
      summary: Update/Set Risk Reduction Timeframe Filter Value
      operationId: updateRiskReductionTimeframeFilterValue
      parameters:
      - name: orgUuid
        in: path
        description: 'org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).'
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NumericValueRequestDTO'
        required: true
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageDTO'
  /api/v2.0/internal/orgs/{orgUuid}/addQueueMessage:
    post:
      tags:
      - Internal Organizations
      summary: Add message to internal persistent queue
      operationId: addQueueMessage
      parameters:
      - name: orgUuid
        in: path
        description: 'org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).'
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InternalQueueMessageDTO'
        required: true
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageDTO'
  /api/v2.0/internal/orgs/expandTestOrganization:
    post:
      tags:
      - Internal Organizations
      summary: Create or Expand Test Organization
      description: Creates or expands a test organization with products, projects, and libraries for testing purposes
      operationId: expandTestOrganization
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExpandTestOrganizationRequestDTO'
        required: true
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseMessageDTO'
  /api/v3.0/internal/orgs/{orgUuid}/systemAccess:
    get:
      tags:
      - Internal Organizations
      summary: System Access Organization
      description: Deprecated - Use /v3.0/login/accessToken instead of this endpoint.
      operationId: systemAccessDomain
      parameters:
      - name: orgUuid
        in: path
        description: 'org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).'
        required: true
        schema:
          type: string
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionInfo'
      deprecated: true
  /api/v3.0/internal/orgs/integrations:
    get:
      tags:
      - Internal Organizations
      summary: Get All Orgs With Integrations
      description: Returns all orgs that have specific integrations with filtering.
      operationId: getIntegrations_1
      parameters:
      - name: search
        in: query
        description: "Filter your search to return items whose property has a specific value.\nUse the syntax: **[property][operator][value]**\n+ **Property**: the name of the property of the item\n+ **Operator**:\n    + **equals (==)** - Returns true if the value exactly matches this one. If the value contains a * character, it behaves like a wildcard (similar to the LIKE operator).\nExample: entity==abc* — will return true for entities like \"abcd\" and \"abc_123\".\n    + **in (=in=)** - Returns true if the value matches any item in the comma-separated list.\nExample: entity=in=value1,value2 — will return true for entities which are either value1, or value2.\n\n+ **Value**: the value of the property.\nLogical operators AND (;) and OR (,) are supported in filters — param1=in=(val1,val2) and (param2==val3 or param3==val4), can also be written as — param1=in=(val1,val2);(param2==val3,param3==val4)\n\nThis endpoint supports filtering on the following properties and its supported operators:\n+ type: equals, in\n+ status: equals, in\n+ variant: equals, in\n"
        allowEmptyValue: true
        schema:
          type: string
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponsePageableV3ListIntegrationDTOV3'
  /api/v3.0/internal/orgs:
    get:
      tags:
      - Internal Organizations
      summary: Get Organizations for System Access
      description: Get all system accessible organizations
      operationId: getSystemAccessibleDomains
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InternalDomainDTO'
  /api/v2.0/internal/orgs/{orgUuid}/systemAccess:
    get:
      tags:
      - Internal Organizations
      summary: System Access Organization
      operationId: systemAccessDomain_1
      parameters:
      - name: orgUuid
        in: path
        description: 'org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).'
        required: true
        schema:
          type: string
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionInfo'
  /api/v2.0/internal/orgs:
    get:
      tags:
      - Internal Organizations
      summary: Get Organizations for System Access
      description: Get all system accessible organizations
      operationId: getSystemAccessibleDomains_1
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InternalDomainDTO'
components:
  schemas:
    InternalQueueMessageDTO:
      type: object
      properties:
        queueName:
          type: string
        message:
          type: string
        envIdentifier:
          type: string
        routingKey:
          type: string
        sleepDelay:
          type: integer
          format: int32
    DWRResponseBase:
      type: object
      properties:
        supportToken:
          title: Support Token
          type: string
          example: 1171c60d
    InternalTenantDTO:
      required:
      - name
      type: object
      properties:
        uuid:
          title: Context Uuid
          type: string
          example: 123e4567-e89b-12d3-a456-426655440000
        name:
          title: Context Name
          type: string
          example: Context A
        creationTime:
          type: string
          format: date-time
    InternalDomainDTO:
      type: object
      properties:
        uuid:
          title: Org Uuid
          type: string
          example: 123e4567-e89b-12d3-a456-426655440000
        name:
          title: Org Name
          type: string
          example: Organization A
        id:
          type: integer
          format: int32
        licenseKey:
          type: string
        creationTime:
          type: string
          format: date-time
        systemAccessEnabled:
          type: boolean
        active:
          type: boolean
        globalAccount:
          $ref: '#/components/schemas/InternalGlobalAccountDTO'
        tenant:
          $ref: '#/components/schemas/InternalTenantDTO'
    ExpandTestOrganizationRequestDTO:
      title: Expand Test Organization Request
      required:
      - maxNumberOfLibraries
      - minNumberOfLibraries
      - numberOfProducts
      - numberOfProjects
      - orgName
      - threads
      type: object
      properties:
        orgName:
          type: string
          description: Name of the test organization to expand or create
          example: my-test-org
        numberOfProducts:
          minimum: 1
          type: integer
          description: Number of products to create
          format: int32
          example: 3
        numberOfProjects:
          minimum: 1
          type: integer
          description: Number of projects to create
          format: int32
          example: 10
        minNumberOfLibraries:
          minimum: 1
          type: integer
          description: Minimum number of libraries per project
          format: int32
          example: 2
        maxNumberOfLibraries:
          minimum: 1
          type: integer
          description: Maximum number of libraries per project
          format: int32
          example: 10
        threads:
          maximum: 8
          minimum: 1
          type: integer
          description: Number of threads for parallel processing (1-8)
          format: int32
          example: 8
        withUpdateRequest:
          type: boolean
          description: Whether to use update request for project creation
          example: true
    StatisticsTypesDTO:
      type: object
      properties:
        statisticsTypes:
          type: array
          items:
            type: string
            enum:
            - alerts
            - licenseRisk
            - licenseHistogram
            - general
            - vulnerabilityEffectiveness
            - sourceLibraries
            - policyViolations
            - vulnerabilitySeverityLibraries
            - outdatedLibraries
            - policyViolatingLibraries
            - libraryTypeHistogram
            - approvalRequests
            - sastVulnerabilitiesBySeverity
            - sastVulnerabilitiesByType
            - sastScan
            - sastRiskFactors
            - unifiedVulnerabilities
            - scan
            - scans
            - scaSecurity
            - llmSecurity
            - imgSecurity
            - imgScanComplete
            - iacSecurity
            - imgUsage
            - dastSecurity
            - aiSecurity
            - workflowViolations
            - scaWorkflowViolations
            - sastWorkflowViolations
            - imgWorkflowViolations
            - aiWorkflowViolations
            - scaViolatingWorkflows
            - sastViolatingWorkflows
            - imgViolatingWorkflows
            - aiViolatingWorkflows
            - scaViolatingFindings
            - sastViolatingFindings
            - imgViolatingFindings
            - aiViolatingFindings
            - scaFrameworks
            - aiModels
            - scaExploitableVulnerabilities
            - scaMscFindings
            - imgMscFindings
            - aiRiskFactors
            - containerRiskFactors
            - scaCriticalSecurityEventFindings
            - contextRiskFactors
    MessageDTO:
      type: object
      properties:
        message:
          title: message
          type: string
          example: Success!
    DWRResponsePageableV3ListIntegrationDTOV3:
      type: object
      properties:
        additionalData:
          title: Provides insights into endpoint-supported pagination information.
          type: object
          description: '+ **totalItems**: The total count of data points returned in an API response.

            '
          example:
            totalItems: '422'
            next: http://someUrl?cursor=3
            cursor: 3
        supportToken:
          title: Support Token
          type: string
          example: 1171c60d
        response:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationDTOV3'
    IntegrationDTOV3:
      type: object
      properties:
        uuid:
          type: string
        orgUuid:
          type: string
        status:
          type: string
          enum:
          - ACTIVE
          - SUSPENDED
          - DELETED
        type:
          type: string
          enum:
          - JIRA
          - GITHUB
          - INVICTI
          - WIZ
        variant:
          type: string
          enum:
          - JIRA_CLOUD
          - JIRA_CLOUD_SECURITY
          - JIRA_DC
          - WIZ_COMMERCIAL
          - WIZ_GOV
          - WIZ_COMM_ON_GOV
          - WIZ_DEMO
        extraData:
          type: object
        createdBy:
          type: string
        creationDate:
          type: string
          format: date-time
        lastUpdate:
          type: string
          format: date-time
    InternalGlobalAccountDTO:
      type: object
      properties:
        uuid:
          title: Account Uuid
          type: string
          example: 123e4567-e89b-12d3-a456-426655440000
        name:
          title: Account Name
          type: string
          example: Account A
        id:
          type: integer
          format: int32
        licenseKey:
          type: string
        creationTime:
          type: string
          format: date-time
    DWRResponseMessageDTO:
      type: object
      properties:
        supportToken:
          title: Support Token
          type: string
          example: 1171c60d
        retVal:
          $ref: '#/components/schemas/MessageDTO'
    InternalDomainSettingsDTO:
      type: object
      properties:
        active:
          type: boolean
        entitlements:
          type: array
          items:
            type: string
        tier:
          type: string
        mendForDevelopers:
          type: boolean
        sastNewGenerationEngines:
          type: array
          items:
            type: string
        sastTypeBasedIncrementalEngines:
          type: array
          items:
            type: string
        sastAiRemediation:
          type: boolean
        aiConsent:
          type: boolean
        systemPromptScanningEnabledDefault:
          type: boolean
        sastAiRemediationModel:
          type: string
        projectActivityFilterEnabled:
          type: boolean
        projectActivityFilterMonths:
          type: integer
          format: int32
        riskReductionTimeframeFilterValue:
          type: integer
          format: int32
        updateProjectTagsOnScaScan:
          type: boolean
        storeScanCommentAsTagEnabled:
          type: boolean
        storeScanCommentAsTagKey:
          type: string
        internalStatisticsEnabled:
          type: boolean
        includeProprietaryLibrariesInWorkflows:
          type: boolean
    SessionInfo:
      type: object
      properties:
        correlationId:
          type: string
        userUuid:
          type: string
        userName:
          type: string
        email:
          type: string
        refreshToken:
          type: string
        jwtToken:
          type: string
        orgName:
          title: Organization Name
          type: string
          example: Organization A
        orgUuid:
          title: Organization Uuid
          type: string
          example: 123e4567-e89b-12d3-a456-426655440000
    NumericValueRequestDTO:
      type: object
      properties:
        value:
          type: integer
          format: int32
  securitySchemes:
    bearer-key:
      type: http
      description: JWT token Bearer
      scheme: bearer
      bearerFormat: JWT