Palo Alto Networks Trust API

openapi: 3.2.0
info:
  title: Palo Alto Networks Trust API
  version: '1.0'
  description: 'Operations tagged Trust across 4 of this provider''s published API definitions: palo-alto-compute-34-03-openapi-34-03-138-sh-openapi.json, palo-alto-compute-openapi-34-04-145-sh-openapi.json, palo-alto-cwpp-34-03-openapi-34-03-138-saas-openapi.json, palo-alto-cwpp-openapi-34-04-145-saas-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: PATH_TO_CONSOLE
tags:
- name: Trust
  description: Trust. 2 operations in this definition.
  x-description-source: desc/trust/trust.md
paths:
  /api/v34.03/trust/data:
    get:
      description: 'Get Trusted Repository, Image, and Registry. GET /api/v34.03/trust/data on the Trust API. Documented responses: 200.'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/trust.Data'
          description: Data holds the image trust data
        default:
          description: ''
      tags:
      - Trust
      x-prisma-cloud-target-env:
        permission: policyContainers
      operationId: get-trust-data
      summary: Get Trusted Repository, Image, and Registry
      x-description-source: desc/trust/data_get.md
    put:
      description: 'Update Trusted Repository, Image, and Registry. PUT /api/v34.03/trust/data on the Trust API. Takes an optional request body. Documented responses: 200.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/trust.Data'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Trust
      x-prisma-cloud-target-env:
        permission: policyContainers
      operationId: put-trust-data
      summary: Update Trusted Repository, Image, and Registry
      x-description-source: desc/trust/data_put.md
  /api/v34.04/trust/data:
    get:
      description: 'Get Trusted Repository, Image, and Registry. GET /api/v34.04/trust/data on the Trust API. Documented responses: 200.'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/trust.Data'
          description: Data holds the image trust data
        default:
          description: ''
      tags:
      - Trust
      x-prisma-cloud-target-env:
        permission: policyContainers
      operationId: get-trust-data
      summary: Get Trusted Repository, Image, and Registry
      x-description-source: desc/trust/data_get.md
    put:
      description: 'Update Trusted Repository, Image, and Registry. PUT /api/v34.04/trust/data on the Trust API. Takes an optional request body. Documented responses: 200.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/trust.Data'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Trust
      x-prisma-cloud-target-env:
        permission: policyContainers
      operationId: put-trust-data
      summary: Update Trusted Repository, Image, and Registry
      x-description-source: desc/trust/data_put.md
components:
  schemas:
    trust.Data:
      description: Data holds the image trust data
      properties:
        groups:
          description: 'Groups are the trust groups.

            '
          items:
            $ref: '#/components/schemas/trust.Group'
          type: array
        policy:
          $ref: '#/components/schemas/trust.Policy'
      type: object
    vuln.Effect:
      description: Effect specifies relevant action for a vulnerability
      enum:
      - - ignore
        - alert
        - block
      type: string
    trust.PolicyRule:
      description: PolicyRule represents an trust policy rule
      properties:
        allowedGroups:
          description: 'AllowedGroups are the ids of the groups that are whitelisted by this rule.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
        blockMsg:
          $ref: '#/components/schemas/common.PolicyBlockMsg'
        collections:
          description: 'Collections is a list of collections the rule applies to.

            '
          items:
            $ref: '#/components/schemas/collection.Collection'
          type: array
        deniedGroups:
          description: 'DeniedGroups are the ids of the groups that are blacklisted by this rule.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
        disabled:
          description: 'Indicates whether the rule is currently disabled. Values: true (disabled) or false (enabled).

            '
          type: boolean
        effect:
          $ref: '#/components/schemas/vuln.Effect'
        modified:
          description: 'Specifies the date and time when the rule was last modified.

            '
          format: date-time
          type: string
        name:
          description: 'Name of the rule.

            '
          type: string
        notes:
          description: 'Describes any noteworthy points for a rule. You can include any text.

            '
          type: string
        owner:
          description: 'User who created or last modified the rule.

            '
          type: string
        previousName:
          description: 'Previous name of the rule. Required for rule renaming.

            '
          type: string
      type: object
    string:
      type: string
    common.Color:
      description: Color is a hexadecimal representation of color code value
      type: string
    common.PolicyBlockMsg:
      description: PolicyBlockMsg represent the block message in a Policy
      type: string
    trust.Policy:
      description: Policy represents the trust policy
      properties:
        _id:
          description: 'ID is the trust group policy ID.

            '
          type: string
        enabled:
          description: 'Enabled indicates whether the policy is enabled.

            '
          type: boolean
        rules:
          description: 'Rules is the list of rules in the policy.

            '
          items:
            $ref: '#/components/schemas/trust.PolicyRule'
          type: array
      type: object
    trust.Group:
      description: Group represents a group of images
      properties:
        _id:
          description: 'Name of the group.

            '
          type: string
        disabled:
          description: 'Indicates whether the rule is currently disabled. Values: true (disabled) or false (enabled).

            '
          type: boolean
        images:
          description: 'Image names or IDs (e.g., docker.io/library/ubuntu:16.04 / SHA264@...).

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
        layers:
          description: 'Filesystem layers. The image is trusted if its layers have a prefix of the trusted groups layer in the same order.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
        modified:
          description: 'Specifies the date and time when the rule was last modified.

            '
          format: date-time
          type: string
        name:
          description: 'Name of the rule.

            '
          type: string
        notes:
          description: 'Describes any noteworthy points for a rule. You can include any text.

            '
          type: string
        owner:
          description: 'User who created or last modified the rule.

            '
          type: string
        previousName:
          description: 'Previous name of the rule. Required for rule renaming.

            '
          type: string
      type: object
    collection.Collection:
      description: Collection is a collection of resources
      properties:
        accountIDs:
          description: 'List of account IDs.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
        appIDs:
          description: 'List of application IDs.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
        clusters:
          description: 'List of Kubernetes cluster names.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
        color:
          $ref: '#/components/schemas/common.Color'
        containers:
          description: 'List of containers.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
        description:
          description: 'Free-form text.

            '
          type: string
        functions:
          description: 'List of functions.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
        hosts:
          description: 'List of  hosts.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
        images:
          description: 'List of images.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
        labels:
          description: 'List of labels.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
        modified:
          description: 'Datetime when the collection was last modified.

            '
          format: date-time
          type: string
        name:
          description: 'Collection name. Must be unique.

            '
          type: string
        namespaces:
          description: 'List of Kubernetes namespaces.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
        owner:
          description: 'User who created or last modified the collection.

            '
          type: string
        prisma:
          description: 'Indicates whether this collection originates from Prisma Cloud.

            '
          type: boolean
        system:
          description: 'Indicates whether this collection was created by the system (i.e., a non user) (true) or a real user (false).

            '
          type: boolean
      type: object
x-refined-from:
- palo-alto-compute-34-03-openapi-34-03-138-sh-openapi.json
- palo-alto-compute-openapi-34-04-145-sh-openapi.json
- palo-alto-cwpp-34-03-openapi-34-03-138-saas-openapi.json
- palo-alto-cwpp-openapi-34-04-145-saas-openapi.json