openapi: 3.2.0
info:
  title: Fenergo Nebula Audit Query Self Service User Management API
  description: The Audit Query API enables the retrieval of audit event data related to various activities within the system.
  version: '3.0'
servers:
- url: /auditquery
security:
- Bearer: []
tags:
- name: SelfServiceUserManagement
paths:
  /api/v3/self-service-management/selfServiceUserManagementEvents:
    post:
      tags:
      - SelfServiceUserManagement
      summary: Get self service user management audit events
      description: 'Returns list of self service user management audit events.


        Required permissions:

        Following permissions are required: AuditAccessAndSearch'
      operationId: GetSelfServiceUserManagementEventsV3
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: Request.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/GetSelfServiceUserManagementAuditEventsRequestDtoServiceRequest'
      responses:
        '200':
          description: Success. The list of audit events is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSelfServiceUserManagementAuditEventsResultDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
components:
  schemas:
    AuditFieldChangeDto:
      type: object
      properties:
        fieldName:
          type:
          - string
          - 'null'
          description: Field name
        oldValue:
          type:
          - string
          - 'null'
          description: Field old value
        newValue:
          type:
          - string
          - 'null'
          description: Field new value
        itemOrdinal:
          type:
          - integer
          - 'null'
          description: '1-based position of the collection item this change belongs to. Only set when the

            owning data group holds more than one item, so consumers can tell same-named

            columns apart without exposing the internal item identifier.'
          format: int32
      additionalProperties: false
      description: DTO representing screening audit match field change
    ValidationErrorModelListServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ValidationErrorModel'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
      example:
        data:
        - propertyName: data
          errorMessage: Data is required
          attemptedValue: ''
          errorCode: NotNullValidator
        messages:
        - message: Data is required
          type: Error
          errorCode: Error Code
    GetSelfServiceUserManagementAuditEventsRequestDto:
      allOf:
      - $ref: '#/components/schemas/ResourceQueryPagedDto'
      - type: object
        properties:
          eventTypes:
            type:
            - array
            - 'null'
            items:
              type: string
        additionalProperties: false
    PagerDto:
      type: object
      properties:
        size:
          type: integer
          format: int32
          exclusiveMinimum: 0
        from:
          minimum: 0
          type: integer
          format: int32
        sortBy:
          type:
          - string
          - 'null'
        sortOrder:
          allOf:
          - $ref: '#/components/schemas/SortOrder'
      additionalProperties: false
    GetSelfServiceUserManagementAuditEventsRequestDtoServiceRequest:
      required:
      - data
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/GetSelfServiceUserManagementAuditEventsRequestDto'
      additionalProperties: false
    ResourceQueryDto:
      type: object
      properties:
        ids:
          type:
          - array
          - 'null'
          items:
            type: string
          description: The list of resource IDs for which to fetch Audit Events.
          example:
          - 7304b842-769f-4c22-9499-7c5d069ffb8f
          - ad6cf1b0-0925-4d65-98e7-a4e7901cce46
          - abb80516-3914-4366-a061-2f10e018fdeb
      additionalProperties: false
      description: The request object that contains a list of resource IDs for which to fetch Audit Events.
    SortOrder:
      enum:
      - Ascending
      - Descending
      type: string
    GetSelfServiceUserManagementAuditEventsResultDto:
      type: object
      properties:
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SelfServiceUserManagementAuditEventsDto'
          description: Items for the current page.
        totalItems:
          type: integer
          description: Total count of items.
          format: int64
          example: 1
      additionalProperties: false
    ValidationErrorModel:
      type: object
      properties:
        propertyName:
          type:
          - string
          - 'null'
        errorMessage:
          type:
          - string
          - 'null'
        attemptedValue: {}
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    GetSelfServiceUserManagementAuditEventsResultDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/GetSelfServiceUserManagementAuditEventsResultDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ResourceQueryPagedDto:
      allOf:
      - $ref: '#/components/schemas/ResourceQueryDto'
      - type: object
        properties:
          pager:
            allOf:
            - $ref: '#/components/schemas/PagerDto'
            description: A pager object to specify pagination parameters
            example:
              size: 10
              from: 0
              sortBy: date
              sortOrder: Descending
          excludeEventTypes:
            type:
            - array
            - 'null'
            items:
              type: string
            description: 'Optional list of event types to exclude from results.

              When provided, audit events whose `eventType` matches any value in this list are omitted.'
        additionalProperties: false
      description: The request object that contains a list of resource IDs for which to fetch Audit Events. Includes a pager object.
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    SelfServiceUserManagementAuditEventsDto:
      type: object
      properties:
        userId:
          type:
          - string
          - 'null'
          description: User id
          example: f9bb19a8-07e7-4306-94c9-a00988eadb0f
        userEmail:
          type:
          - string
          - 'null'
          description: Email of the User
        eventType:
          type:
          - string
          - 'null'
          description: Type of event
        changedBy:
          type:
          - string
          - 'null'
          description: Last updated by
        updatedOn:
          type:
          - string
          - 'null'
          description: Last Updated date
        itemChanges:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AuditFieldChangeDto'
          description: Summary of before and after values for fields
      additionalProperties: false
    ObjectServiceResponse:
      type: object
      properties:
        data: {}
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    StringServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header