DriveKitPushUserEvent.yaml

openapi: 3.0.0
info:
  title: PushUserEvent
  version: '1.0'
  description: This API endpoint allows receiving user events (e.g., user deletion) that you should acknowledge.
servers:
  - url: 'http://api.mycompany.com'
paths:
  /push/userevent:
    post:
      summary: Push user event
      operationId: post-push-userevent
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
      description: The push user event endpoint allows you to receive user events (e.g., user deletion) that you should acknowledge.
      parameters:
        - schema:
            type: string
          in: header
          description: 'Authorization header (preferably OAuth2 token)'
          name: Authorization
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: object
              properties:
                userId:
                  type: string
                  description: User unique identifier
                event:
                  type: string
                  description: User event type
                  enum: 
                    - USER_DELETION
                date:
                  type: string
                  format: date-time
                  example: "2025-01-30T07:23:22.000+0000"
                  description: User event date (e.g., deletion date)
            examples:
              Example:
                value:
                  userId: 6030ebe4ea60426b34e9b3bf
                  event: USER_DELETION
                  date: "2025-01-30T07:23:22.000+0000"
    parameters: []
components:
  schemas: {}