Ethernovia Audit User Trail API

The Audit-user-trail API from Ethernovia — 2 operation(s) for audit-user-trail.

OpenAPI Specification

ethernovia-audit-user-trail-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: 1.0.0
  title: DOCUMENTATION Audit User Trail API
  description: ''
  termsOfService: YOUR_TERMS_OF_SERVICE_URL
  contact:
    name: TEAM
    email: contact-email@something.io
    url: mywebsite.io
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  x-generation-date: '2026-07-07T06:23:13.532Z'
servers:
- url: http://localhost:1337/api
  description: Development server
security:
- bearerAuth: []
tags:
- name: Audit-user-trail
paths:
  /audit-user-trails:
    get:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditUserTrailListResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Audit-user-trail
      parameters:
      - name: sort
        in: query
        description: Sort by attributes ascending (asc) or descending (desc)
        deprecated: false
        required: false
        schema:
          type: string
      - name: pagination[withCount]
        in: query
        description: 'Return page/pageSize (default: true)'
        deprecated: false
        required: false
        schema:
          type: boolean
      - name: pagination[page]
        in: query
        description: 'Page number (default: 0)'
        deprecated: false
        required: false
        schema:
          type: integer
      - name: pagination[pageSize]
        in: query
        description: 'Page size (default: 25)'
        deprecated: false
        required: false
        schema:
          type: integer
      - name: pagination[start]
        in: query
        description: 'Offset value (default: 0)'
        deprecated: false
        required: false
        schema:
          type: integer
      - name: pagination[limit]
        in: query
        description: 'Number of entities to return (default: 25)'
        deprecated: false
        required: false
        schema:
          type: integer
      - name: fields
        in: query
        description: 'Fields to return (ex: title,author)'
        deprecated: false
        required: false
        schema:
          type: string
      - name: populate
        in: query
        description: Relations to return
        deprecated: false
        required: false
        schema:
          type: string
      - name: filters
        in: query
        description: Filters to apply
        deprecated: false
        required: false
        schema:
          type: object
          additionalProperties: true
        style: deepObject
      - name: locale
        in: query
        description: Locale to apply
        deprecated: false
        required: false
        schema:
          type: string
      operationId: get/audit-user-trails
    post:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditUserTrailResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Audit-user-trail
      parameters: []
      operationId: post/audit-user-trails
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuditUserTrailRequest'
  /audit-user-trails/{id}:
    get:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditUserTrailResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Audit-user-trail
      parameters:
      - name: id
        in: path
        description: ''
        deprecated: false
        required: true
        schema:
          type: string
      operationId: get/audit-user-trails/{id}
    put:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditUserTrailResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Audit-user-trail
      parameters:
      - name: id
        in: path
        description: ''
        deprecated: false
        required: true
        schema:
          type: string
      operationId: put/audit-user-trails/{id}
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuditUserTrailRequest'
    delete:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: integer
                format: int64
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Audit-user-trail
      parameters:
      - name: id
        in: path
        description: ''
        deprecated: false
        required: true
        schema:
          type: string
      operationId: delete/audit-user-trails/{id}
