openapi: 3.0.1
info:
  title: Symphony Agent Add Dlp API
  description: 'This document refers to Symphony API calls to send and receive messages

    and content. They need the on-premise Agent installed to perform

    decryption/encryption of content.


    - sessionToken and keyManagerToken can be obtained by calling the

    authenticationAPI on the symphony back end and the key manager

    respectively. Refer to the methods described in authenticatorAPI.yaml.

    - Actions are defined to be atomic, ie will succeed in their entirety

    or fail and have changed nothing.

    - If it returns a 40X status then it will have sent no message to any

    stream even if a request to some subset of the requested streams

    would have succeeded.

    - If this contract cannot be met for any reason then this is an error

    and the response code will be 50X.

    - MessageML is a markup language for messages. See reference here:

    https://rest-api.symphony.com/docs/messagemlv2

    - **Real Time Events**: The following events are returned when reading

    from a real time messages and events stream ("datafeed"). These

    events will be returned for datafeeds created with the v5 endpoints.

    To know more about the endpoints, refer to Create Messages/Events

    Stream and Read Messages/Events Stream. Unless otherwise specified,

    all events were added in 1.46.

    '
  version: 22.9.1
servers:
- url: /
tags:
- name: Dlp
paths:
  /v1/dlp/policies:
    get:
      tags:
      - Dlp
      summary: Symphony Get All Policies
      description: Get all policies
      parameters:
      - name: sessionToken
        in: header
        description: Session authentication token.
        required: true
        schema:
          type: string
      - name: keyManagerToken
        in: header
        description: Key Manager authentication token.
        required: true
        schema:
          type: string
      - name: page
        in: query
        description: Optional parameter to specify which page to return (default is 0)
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: 'Optional parameter to specify the number of result to return per page, default is 50. Maximum is 50.

          '
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1DLPPoliciesCollectionResponse'
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Unauthorized: Session tokens invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
      - Dlp
      summary: Symphony Creates a Policy
      description: 'Creates a new policy with dictionary references.


        At the time of policy creation, the caller should only provide - contentTypes, name, scopes and type. The rest of the information is populated automatically.


        Note - You need to enable the policy after creation to start enforcing the policy.

        '
      parameters:
      - name: sessionToken
        in: header
        description: Session authentication token.
        required: true
        schema:
          type: string
      - name: keyManagerToken
        in: header
        description: Key Manager authentication token.
        required: true
        schema:
          type: string
      requestBody:
        description: Details about the policy that should be created.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1DLPPolicyRequest'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1DLPPolicyResponse'
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Unauthorized: Session tokens invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-codegen-request-body-name: body
  /v1/dlp/policies/{policyId}:
    get:
      tags:
      - Dlp
      summary: Symphony Get a Policy
      description: Get a policy
      parameters:
      - name: sessionToken
        in: header
        description: Session authentication token.
        required: true
        schema:
          type: string
      - name: keyManagerToken
        in: header
        description: Key Manager authentication token.
        required: true
        schema:
          type: string
      - name: policyId
        in: path
        description: Unique dictionary identifier.
        required: true
        schema:
          type: string
      - name: policyVersion
        in: query
        description: "Optional parameter, if set to be valid policy version number,  will return policy with specified policyVersion. \nOtherwise, return the latest policy.\n"
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1DLPPolicyResponse'
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Unauthorized: Session tokens invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      tags:
      - Dlp
      summary: Symphony Updates a Policy. Cannot Be Used for Creation
      description: 'Update the policy (name, type, contentTypes, scopes) and also the dictionaries for a policy.

        Warning: If you send empty list of dictionaries during the update operation, then all the

        dictionaries for this policy are deleted and policy is automatically disabled.

        Note: The policy should already exist.

        '
      parameters:
      - name: sessionToken
        in: header
        description: Session authentication token.
        required: true
        schema:
          type: string
      - name: keyManagerToken
        in: header
        description: Key Manager authentication token.
        required: true
        schema:
          type: string
      - name: policyId
        in: path
        description: Unique dictionary identifier.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1DLPPolicyRequest'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1DLPPolicyResponse'
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Unauthorized: Session tokens invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-codegen-request-body-name: body
    delete:
      tags:
      - Dlp
      summary: Symphony Delete a Policy
      description: 'Delete a policy.

        Note: Only disabled policy can be deleted

        '
      parameters:
      - name: sessionToken
        in: header
        description: Session authentication token.
        required: true
        schema:
          type: string
      - name: keyManagerToken
        in: header
        description: Key Manager authentication token.
        required: true
        schema:
          type: string
      - name: policyId
        in: path
        description: Unique dictionary identifier.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1DLPPolicyResponse'
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Unauthorized: Session tokens invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v1/dlp/policies/{policyId}/enable:
    post:
      tags:
      - Dlp
      summary: Symphony Enables a Policy
      description: Enables a policy.
      parameters:
      - name: sessionToken
        in: header
        description: Session authentication token.
        required: true
        schema:
          type: string
      - name: keyManagerToken
        in: header
        description: Key Manager authentication token.
        required: true
        schema:
          type: string
      - name: policyId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1DLPPolicyResponse'
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Unauthorized: Session tokens invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v1/dlp/policies/{policyId}/disable:
    post:
      tags:
      - Dlp
      summary: Symphony Disables a Policy
      description: Disables a policy.
      parameters:
      - name: sessionToken
        in: header
        description: Session authentication token.
        required: true
        schema:
          type: string
      - name: keyManagerToken
        in: header
        description: Key Manager authentication token.
        required: true
        schema:
          type: string
      - name: policyId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1DLPPolicyResponse'
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Unauthorized: Session tokens invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v1/dlp/dictionaries:
    get:
      tags:
      - Dlp
      summary: Symphony Get All Dictionary Metadatas
      description: 'Get all dictionary metadatas with the latest version. Each dictionary object will only contain meta data of the content.

        '
      parameters:
      - name: sessionToken
        in: header
        description: Session authentication token.
        required: true
        schema:
          type: string
      - name: keyManagerToken
        in: header
        description: Key Manager authentication token.
        required: true
        schema:
          type: string
      - name: page
        in: query
        description: Optional parameter to specify which page to return (default is 0)
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: 'Optional parameter to specify the number of result to return per page, default is 50. Maximum is 50.

          '
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1DLPDictionaryMetadataCollectionResponse'
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Unauthorized: Session tokens invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
      - Dlp
      summary: Symphony Create a Dictionary
      description: 'Creates a dictionary with basic metadata and no content. Only "name" and "type" field is used to create a new dictionary entry.

        '
      parameters:
      - name: sessionToken
        in: header
        description: Session authentication token.
        required: true
        schema:
          type: string
      - name: keyManagerToken
        in: header
        description: Key Manager authentication token.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1DLPDictionaryMetadataCreateRequest'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1DLPDictionaryMetadataResponse'
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Unauthorized: Session tokens invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-codegen-request-body-name: body
  /v1/dlp/dictionaries/{dictId}:
    get:
      tags:
      - Dlp
      summary: Symphony Get Dictionary Metadata
      description: Get basic information for a dictionary.
      parameters:
      - name: sessionToken
        in: header
        description: Session authentication token.
        required: true
        schema:
          type: string
      - name: keyManagerToken
        in: header
        description: Key Manager authentication token.
        required: true
        schema:
          type: string
      - name: dictId
        in: path
        description: Unique dictionary identifier
        required: true
        schema:
          type: string
      - name: dictVersion
        in: query
        description: "If set to be valid dictionary version number, will return dictionary metadata with specified version. \nOtherwise, return the latest dictionary metadata.\n"
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1DLPDictionaryMetadataResponse'
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Unauthorized: Session tokens invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      tags:
      - Dlp
      summary: Symphony Updates a Dictionary
      description: 'Updates the dictionary''s basic metadata without content.

        This API cannot be used for creating a new dictionary.

        In case of update only "name" can be changed.

        Note: All related policies will also have versions updated.

        '
      parameters:
      - name: sessionToken
        in: header
        description: Session authentication token.
        required: true
        schema:
          type: string
      - name: keyManagerToken
        in: header
        description: Key Manager authentication token.
        required: true
        schema:
          type: string
      - name: dictId
        in: path
        description: Unique dictionary identifier
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1DLPDictionaryMetadataUpdateRequest'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1DLPDictionaryMetadataResponse'
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Unauthorized: Session tokens invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-codegen-request-body-name: body
    delete:
      tags:
      - Dlp
      summary: Symphony Delete a Dictionary
      description: 'Deletes a dictionary.

        Note: All related policies will be affected.

        '
      parameters:
      - name: sessionToken
        in: header
        description: Session authentication token.
        required: true
        schema:
          type: string
      - name: keyManagerToken
        in: header
        description: Key Manager authentication token.
        required: true
        schema:
          type: string
      - name: dictId
        in: path
        description: Unique dictionary identifier
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1DLPDictionaryMetadataResponse'
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Unauthorized: Session tokens invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v1/dlp/dictionaries/{dictId}/data/download:
    get:
      tags:
      - Dlp
      summary: Symphony Downloads Base 64 Encoded Dictionary Content
      description: Downloads Base 64 encoded dictionary content.
      parameters:
      - name: sessionToken
        in: header
        description: Session authentication token.
        required: true
        schema:
          type: string
      - name: keyManagerToken
        in: header
        description: Key Manager authentication token.
        required: true
        schema:
          type: string
      - name: dictId
        in: path
        description: Unique dictionary identifier
        required: true
        schema:
          type: string
      - name: dictVersion
        in: query
        description: "If set to be valid dictionary version number, will return dictionary with specified version. \nOtherwise, return the latest dictionary.\n"
        schema:
          type: string
      responses:
        '200':
          description: Attachment body as Base64 encoded string.
          content:
            application/octet-stream:
              schema:
                type: string
                format: byte
        '400':
          description: Client error, see response body for further details.
          content:
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Unauthorized: Session tokens invalid.'
          content:
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error, see response body for further details.
          content:
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/Error'
  /v1/dlp/dictionaries/{dictId}/data/upload:
    post:
      tags:
      - Dlp
      summary: Symphony Override Dictionary Content With Provided Content
      description: Override dictionary content with provided content.
      parameters:
      - name: sessionToken
        in: header
        description: Session authentication token.
        required: true
        schema:
          type: string
      - name: keyManagerToken
        in: header
        description: Key Manager authentication token.
        required: true
        schema:
          type: string
      - name: dictId
        in: path
        description: Unique dictionary identifier
        required: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
              - data
              properties:
                data:
                  type: string
                  format: binary
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1DLPDictionaryMetadataResponse'
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Unauthorized: Session tokens invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v1/dlp/violations/message:
    get:
      tags:
      - Dlp
      summary: Symphony Get Violations as a Result of Policy Enforcement on Messages
      parameters:
      - name: startTime
        in: query
        description: 'Timestamp of the first required violation.

          This is a long integer value representing milliseconds since Jan 1 1970

          '
        required: true
        schema:
          type: integer
          format: int64
      - name: endTime
        in: query
        description: 'Timestamp of the last required violation.

          This is a long integer value representing milliseconds since Jan 1 1970

          If unspecified, it will default to current time of the request.

          '
        schema:
          type: integer
          format: int64
      - name: next
        in: query
        description: Offset of the next chunk of violations. Value is null for the first request.
        schema:
          type: string
      - name: limit
        in: query
        description: 'Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500.

          '
        schema:
          type: integer
      - name: sessionToken
        in: header
        description: Session authentication token.
        required: true
        schema:
          type: string
      - name: keyManagerToken
        in: header
        description: Key Manager authentication token.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1DLPViolationMessageResponse'
        '204':
          description: No Messages.
          content: {}
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Unauthorized: Session tokens invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v1/dlp/violations/stream:
    get:
      tags:
      - Dlp
      summary: Symphony Get Violations as a Result of Policy Enforcement on Streams
      parameters:
      - name: startTime
        in: query
        description: 'Timestamp of the first required violation.

          This is a long integer value representing milliseconds since Jan 1 1970

          '
        required: true
        schema:
          type: integer
          format: int64
      - name: endTime
        in: query
        description: 'Timestamp of the last required violation.

          This is a long integer value representing milliseconds since Jan 1 1970

          If unspecified, it will default to current time of the request.

          '
        schema:
          type: integer
          format: int64
      - name: next
        in: query
        description: Offset of the next chunk of violations. Value is null for the first request.
        schema:
          type: string
      - name: limit
        in: query
        description: 'Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500.

          '
        schema:
          type: integer
      - name: sessionToken
        in: header
        description: Session authentication token.
        required: true
        schema:
          type: string
      - name: keyManagerToken
        in: header
        description: Key Manager authentication token.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1DLPViolationStreamResponse'
        '204':
          description: No Messages.
          content: {}
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Unauthorized: Session tokens invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v1/dlp/violations/signal:
    get:
      tags:
      - Dlp
      summary: Symphony Get Violations as a Result of Policy Enforcement on Signals
      parameters:
      - name: startTime
        in: query
        description: 'Timestamp of the first required violation.

          This is a long integer value representing milliseconds since Jan 1 1970

          '
        required: true
        schema:
          type: integer
          format: int64
      - name: endTime
        in: query
        description: 'Timestamp of the last required violation.

          This is a long integer value representing milliseconds since Jan 1 1970

          If unspecified, it will default to current time of the request.

          '
        schema:
          type: integer
          format: int64
      - name: next
        in: query
        description: Offset of the next chunk of violations. Value is null for the first request.
        schema:
          type: string
      - name: limit
        in: query
        description: 'Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500.

          '
        schema:
          type: integer
      - name: sessionToken
        in: header
        description: Session authentication token.
        required: true
        schema:
          type: string
      - name: keyManagerToken
        in: header
        description: Key Manager authentication token.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1DLPViolationSignalResponse'
        '204':
          description: No Messages.
          content: {}
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Unauthorized: Session tokens invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v3/dlp/policies:
    get:
      tags:
      - Dlp
      summary: Symphony Get All Policies
      description: Get all policies
      parameters:
      - name: sessionToken
        in: header
        description: Session authentication token.
        required: true
        schema:
          type: string
      - name: keyManagerToken
        in: header
        description: Key Manager authentication token.
        required: true
        schema:
          type: string
      - name: page
        in: query
        description: Optional parameter to specify which page to return (default is 0)
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: 'Optional parameter to specify the number of result to return per page, default is 50. Maximum is 50.

          '
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3DLPPoliciesCollectionResponse'
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Unauthorized: Session tokens invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      tags:
      - Dlp
      summary: Symphony Creates a Policy
      description: 'Creates a new policy with dictionary references.

        At the time of policy creation, the caller should only provide - contentTypes, name, scopes and type.

        The rest of the information is populated automatically.

        Note - You need to enable the policy after creation to start enforcing the policy.

        '
      parameters:
      - name: sessionToken
        in: header
        description: Session authentication token.
        required: true
        schema:
          type: string
      - name: keyManagerToken
        in: header
        description: Key Manager authentication token.
        required: true
        schema:
          type: string
      requestBody:
        description: Details about the policy that should be created.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V3DLPPolicyRequest'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3DLPPolicyResponse'
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Unauthorized: Session tokens invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-codegen-request-body-name: body
  /v3/dlp/policies/{policyId}:
    get:
      tags:
      - Dlp
      summary: Symphony Get a Policy
      description: Get a policy
      parameters:
      - name: sessionToken
        in: header
        description: Session authentication token.
        required: true
        schema:
          type: string
      - name: keyManagerToken
        in: header
        description: Key Manager authentication token.
        required: true
        schema:
          type: string
      - name: policyId
        in: path
        description: Unique dictionary identifier.
        required: true
        schema:
          type: string
      - name: policyVersion
        in: query
        description: "Optional parameter, if set to be valid policy version number,  will return policy with specified policyVersion. \nOtherwise, return the latest policy.\n"
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3DLPPolicyResponse'
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Unauthorized: Session tokens invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v3/dlp/policies/{policyId}/update:
    post:
      tags:
      - Dlp
      summary: Symphony Updates a Policy. Cannot Be Used for Creation
      description: 'Update the policy (name, type, contentTypes, scopes) and also the dictionaries for a policy.

        Warning: If you send empty list of dictionaries during the update operation, then all the

        dictionaries for this policy are deleted and policy is automatically disabled.

        Note: The policy should already exist.

        '
      parameters:
      - name: sessionToken
        in: header
        description: Session authentication token.
        required: true
        schema:
          type: string
      - name: keyManagerToken
        in: header
        description: Key Manager authentication token.
        required: true
        schema:
          type: string
      - name: policyId
        in: path
        description: Unique dictionary identifier.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V3DLPPolicyRequest'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3DLPPolicyResponse'
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Unauthorized: Session tokens invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-codegen-request-body-name: body
  /v3/dlp/policies/{policyId}/delete:
    post:
      tags:
      - Dlp
      summary: Symphony Delete a Policy
      description: 'Delete a policy.

        Note: Only disabled policy can be deleted

        '
      parameters:
      - name: sessionToken
        in: header
        description: Session authentication token.
        required: true
        schema:
          type: string
      - name: keyManagerToken
        in: header
        description: Key Manager authentication token.
        required: true
        schema:
          type: string
      - name: policyId
        in: path
        description: Unique dictionary identifier.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3DLPPolicyResponse'
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Unauthorized: Session tokens invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v3/dlp/policies/{policyId}/enable:
    post:
      tags:
      - Dlp
      summary: Symphony Enables a Policy
      description: Enables a policy.
      parameters:
      - name: sessionToken
        in: header
        description: Session authentication token.
        required: true
        schema:
          type: string
      - name: keyManagerToken
        in: header
        description: Key Manager authentication token.
        required: true
        schema:
          type: string
      - name: policyId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3DLPPolicyResponse'
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Unauthorized: Session tokens invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v3/dlp/policies/{policyId}/disable:
    post:
      tags:
      - Dlp
      summary: Symphony Disables a Policy
      description: Disables a policy.
      parameters:
      - name: sessionToken
        in: header
        description: Session authentication token.
        required: true
        schema:
          type: string
      - name: keyManagerToken
        in: header
        description: Key Manager authentication token.
        required: true
        schema:
          type: string
      - name: policyId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3DLPPolicyResponse'
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Unauthorized: Session tokens invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v3/dlp/violations/message:
    get:
      tags:
      - Dlp
      summary: Symphony Get Violations as a Result of Policy Enforcement on Messages
      description: Retrieves DLP v3 message related violations for a given time range
      parameters:
      - name: startTime
        in: query
        description: 'Timestamp of the first required violation.

          This is a long integer value representing milliseconds since Jan 1 1970

          '
        required: true
        schema:
          type: integer
          format: int64
      - name: endTime
        in: query
        description: 'Timestamp of the last required violation.

          This is a long integer value representing milliseconds since Jan 1 1970

          If unspecified, it will default to current time of the request.

          '
        schema:
          type: integer
          format: int64
      - name: next
        in: query
        description: Offset of the next chunk of violations. Value is null for the first request.
        schema:
          type: string
      - name: limit
        in: query
        description: 'Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500.

          '
        schema:
          type: integer
      - name: sessionToken
        in: header
        description: Session authentication token.
        required: true
        schema:
          type: string
      - name: keyManagerToken
        in: header
        description: Key Manager authentication token.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3DLPViolationMessageResponse'
        '204':
          description: No Messages.
          content: {}
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Unauthorized: Session tokens invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v3/dlp/violations/stream:
    get:
      tags:
      - Dlp
      summary: Symphony Get Violations as a Result of Policy Enforcement on Streams
      description: Retrieves DLP v3 signal related violations for a given time range
      parameters:
      - name: startTime
        in: query
        description: 'Timestamp of the first required violation.

          This is a long integer value representing milliseconds since Jan 1 1970

          '
        required: true
        schema:
          type: integer
          format: int64
      - name: endTime
        in: query
        description: 'Timestamp of the last required violation.

          This is a long integer value representing milliseconds since Jan 1 1970

          If unspecified, it will default to current time of the request.

          '
        schema:
          type: integer
          format: int64
      - name: next
        in: query
        description: Offset of the next chunk of violations. Value is null for the first request.
        schema:
          type: string
      - name: limit
        in: query
        description: 'Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500.

          '
        schema:
          type: integer
      - name: sessionToken
        in: header
        description: Session authentication token.
        required: true
        schema:
          type: string
      - name: keyManagerToken
        in: header
        description: Key Manager authentication token.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3DLPViolationStreamResponse'
        '204':
          description: No Messages.
          content: {}
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Unauthorized: Session tokens invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v3/dlp/violations/signal:
    get:
      tags:
      - Dlp
      summary: Symphony Get Violations as a Result of Policy Enforcement on Signals
      description: Retrieves DLP v3 signal related violations for a given time range
      parameters:
      - name: startTime
        in: query
        description: 'Timestamp of the first required violation.

          This is a long integer value representing milliseconds since Jan 1 1970

          '
        required: true
        schema:
          type: integer
          format: int64
      - name: endTime
        in: query
        description: 'Timestamp of the last required violation.

          This is a long integer value representing milliseconds since Jan 1 1970

          If unspecified, it will default to current time of the request.

          '
        schema:
          type: integer
          format: int64
      - name: next
        in: query
        description: Offset of the next chunk of violations. Value is null for the first request.
        schema:
          type: string
      - name: limit
        in: query
        description: 'Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500.

          '
        schema:
          type: integer
      - name: sessionToken
        in: header
        description: Session authentication token.
        required: true
        schema:
          type: string
      - name: keyManagerToken
        in: header
        description: Key Manager authentication token.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3DLPViolationSignalResponse'
        '204':
          description: No Messages.
          content: {}
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Unauthorized: Session tokens invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v3/dlp/violation/attachment:
    get:
      tags:
      - Dlp
      summary: Symphony Get attachments that were sent as part of messages that were flagged by the DLP System.
      description: Retrieves attachments from related message violations as a base64 encoded String.
      parameters:
      - name: fileId
        in: query
        description: ID of attachment that will be downloaded.
        required: true
        schema:
          type: string
      - name: violationId
        in: query
        description: ID of violation that corresponds to the flagged message that contains the attachment
        required: true
        schema:
          type: string
      - name: sessionToken
        in: header
        description: Session authentication token.
        required: true
        schema:
          type: string
      - name: keyManagerToken
        in: header
        description: Key Manager authentication token.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Attachment body as Base64 encoded string.
          content:
            application/octet-stream:
              schema:
                type: string
                format: byte
        '400':
          description: Client error, see response body for further details.
          content:
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Unauthorized: Session tokens invalid.'
          content:
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Resource not found.
          content:
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error, see response body for further details.
          content:
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    V1DLPStream:
      type: object
      properties:
        name:
          type: string
          description: Name of the Stream/Room.
        creatorPrettyName:
          type: string
          description: Name of the creator of the Room.
        publicRoom:
          type: boolean
          description: Is this a public room?
        crossPod:
          type: boolean
          description: Is this a cross pod scenario?
        allowExternal:
          type: boolean
          description: Is external messaging allowed
        creatorId:
          type: string
          description: Id of the creator of the Room.
        roomDescription:
          type: string
          description: Description of the Room.
        streamId:
          type: string
          description: ThreadId of the Room.
        state:
          type: string
          description: State of the Room (example CREATED etc)
        type:
          type: string
          description: Type of the Room (example ROOM (or IM or Wall))
        lastDisabled:
          type: integer
          description: Timestamp of last time the room is Disabled
          format: int64
        memberAddUserEnabled:
          type: boolean
          description: Is memberAddUserEnabled
        active:
          type: boolean
          description: Is Room Active
        discoverable:
          type: boolean
          description: Is Room discoverable
        readOnly:
          type: boolean
          description: Is Room read-only
        copyDisabled:
          type: boolean
          description: Is Room copyDisabled
        externalOwned:
          type: boolean
          description: Is Room externalOwned
        sendMessageDisabled:
          type: boolean
          description: Is sendMessage Disabled for this Room
        moderated:
          type: boolean
          description: Is room moderated
        shareHistoryEnabled:
          type: boolean
          description: Is room shareHistoryEnabled
        diagnostic:
          type: string
          description: 'A diagnostic message containing an error message in the event that the

            stream retrieval failed. May also be present in the case of a successful

            call if there is useful narrative to return.

            '
      description: Room details in the context of violation.
    V3DLPViolationStream:
      type: object
      properties:
        violation:
          $ref: '#/components/schemas/V3DLPViolation'
        stream:
          $ref: '#/components/schemas/V1DLPStream'
    V1DLPViolation:
      type: object
      properties:
        enforcementEventID:
          type: string
          description: Enforcement event ID. Unique ID that identifies this enforcement.
        entityID:
          type: string
          description: Entity ID is the content Id of the violation, for example, for messages, its the Id of the message
        createTime:
          type: integer
          description: Timestamp of the violation in milliseconds since Jan 1 1970
          format: int64
        lastModified:
          type: integer
          description: Timestamp of the last modification of violation in milliseconds since Jan 1 1970
          format: int64
        requesterId:
          type: integer
          description: Id of the requester responsible for the message/stream/signal
          format: int64
        matchedPolicies:
          $ref: '#/components/schemas/V1DLPMatchedPolicyList'
        action:
          type: string
          description: action taken such as BLOCK or WARN.  See outcome for a more detailed description of the outcome this action.
        outcome:
          $ref: '#/components/schemas/V1DLPOutcome'
        contentType:
          $ref: '#/components/schemas/V1DLPContentType'
        version:
          type: string
          description: Version of application which processed the message and produced this violation.
        ignoreDLPwarning:
          type: boolean
          description: Did the user chose to ignore DLP warning that was presented?
      description: A representation of a violation due to a message sent by a user of Symphony
    V4AttachmentInfo:
      required:
      - id
      - name
      - size
      - images
      type: object
      properties:
        id:
          type: string
          description: The attachment ID.
        name:
          type: string
          description: The file name.
        size:
          type: integer
          description: Size in bytes.
          format: int64
        images:
          type: array
          items:
            $ref: '#/components/schemas/V4ThumbnailInfo'
    V1DLPDictionaryMetadataCollectionResponse:
      type: object
      required:
      - items
      properties:
        items:
          type: array
          description: List of dictionary metadata
          items:
            $ref: '#/components/schemas/V1DLPDictionaryMetadata'
        page:
          type: integer
          description: Page number of current page
          format: int32
        pageCount:
          type: integer
          description: Total number of pages available
          format: int32
      description: List of dictionary metadata.
    V1DLPOutcome:
      type: object
      properties:
        type:
          type: string
          description: Outcome of DLP enforcement
      description: A representation of outcome of DLP message/stream/signal sent by a user of Symphony
    V3DLPPolicyRequest:
      required:
      - appliesTo
      - name
      - scopes
      type: object
      properties:
        name:
          type: string
          description: 'Unique name of a policy, max 30 characters. Cannot be empty. All the leading and trailing blank spaces are trimmed.

            '
        scopes:
          type: array
          description: 'List of communication scopes. Possible values are "Internal" (for Internal conversations) or "External" (for External conversations).

            You can apply both scopes if you set it to ["Internal", "External"].

            '
          items:
            type: string
        appliesTo:
          type: array
          items:
            $ref: '#/components/schemas/V3DLPPolicyAppliesTo'
      description: Request to be used to get policies.
    Error:
      type: object
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
    V3DLPPolicyResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/V3DLPPolicy'
      description: Policy Response.
    V1DLPMatchedPolicy:
      type: object
      properties:
        id:
          type: string
          description: Id of the policy
        version:
          type: string
          description: Version of the policy
        policyName:
          type: string
          description: Name of the policy
        type:
          type: string
          description: Whether BLOCK or WARN
        terms:
          type: string
          description: List of decrypted matched keywords in the policy
        diagnostic:
          type: string
          description: 'A diagnostic message containing an error message in the event that the

            decryption of terms failed. May also be present in the case of a successful

            call if there is useful narrative to return.

            '
      description: A representation of policy that matched the violation with a list of matched keywords in the policy
    V4User:
      type: object
      properties:
        userId:
          type: integer
          description: Id of user
          format: int64
        firstName:
          type: string
          description: First name of user
        lastName:
          type: string
          description: Last name of user
        displayName:
          type: string
          description: User display name
        email:
          type: string
          description: Email of user
        username:
          type: string
          description: Applicable only to internal users
    V1DLPDictionaryMetadataCreateRequest:
      required:
      - name
      - type
      type: object
      properties:
        name:
          type: string
          description: 'The name of dictionary

            '
        type:
          type: string
          description: 'The type of dictionary, which specify the content is a list of words or a list of regexes.

            By default set to "Word" if not specified. Possible values - Word, Regex

            '
      description: Dictionary's metadata (excluding content) to use for dictionary create operations.
    V1DLPDictionaryRef:
      required:
      - name
      type: object
      properties:
        dictId:
          type: string
          description: Unique dictionary id
        name:
          type: string
          description: Unique name of a dictionary, max 30 characters, with trimmed leading and trailing blank spaces.
        version:
          type: string
          description: 'The version of a dictionary, in format "major.minor".

            Initial value will set by backend as "1.0" when created.

            Whenever the dictionary version needs to be changed, the minor version by 1 unless minor == 999, then the major version is increased by 1 until it reaches 999.

            '
      description: Basic information needed to identify a dictionary
    V1DLPViolationMessage:
      type: object
      properties:
        violation:
          $ref: '#/components/schemas/V1DLPViolation'
        message:
          $ref: '#/components/schemas/V4Message'
        diagnostic:
          type: string
          description: 'A diagnostic message containing an error message in the event there are parsing errors.

            May also be present in the case of a successful call if there is useful narrative to return.

            '
    V1DLPPolicy:
      required:
      - contentTypes
      - name
      - scopes
      - dictionaryRefs
      - type
      type: object
      properties:
        active:
          type: boolean
          description: Indicate whether the policy is active or not
        contentTypes:
          type: array
          description: 'The list of content types that policy should apply to. Cannot be empty. Policy content types could be either of "Messages", "RoomMeta", "SignalMeta".

            Default is set to ["Messages"] if not specified.

            '
          items:
            type: string
        creationDate:
          type: integer
          description: Creation time of the policy in milliseconds elapsed as of epoch time.
          format: int64
        creatorId:
          type: string
          description: Numeric userId of the creator
        dictionaryRefs:
          type: array
          description: List of dictionaries.
          items:
            $ref: '#/components/schemas/V1DLPDictionaryRef'
        lastDisabledDate:
          type: integer
          description: Recent disable time of the policy in milliseconds elapsed as of epoch time.
          format: int64
        lastUpdatedDate:
          type: integer
          description: Recent update time of the policy in milliseconds elapsed as of epoch time.
          format: int64
        name:
          type: string
          description: Unique name of a policy, max 30 characters. Cannot be empty. All the leading and trailing blank spaces are trimmed.
        policyId:
          type: string
          description: Policy Id
        scopes:
          type: array
          description: 'List of communication scopes. Possible values are "Internal" (for Internal conversations) or "External" (for External conversations).

            You can apply both scopes if you set it to ["Internal", "External"].

            '
          items:
            type: string
        type:
          type: string
          description: Type of policy. Possible values "Block" or "Warn".
        version:
          type: string
          description: 'The version of a dictionary, in format "major.minor". Initial value will set by backend as "1.0" when created.

            Whenever the dictionary version needs to be changed, the minor version by 1 unless minor == 999, then the major version is increased by 1 until it reaches 999.

            '
      description: The policy object for expression filter, one policy can have multiple dictionaries
    V3DLPViolationStreamResponse:
      type: object
      required:
      - violations
      properties:
        violations:
          type: array
          items:
            $ref: '#/components/schemas/V3DLPViolationStream'
        nextOffset:
          type: string
          description: 'Offset for the next chunk of violations to be submitted in the next request.

            Value is null if there are no further violations.

            '
    V1DLPDictionaryMetadataResponse:
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/V1DLPDictionaryMetadata'
      description: Dictionary response containing dictionary metadata.
    V1DLPViolationSignalResponse:
      type: object
      required:
      - violations
      properties:
        violations:
          type: array
          description: A representation of list of violations due to signal creation/update sent by a user of Symphony
          items:
            $ref: '#/components/schemas/V1DLPViolationSignal'
        nextOffset:
          type: string
          description: Offset for the next chunk of violations to be submitted in the next request.  Value is null if there are no further violations.
    V4Message:
      type: object
      properties:
        messageId:
          type: string
          description: Id of the message
        parentMessageId:
          type: string
          description: Id of the parent message, set when the message is a reply to another message or a forwarded message. Since Agent 20.14.
          x-since: 20.14
        timestamp:
          type: integer
          description: Timestamp of the message in milliseconds since Jan 1 1970
          format: int64
        message:
          type: string
          description: Message content in MessageMLV2
          format: MessageMLV2
        sharedMessage:
          $ref: '#/components/schemas/V4Message'
        data:
          type: string
          description: Message data in EntityJSON
          format: JSON
        attachments:
          type: array
          default: []
          description: Message attachments
          items:
            $ref: '#/components/schemas/V4AttachmentInfo'
        user:
          $ref: '#/components/schemas/V4User'
        stream:
          $ref: '#/components/schemas/V4Stream'
        externalRecipients:
          type: boolean
          description: Indicates if the message have external recipients. Only present on real time messaging.
        diagnostic:
          type: string
          description: 'Details if event failed to parse for any reason.  The contents of this field may not be useful,

            depending on the nature of the error. Only present when error occurs.

            '
        userAgent:
          type: string
          description: 'User agent string for client that sent the message.  Allows callers to identify which client sent the

            origin message (e.g. API Agent, SFE Client, mobile, etc)

            '
        originalFormat:
          type: string
          description: 'Indicates the format in which the message was originally sent.  This could have been either:

            - com.symphony.markdown - Markdown OR Message ML V1

            - com.symphony.messageml.v2 - Message ML V2

            '
        disclaimer:
          type: string
          description: 'Message that may be sent along with a regular message if configured for the POD,

            usually the first message sent in a room that day.

            '
        sid:
          type: string
          description: 'Unique session identifier from where the message was created.

            '
          example: fa691cd3-484a-4109-aeb2-57c05b78c95b
        replacing:
          type: string
          description: Id of the message that the current message is replacing (present only if set)
        replacedBy:
          type: string
          description: Id of the message that the current message is being replaced with (present only if set)
        initialTimestamp:
          type: integer
          description: "Timestamp of when the initial message has been created in milliseconds since \nJan 1 1970 (present only if set)\n"
          format: int64
        initialMessageId:
          type: string
          description: Id the the initial message that has been updated (present only if set)
        silent:
          type: boolean
          description: When false the user/s will receive the message update as unread (true by default)
          x-since: 20.14
      description: A representation of a message sent by a user of Symphony
    V1DLPPolicyRequest:
      required:
      - contentTypes
      - name
      - scopes
      - type
      type: object
      properties:
        contentTypes:
          type: array
          description: 'The list of content types that policy should apply to. Cannot be empty. Policy content types could be either of "Messages", "RoomMeta", "SignalMeta".

            Default is set to ["Messages"] if not specified.

            '
          items:
            type: string
        dictionaryIds:
          type: array
          description: List of dictionaries Ids for the policy.
          items:
            type: string
        name:
          type: string
          description: Unique name of a policy, max 30 characters. Cannot be empty. All the leading and trailing blank spaces are trimmed.
        scopes:
          type: array
          description: 'List of communication scopes. Possible values are "Internal" (for Internal conversations) or "External" (for External conversations).

            You can apply both scopes if you set it to ["Internal", "External"].

            '
          items:
            type: string
        type:
          type: string
          description: Type of policy. Possible values "Block" or "Warn".
      description: The policy object to use for creating/updating a policy.
    V1DLPPoliciesCollectionResponse:
      type: object
      required:
      - policies
      properties:
        policies:
          type: array
          description: List of policies
          items:
            $ref: '#/components/schemas/V1DLPPolicy'
        page:
          type: integer
          description: Page number of current page
          format: int32
        pageCount:
          type: integer
          description: Total number of pages available
          format: int32
      description: List of policies
    V1DLPViolationSignal:
      type: object
      properties:
        violation:
          $ref: '#/components/schemas/V1DLPViolation'
        signal:
          $ref: '#/components/schemas/V1DLPSignal'
    V1DLPViolationStreamResponse:
      type: object
      required:
      - violations
      properties:
        violations:
          type: array
          items:
            $ref: '#/components/schemas/V1DLPViolationStream'
        nextOffset:
          type: string
          description: Offset for the next chunk of violations to be submitted in the next request.  Value is null if there are no further violations.
    V3DLPFileSizeConfig:
      type: object
      properties:
        sizeLimit:
          type: integer
          format: int32
      description: File size config defines maximum allowed size of file. Default max size limit is 20 MB.
    V1DLPDictionaryMetadataUpdateRequest:
      required:
      - name
      type: object
      properties:
        name:
          type: string
          description: The name of dictionary
      description: Dictionary's metadata (excluding content) to use for dictionary update operations.
    V3DLPFileClassifierConfig:
      required:
      - applicableFileTypes
      - classifiers
      type: object
      properties:
        classifiers:
          type: object
          additionalProperties:
            type: string
          description: 'Classifier is defined as a Key and its Value: e.g.: "classification": "Internal".

            Name and value can contain UTF-8 characters. Neither the name nor value cannot be left empty.

            Maximum 30 characters for the name and value, case insensitive.

            If files contains k-v pairs in the classifers map, it means a match. Maximum 30 classifiers per policy.

            '
        applicableFileTypes:
          type: array
          description: File types that can be applied. Can be ["PDF", "WORD", "EXCEL", "POWERPOINT", "ZIP", "CSV", "TXT"].
          items:
            type: string
    V3DLPPolicyAppliesTo:
      required:
      - action
      - dataType
      - rules
      type: object
      properties:
        dataType:
          type: string
          description: 'The list of data types that policy should apply to. Can''t be empty.

            Can be ["Messages","RoomMeta", "SignalMeta", "FileContent", "FileMeta"].

            '
        action:
          type: string
          description: 'Action to be taken on violation detection.

            Can be ["Block", "Warn", "LogOnly"]. The default is "LogOnly".

            '
        rules:
          type: array
          items:
            $ref: '#/components/schemas/V3DLPRule'
    V1DLPContentType:
      type: object
      properties:
        type:
          type: string
          description: content type
      description: A representation of content type of message sent by a user of Symphony (message/stream/signal)
    V3DLPPolicy:
      type: object
      required:
      - appliesTo
      properties:
        id:
          type: string
          description: Unique identifier for policy.
        policyId:
          type: string
          description: Policy Id.
        version:
          type: string
          description: 'The version of the policy, in format "major.minor". Initial value will set by backend as "3.0" when created.

            Whenever the policy version needs to be changed, the minor version by 1 unless minor == 999,

            then the major version is increased by 1 until it reaches 999.

            '
        name:
          type: string
          description: 'Unique name of policy, max 30 characters. Cannot be empty. All the leading and trailing blank spaces are trimmed.

            '
        creatorId:
          type: integer
          description: Numeric userId of the creator.
          format: int64
        scopes:
          type: array
          description: 'List of communication scopes. Possible values are "Internal" (for Internal conversations) or "External" (for External conversations).

            You can apply both scopes if you set it to ["Internal", "External"].

            '
          items:
            type: string
        appliesTo:
          type: array
          items:
            $ref: '#/components/schemas/V3DLPPolicyAppliesTo'
        active:
          type: boolean
          description: Indicate whether the policy is active or not.
        deleted:
          type: boolean
          description: Indicate whether the policy is deleted or not.
        creationDate:
          type: integer
          description: Creation time of the policy in milliseconds elapsed as of epoch time.
          format: int64
        lastUpdatedDate:
          type: integer
          description: Recent update time of the policy in milliseconds elapsed as of epoch time.
          format: int64
        lastDisabledDate:
          type: integer
          description: Recent disable time of the policy in milliseconds elapsed as of epoch time.
          format: int64
        systemPolicy:
          type: boolean
      description: 'A policy is the main entity of V3 policy/rule system. It is responsible to define rules and add scope constraints to the engine.

        '
    V3DLPViolation:
      type: object
      properties:
        enforcementEventID:
          type: string
          description: Enforcement event ID. Unique ID that identifies this enforcement.
        entityID:
          type: string
          description: Entity ID is the content Id of the violation. For example, for messages it's the Id of the message
        createTime:
          type: integer
          description: Timestamp of the violation in milliseconds since Jan 1 1970
          format: int64
        lastModified:
          type: integer
          description: Timestamp of the last modification of violation in milliseconds since Jan 1 1970
          format: int64
        requesterId:
          type: integer
          description: Id of the requester responsible for the message/stream/signal
          format: int64
        details:
          type: array
          description: JSON representation of the details of the violation.
          items:
            type: object
        action:
          type: string
          description: action taken such as BLOCK or WARN.  See outcome for a more detailed description of the outcome this action.
        outcome:
          $ref: '#/components/schemas/V1DLPOutcome'
        version:
          type: string
          description: Version of application which processed the message and produced this violation.
        ignoreDLPwarning:
          type: boolean
          description: Did the user chose to ignore DLP warning that was presented?
      description: A representation of a violation due to an event created by a user of Symphony
    V3DLPFilePasswordConfig:
      required:
      - applicableFileTypes
      - matchCriteria
      type: object
      properties:
        applicableFileTypes:
          type: array
          description: File types that can be applied. Can be ["PDF", "WORD", "EXCEL", "POWERPOINT", "ZIP", "CSV", "TXT"].
          items:
            type: string
        matchCriteria:
          type: string
          description: 'Based on the criteria, whether a file is password protected or not means a match.

            Can be ["PASSWORD_PROTECTED", "NOT_PASSWORD_PROTECTED"]. The default is "NOT_PASSWORD_PROTECTED".

            '
      description: Password protected detection config for files that are password protected or not.
    V1DLPViolationMessageResponse:
      type: object
      required:
      - violations
      properties:
        violations:
          type: array
          description: A representation of list of violations due to messages sent by a user of Symphony
          items:
            $ref: '#/components/schemas/V1DLPViolationMessage'
        nextOffset:
          type: string
          description: Offset for the next chunk of violations to be submitted in the next request.  Value is null if there are no further violations.
    V3DLPTextMatchConfig:
      type: object
      required:
      - dictionaries
      - applicableFileTypes
      properties:
        dictionaries:
          type: array
          items:
            $ref: '#/components/schemas/V3DLPDictionaryMeta'
        countUniqueOccurrences:
          type: integer
          format: int32
        applicableFileTypes:
          type: array
          description: 'File types must be applied only for rule type "FileContent", otherwise must be empty.

            Can be ["PDF", "WORD", "EXCEL", "POWERPOINT", "ZIP", "CSV", "TXT"].

            '
          items:
            type: string
      description: 'This is a configuration that can be used to match text or regex.

        Configuration that can be used by a rule. This is a configuration that can be used to match text or regex.

        This configuration also corresponds to V2 TextMatch/RegexMatch of dictionaries.

        '
    V1DLPMatchedPolicyList:
      type: array
      description: List of policies that matched the violation.
      items:
        $ref: '#/components/schemas/V1DLPMatchedPolicy'
    V1DLPViolationStream:
      type: object
      properties:
        violation:
          $ref: '#/components/schemas/V1DLPViolation'
        stream:
          $ref: '#/components/schemas/V1DLPStream'
    V3DLPViolationSignal:
      type: object
      properties:
        violation:
          $ref: '#/components/schemas/V3DLPViolation'
        signal:
          $ref: '#/components/schemas/V1DLPSignal'
    V3DLPViolationMessage:
      type: object
      properties:
        violation:
          $ref: '#/components/schemas/V3DLPViolation'
        message:
          $ref: '#/components/schemas/V4Message'
        sharedMessage:
          $ref: '#/components/schemas/V4Message'
        diagnostic:
          type: string
          description: 'A diagnostic message containing an error message in the event there are parsing errors.

            May also be present in the case of a successful call if there is useful narrative to return.

            '
    V3DLPRule:
      required:
      - name
      - type
      type: object
      properties:
        id:
          type: string
        type:
          type: string
          description: Type of a rule used by policy. Can be ["UNKNOWN", "TEXT_MATCH", "FILE_EXTENSION", "FILE_SIZE", "FILE_PASSWORD", "FILE_CLASSIFIER"].
        name:
          type: string
          description: Name for rule.
        textMatchConfig:
          $ref: '#/components/schemas/V3DLPTextMatchConfig'
        fileSizeConfig:
          $ref: '#/components/schemas/V3DLPFileSizeConfig'
        fileExtensionConfig:
          $ref: '#/components/schemas/V3DLPFileExtensionConfig'
        filePasswordConfig:
          $ref: '#/components/schemas/V3DLPFilePasswordConfig'
        fileClassifierConfig:
          $ref: '#/components/schemas/V3DLPFileClassifierConfig'
      description: 'A Rule defines the actual matching specification for policies. It holds a type and a configuration

        for the rule, these properties should be used to build the corresponding matching implementation.

        Only one of the configuration property should be set [textMatchConfig, fileSizeConfig, fileExtensionConfig, filePasswordConfig, fileClassifierConfig].

        '
    V4ThumbnailInfo:
      type: object
      properties:
        id:
          type: string
          description: The thumbnail ID.
        dimension:
          type: string
          description: The thumbnail pixel size.
    V3DLPViolationMessageResponse:
      type: object
      required:
      - violations
      properties:
        violations:
          type: array
          description: A representation of list of violations due to messages sent by a user of Symphony
          items:
            $ref: '#/components/schemas/V3DLPViolationMessage'
        nextOffset:
          type: string
          description: "Offset for the next chunk of violations to be submitted in the next request. \nValue is null if there are no further violations.\n"
    V4Stream:
      type: object
      properties:
        streamId:
          type: string
          description: Id of stream
        streamType:
          type: string
          description: "Stream type, possible values are:\n  - IM\n  - MIM\n  - ROOM\n  - POST\n"
        roomName:
          type: string
          description: Applicable only to rooms
        members:
          type: array
          description: Applicable only to IM Created
          items:
            $ref: '#/components/schemas/V4User'
        external:
          type: boolean
        crossPod:
          type: boolean
        recipientTenantIds:
          type: array
          description: 'List of tenant identifiers (aka pod identifiers) involved in the conversation. It contains more than one

            item if the conversation is external. Field is only present for real time messaging.

            '
          items:
            type: integer
            format: int32
          x-since: 24.2
    V1DLPSignal:
      type: object
      properties:
        name:
          type: string
          description: Name of the Signal
        rules:
          type: string
          description: Signal rules decrypted.
        diagnostic:
          type: string
          description: 'A diagnostic message containing an error message in the event that the

            signal decryption failed. May also be present in the case of a successful

            call if there is useful narrative to return.

            '
      description: Signal details
    V1DLPDictionaryMetadata:
      required:
      - dictRef
      - type
      type: object
      properties:
        creationDate:
          type: integer
          description: Creation time of the dictionary in milliseconds elapsed as of epoch time.
          format: int64
        creatorId:
          type: string
          description: Numeric userId of the creator
        dictRef:
          $ref: '#/components/schemas/V1DLPDictionaryRef'
        lastUpdatedDate:
          type: integer
          description: The recent update time of the dictionary in milliseconds
          format: int64
        type:
          type: string
          description: 'The type of dictionary, which specify the content is a list of words or a list of regexes.

            By default set to "Word" if not specified. Possible values - Word, Regex

            '
      description: Dictionary's metadata (excluding content)
    V3DLPViolationSignalResponse:
      type: object
      required:
      - violations
      properties:
        violations:
          type: array
          description: A representation of list of violations due to signal creation/update sent by a user of Symphony
          items:
            $ref: '#/components/schemas/V3DLPViolationSignal'
        nextOffset:
          type: string
          description: 'Offset for the next chunk of violations to be submitted in the next request.

            Value is null if there are no further violations.

            '
    V3DLPPoliciesCollectionResponse:
      type: object
      required:
      - policies
      properties:
        policies:
          type: array
          description: List of policies.
          items:
            $ref: '#/components/schemas/V3DLPPolicy'
        page:
          type: integer
          description: The starting page for pagination.
          format: int32
        size:
          type: integer
          description: Size of policies displayed per page.
          format: int32
        pageCount:
          type: integer
          description: Total number of pages available.
          format: int32
      description: List of policies.
    V3DLPFileExtensionConfig:
      required:
      - allowLists
      - blockLists
      type: object
      properties:
        allowLists:
          type: array
          description: File extensions that are allowed.
          items:
            type: string
        blockLists:
          type: array
          description: File extensions that are blocked.
          items:
            type: string
      description: Extension detection config for allowed and blocked types of file extensions.
    V3DLPDictionaryMeta:
      required:
      - dictId
      - name
      - version
      type: object
      properties:
        dictId:
          type: string
        version:
          type: string
        name:
          type: string
      description: Identity of a dictionary.
    V1DLPPolicyResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/V1DLPPolicy'
      description: Policy Response