JFrog Summary API

openapi: 3.1.0
info:
  title: JFrog Access REST Access Tokens Summary API
  description: API for managing users, groups, permissions, projects, and access tokens across the JFrog Platform. JFrog Access handles identity management, role-based access control, federated identity, and scoped token creation for authentication and authorization across all JFrog services.
  version: 2.x
  contact:
    name: JFrog
    url: https://jfrog.com
  license:
    name: Proprietary
    url: https://jfrog.com/terms-of-service/
  termsOfService: https://jfrog.com/terms-of-service/
servers:
- url: https://{server}.jfrog.io/access
  description: JFrog Cloud
  variables:
    server:
      default: myserver
      description: Your JFrog server name
- url: https://{host}/access
  description: Self-hosted JFrog instance
  variables:
    host:
      default: localhost:8082
      description: Your self-hosted JFrog server host
security:
- bearerAuth: []
- basicAuth: []
tags:
- name: Summary
  description: Artifact and build vulnerability summaries
paths:
  /v1/summary/artifact:
    post:
      operationId: getArtifactSummary
      summary: JFrog Get Artifact Summary
      description: Returns a summary of security issues and license information for specified artifacts.
      tags:
      - Summary
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                paths:
                  type: array
                  items:
                    type: string
                  description: List of artifact paths in Artifactory
              required:
              - paths
      responses:
        '200':
          description: Artifact summary retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArtifactSummary'
  /v1/summary/build:
    post:
      operationId: getBuildSummary
      summary: JFrog Get Build Summary
      description: Returns a summary of security issues for specified build.
      tags:
      - Summary
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                build_name:
                  type: string
                build_number:
                  type: string
              required:
              - build_name
              - build_number
      responses:
        '200':
          description: Build summary retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuildSummary'
components:
  schemas:
    ArtifactSummary:
      type: object
      properties:
        artifacts:
          type: array
          items:
            type: object
            properties:
              general:
                type: object
                properties:
                  name:
                    type: string
                  path:
                    type: string
                  sha256:
                    type: string
                  component_id:
                    type: string
              issues:
                type: array
                items:
                  $ref: '#/components/schemas/Issue'
              licenses:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                    full_name:
                      type: string
                    components:
                      type: array
                      items:
                        type: string
    Issue:
      type: object
      properties:
        issue_id:
          type: string
        severity:
          type: string
          enum:
          - Low
          - Medium
          - High
          - Critical
        summary:
          type: string
        description:
          type: string
        issue_type:
          type: string
        provider:
          type: string
        cves:
          type: array
          items:
            type: object
            properties:
              cve:
                type: string
              cvss_v2_score:
                type: string
              cvss_v3_score:
                type: string
        created:
          type: string
          format: date-time
        impacted_artifacts:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              display_name:
                type: string
              path:
                type: string
              sha256:
                type: string
    BuildSummary:
      type: object
      properties:
        build:
          type: object
          properties:
            build_name:
              type: string
            build_number:
              type: string
        issues:
          type: array
          items:
            $ref: '#/components/schemas/Issue'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Access token authentication
    basicAuth:
      type: http
      scheme: basic
      description: Basic username/password authentication
externalDocs:
  description: JFrog Access REST API Documentation
  url: https://jfrog.com/help/r/jfrog-platform-administration-documentation/access-token-rest-api