com.hpe.caf.services.audit.contract.swagger.yaml Maven / Gradle / Ivy
#
# Copyright 2015-2024 Open Text.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
swagger: "2.0"
info:
title: "Audit Web Service"
version: "4.0.0"
description: |
Allows audit event message details to be indexed into ElasticSearch.
Each audit event message will comprise a set of fixed fields including the application the
audit event message is associated with, the user that triggered the audit event as well as the
tenant that the user belongs to. The audit event message will also include additional fields
specific to the application.
basePath: /caf-audit-service/v1
tags:
- name: AuditEvents
consumes:
- application/json
produces:
- application/json
paths:
/auditevents:
post:
tags:
- AuditEvents
summary: Indexes a new audit event message into Elasticsearch.
description: |
Indexes the specified audit event message into Elasticsearch.
operationId: auditeventsPost
parameters:
- name: newAuditEvent
description: The definition of the audit event message to index.
in: body
required: true
schema:
$ref: "#/definitions/newAuditEvent"
responses:
204:
description: The audit event message was successfully indexed into Elasticsearch.
400:
description: The audit event message definition is incomplete or contains invalid data.
definitions:
newAuditEvent:
type: object
properties:
applicationId:
type: string
description: The application that the audit event type is associated with.
processId:
type: string
description: Unique identifier associated with the particular instance of the process that generated the audit event.
threadId:
type: integer
format: int64
description: Numeric id associated with the particular thread within the process that generated the audit event.
eventOrder:
type: integer
format: int64
description: Used to order events raised by the specified thread.
eventTime:
type: string
description: Records the time that the event occurred (in the ISO-8601 format).
eventTimeSource:
type: string
description: Identifies the machine which provided the eventTime.
userId:
type: string
description: Identifies the user who triggered the event.
tenantId:
type: string
description: Identifies the tenant that the user belongs to.
correlationId:
type: string
description: Identifies the same user action.
eventTypeId:
type: string
description: Identifier for the particular event.
eventCategoryId:
type: string
description: Identifies the category of event.
eventParams:
type: array
description: List of application specific fields associated with the audit event.
items:
$ref: "#/definitions/eventParam"
eventParam:
type: object
required:
- paramName
- paramType
- paramValue
properties:
paramName:
type: string
description: Audit event parameter name.
paramType:
type: string
description: Type of audit event parameter.
default: string
paramIndexingHint:
type: string
description: Indexing hint for audit event parameter storage. Applies to parameters of type string only.
paramColumnName:
type: string
description: Alternative field name to be used in the event that multiple audit events comprise of parameters with the same name.
paramValue:
type: string
description: Audit event parameter value.