swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector PolicyEvents API
schemes:
- https
tags:
- name: PolicyEvents
paths:
  /policy-events:
    get:
      tags:
      - PolicyEvents
      description: Get policy events for given scope.
      operationId: microsoftAzurePolicyeventsList
      produces:
      - application/json
      parameters:
      - in: query
        name: scope
        description: Id for any resource managed by Purview.
        required: true
        type: string
      - in: query
        name: syncToken
        description: This sync token represents the latest checkpoint for policies. Client need to pass this value while fetching subsequent delta changes.
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/PolicyEventsResponseUpdated'
        '304':
          description: Not Modified
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        PolicyEvents_List:
          $ref: ./examples/PolicyEvents_List.json
      summary: Microsoft Azure Get Policy Events
definitions:
  PolicyElementEventModelUpdated:
    description: Represents the policy element event model.
    required:
    - eventType
    - id
    - kind
    - updatedAt
    - version
    type: object
    properties:
      id:
        description: Id of the policy element.
        minLength: 1
        type: string
      scopes:
        description: List of scopes included in this policy.
        type: array
        items:
          type: string
      version:
        format: int64
        description: Current version of policy element. This is auto incremented with each change. Starts with 1.
        type: integer
      elementJson:
        description: Policy element serialized json payload.
        type: string
      kind:
        $ref: '#/definitions/PolicyElementKind'
      updatedAt:
        format: date-time
        description: Time at which this policy element was last updated.
        type: string
      eventType:
        description: 'Type of event. Format: <RP-Name>/<Resource-Type>/<Action>. For Example: Microsoft.Purview/PolicyElements/Delete.'
        minLength: 1
        type: string
  ErrorResponseModel:
    description: Default error response model.
    required:
    - error
    type: object
    properties:
      error:
        $ref: '#/definitions/ErrorModel'
  PolicyElementKind:
    description: Represents the kind of policy element.
    enum:
    - Policy
    - PolicySet
    - AttributeRule
    type: string
    x-ms-enum:
      name: PolicyElementKind
      modelAsString: true
  PolicyEventsResponseUpdated:
    description: Response model for policy delta fetch API.
    required:
    - syncToken
    type: object
    properties:
      syncToken:
        description: This sync token represents the latest checkpoint for policies. Client need to pass this value while fetching subsequent delta changes.
        minLength: 1
        type: string
      value:
        description: List of policy elements.
        type: array
        items:
          $ref: '#/definitions/PolicyElementEventModelUpdated'
  ErrorModel:
    description: Default error model.
    required:
    - code
    - message
    type: object
    properties:
      code:
        description: Error code.
        minLength: 1
        type: string
      message:
        description: Error message.
        minLength: 1
        type: string
      target:
        description: Error description.
        type: string
      details:
        description: Error details.
        type: array
        items:
          $ref: '#/definitions/ErrorModel'
parameters:
  api-version:
    in: query
    name: api-version
    description: The api-version of the service.
    required: true
    type: string
    x-ms-parameter-location: client
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'