mammoth-io Deauthorization API

openapi: 3.2.0
info:
  title: Mammoth Io Deauthorization API
  version: 0.1.0
  contact:
    name: Mammoth Analytics
    url: https://mammoth.io
    email: support@mammoth.io
  description: 'Operations tagged Deauthorization across 2 of this provider''s published API definitions: app.mammoth.io-openapi.json, mammoth-io-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /api/v2
security:
- bearerAuth: []
- apiKey: []
  apiSecret: []
  workspaceId: []
tags:
- name: Deauthorization
paths:
  /gdpr_hooks/{integration_name}/deauthorization:
    post:
      tags:
      - Deauthorization
      summary: Delete user's data from the system
      description: This endpoint is used to delete user's data from the system
      operationId: DeleteUserData
      parameters:
      - name: integration_name
        in: path
        schema:
          $ref: '#/components/schemas/IntegrationNameEnum'
        description: Integration for which the data should be deleted
        required: true
        deprecated: false
        examples:
          integration_name-example-1:
            summary: Integration name
            value: zoom
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ZoomDeAuthorizationRequest'
        required: true
      responses:
        '200':
          description: Successful create
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeAuthorizationPostResponse'
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Validation Exception
                examples:
                - status_code: 400
                  detail: Bad Request
                  extra: {}
      deprecated: false
    servers:
    - url: /api/v2
components:
  schemas:
    ZoomPayload:
      properties:
        account_id:
          type: string
          minLength: 1
          description: Account ID of the user
          examples:
          - value: EabCDEFghiLHMA
        client_id:
          type: string
          minLength: 1
          description: Client ID of the user
          examples:
          - value: ADZ9k9bTWmGUoUbECUKU_a
        deauthorization_time:
          type: string
          format: date-time
          description: Time of deauthorization
          examples:
          - value: '2019-06-17T13:52:28.632Z'
        signature:
          type: string
          minLength: 1
          description: Signature of the request
          examples:
          - value: 827edc3452044f0bc86bdd5684afb7d1e6becfa1a767f24df1b287853cf73000
        user_id:
          type: string
          minLength: 1
          description: User ID of the user
          examples:
          - value: z9jkdsfsdfjhdkfjQ
      type: object
      required:
      - account_id
      - client_id
      - deauthorization_time
      - signature
      - user_id
      title: ZoomPayload
    DeAuthorizationPostResponse:
      properties:
        message:
          type: string
          description: Message
          examples:
          - value: Requested data has been deleted successfully.
      type: object
      required:
      - message
      title: DeAuthorizationPostResponse
    IntegrationNameEnum:
      type: string
      enum:
      - zoom
      title: IntegrationNameEnum
      description: Integration for which the data should be deleted
      examples:
      - zoom
    ZoomDeAuthorizationRequest:
      properties:
        event:
          type: string
          minLength: 1
          description: Name of the event
          examples:
          - value: app_deauthorized
        payload:
          $ref: '#/components/schemas/ZoomPayload'
      type: object
      required:
      - event
      - payload
      title: ZoomDeAuthorizationRequest
      description: Details of the event
      examples:
      - event: app_deauthorized
        payload:
          account_id: EabCDEFlhiLHMA
          user_id: z9jkdsfsdfjhdkfjQ
          signature: 827ed83452044f0bc86bdd5684afb7d1e6becfa1a767f24df1b287853cf73000
          deauthorization_time: '2019-06-17T13:52:28.632Z'
          client_id: ADZ9kgbTWmGUoUbECUKU_a
  securitySchemes:
    bearerAuth:
      type: http
      description: 'Primary credential. Authorization: Bearer mm_<token>. The token is issued server-side and shown once at creation.'
      scheme: bearer
    apiKey:
      type: apiKey
      description: Deprecated — use bearerAuth.
      name: X-API-KEY
      in: header
    apiSecret:
      type: apiKey
      description: Deprecated — use bearerAuth.
      name: X-API-SECRET
      in: header
    workspaceId:
      type: apiKey
      description: Required with X-API-KEY and X-API-SECRET. Deprecated with them — use bearerAuth.
      name: X-WORKSPACE-ID
      in: header
x-refined-from:
- app.mammoth.io-openapi.json
- mammoth-io-openapi.json