components:
  schemas:
    AuditUserTrailResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AuditUserTrail'
        meta:
          type: object
    AuditUserTrail:
      type: object
      properties:
        id:
          oneOf:
          - type: string
          - type: number
        documentId:
          type: string
        user:
          type: object
          properties:
            id:
              oneOf:
              - type: string
              - type: number
            documentId:
              type: string
            username:
              type: string
            email:
              type: string
              format: email
            provider:
              type: string
            resetPasswordToken:
              type: string
            confirmationToken:
              type: string
            confirmed:
              type: boolean
            blocked:
              type: boolean
            role:
              type: object
              properties:
                id:
                  oneOf:
                  - type: string
                  - type: number
                documentId:
                  type: string
                name:
                  type: string
                description:
                  type: string
                type:
                  type: string
                permissions:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        oneOf:
                        - type: string
                        - type: number
                      documentId:
                        type: string
                      action:
                        type: string
                      role:
                        type: object
                        properties:
                          id:
                            oneOf:
                            - type: string
                            - type: number
                          documentId:
                            type: string
                      createdAt:
                        type: string
                        format: date-time
                      updatedAt:
                        type: string
                        format: date-time
                      publishedAt:
                        type: string
                        format: date-time
                      createdBy:
                        type: object
                        properties:
                          id:
                            oneOf:
                            - type: string
                            - type: number
                          documentId:
                            type: string
                          firstname:
                            type: string
                          lastname:
                            type: string
                          username:
                            type: string
                          email:
                            type: string
                            format: email
                          resetPasswordToken:
                            type: string
                          registrationToken:
                            type: string
                          isActive:
                            type: boolean
                          roles:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  oneOf:
                                  - type: string
                                  - type: number
                                documentId:
                                  type: string
                                name:
                                  type: string
                                code:
                                  type: string
                                description:
                                  type: string
                                users:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        oneOf:
                                        - type: string
                                        - type: number
                                      documentId:
                                        type: string
                                permissions:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        oneOf:
                                        - type: string
                                        - type: number
                                      documentId:
                                        type: string
                                      action:
                                        type: string
                                      actionParameters: {}
                                      subject:
                                        type: string
                                      properties: {}
                                      conditions: {}
                                      role:
                                        type: object
                                        properties:
                                          id:
                                            oneOf:
                                            - type: string
                                            - type: number
                                          documentId:
                                            type: string
                                      apiToken:
                                        type: object
                                        properties:
                                          id:
                                            oneOf:
                                            - type: string
                                            - type: number
                                          documentId:
                                            type: string
                                          name:
                                            type: string
                                          description:
                                            type: string
                                          kind:
                                            type: string
                                            enum:
                                            - content-api
                                            - admin
                                          type:
                                            type: string
                                            enum:
                                            - read-only
                                            - full-access
                                            - custom
                                          accessKey:
                                            type: string
                                          encryptedKey:
                                            type: string
                                          lastUsedAt:
                                            type: string
                                            format: date-time
                                          permissions:
                                            type: array
                                            items:
                                              type: object
                                              properties:
                                                id:
                                                  oneOf:
                                                  - type: string
                                                  - type: number
                                                documentId:
                                                  type: string
                                                action:
                                                  type: string
                                                token:
                                                  type: object
                                                  properties:
                                                    id:
                                                      oneOf:
                                                      - type: string
                                                      - type: number
                                                    documentId:
                                                      type: string
                                                createdAt:
                                                  type: string
                                                  format: date-time
                                                updatedAt:
                                                  type: string
                                                  format: date-time
                                                publishedAt:
                                                  type: string
                                                  format: date-time
                                                createdBy:
                                                  type: object
                                                  properties:
                                                    id:
                                                      oneOf:
                                                      - type: string
                                                      - type: number
                                                    documentId:
                                                      type: string
                                                updatedBy:
                                                  type: object
                                                  properties:
                                                    id:
                                                      oneOf:
                                                      - type: string
                                                      - type: number
                                                    documentId:
                                                      type: string
                                                locale:
                                                  type: string
                                                localizations:
                                                  type: array
                                                  items:
                                                    type: object
                                                    properties:
                                                      id:
                                                        oneOf:
                                                        - type: string
                                                        - type: number
                                                      documentId:
                                                        type: string
                                          adminPermissions:
                                            type: array
                                            items:
                                              type: object
                                              properties:
                                                id:
                                                  oneOf:
                                                  - type: string
                                                  - type: number
                                                documentId:
                                                  type: string
                                          adminUserOwner:
                                            type: object
                                            properties:
                                              id:
                                                oneOf:
                                                - type: string
                                                - type: number
                                              documentId:
                                                type: string
                                          expiresAt:
                                            type: string
                                            format: date-time
                                          lifespan:
                                            type: string
                                            pattern: ^\d*$
                                            example: '123456789'
                                          createdAt:
                                            type: string
                                            format: date-time
                                          updatedAt:
                                            type: string
                                            format: date-time
                                          publishedAt:
                                            type: string
                                            format: date-time
                                          createdBy:
                                            type: object
                                            properties:
                                              id:
                                                oneOf:
                                                - type: string
                                                - type: number
                                              documentId:
                                                type: string
                                          updatedBy:
                                            type: object
                                            properties:
                                              id:
                                                oneOf:
                                                - type: string
                                                - type: number
                                              documentId:
                                                type: string
                                          locale:
                                            type: string
                                          localizations:
                                            type: array
                                            items:
                                              type: object
                                              properties:
                                                id:
                                                  oneOf:
                                                  - type: string
                                                  - type: number
                                                documentId:
                                                  type: string
                                      createdAt:
                                        type: string
                                        format: date-time
                                      updatedAt:
                                        type: string
                                        format: date-time
                                      publishedAt:
                                        type: string
                                        format: date-time
                                      createdBy:
                                        type: object
                                        properties:
                                          id:
                                            oneOf:
                                            - type: string
                                            - type: number
                                          documentId:
                                            type: string
                                      updatedBy:
                                        type: object
                                        properties:
                                          id:
                                            oneOf:
                                            - type: string
                                            - type: number
                                          documentId:
                                            type: string
                                      locale:
                                        type: string
                                      localizations:
                                        type: array
                                        items:
                                          type: object
                                          properties:
                                            id:
                                              oneOf:
                                              - type: string
                                              - type: number
                                            documentId:
                                              type: string
                                createdAt:
                                  type: string
                                  format: date-time
                                updatedAt:
                                  type: string
                                  format: date-time
                                publishedAt:
                                  type: string
                                  format: date-time
                                createdBy:
                                  type: object
                                  properties:
                                    id:
                                      oneOf:
                                      - type: string
                                      - type: number
                                    documentId:
                                      type: string
                                updatedBy:
                                  type: object
                                  properties:
                                    id:
                                      oneOf:
                                      - type: string
                                      - type: number
                                    documentId:
                                      type: string
                                locale:
                                  type: string
                                localizations:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        oneOf:
                                        - type: string
                                        - type: number
                                      documentId:
                                        type: string
                          apiTokens:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  oneOf:
                                  - type: string
                                  - type: number
                                documentId:
                                  type: string
                          blocked:
                            type: boolean
                          preferedLanguage:
                            type: string
                          createdAt:
                            type: string
                            format: date-time
                          updatedAt:
                            type: string
                            format: date-time
                          publishedAt:
                            type: string
                            format: date-time
                          createdBy:
                            type: object
                            properties:
                              id:
                                oneOf:
                                - type: string
                                - type: number
                              documentId:
                                type: string
                          updatedBy:
                            type: object
                            properties:
                              id:
                                oneOf:
                                - type: string
                                - type: number
                              documentId:
                                type: string
                          locale:
                            type: string
                          localizations:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  oneOf:
                                  - type: string
                                  - type: number
                                documentId:
                                  type: string
                      updatedBy:
                        type: object
                        properties:
                          id:
                            oneOf:
                            - type: string
                            - type: number
                          documentId:
                            type: string
                      locale:
                        type: string
                      localizations:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              oneOf:
                              - type: string
                              - type: number
                            documentId:
                              type: string
                users:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        oneOf:
                        - type: string
                        - type: number
                      documentId:
                        type: string
                createdAt:
                  type: string
                  format: date-time
                updatedAt:
                  type: string
                  format: date-time
                publishedAt:
                  type: string
                  format: date-time
                createdBy:
                  type: object
                  properties:
                    id:
                      oneOf:
                      - type: string
                      - type: number
                    documentId:
                      type: string
                updatedBy:
                  type: object
                  properties:
                    id:
                   

# --- truncated at 32 KB (44 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ethernovia/refs/heads/main/openapi/ethernovia-audit-user-trail-api-openapi.yml