/** * Audit Service * Collects data about events that occur in a system. This data can be used to track changes to the system, to identify security vulnerabilities, and to comply with regulations. The audit service typically collects data about the following: - User activity, such as logins, logouts, and file access - System events, such as database changes and file modifications - Security events, such as failed login attempts and unauthorized access * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from './configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import globalAxios from 'axios'; import type { RequestArgs } from './base'; import { BaseAPI } from './base'; /** * * @export * @interface AuditRequestItem */ export interface AuditRequestItem { /** * Connect with the trace from service visibility * @type {string} * @memberof AuditRequestItem */ traceId?: string; /** * Tenant of the service (th-broker, orange-eu) * @type {string} * @memberof AuditRequestItem */ tenant: string; /** * The service where the event occured * @type {string} * @memberof AuditRequestItem */ service: string; /** * The domain where the service belongs * @type {string} * @memberof AuditRequestItem */ domain: string; /** * Frontend session id * @type {string} * @memberof AuditRequestItem */ sessionId?: string; /** * Original ip address of the actor who triggered the event * @type {string} * @memberof AuditRequestItem */ originIpAddress?: string; /** * How the actor triggered the action * @type {string} * @memberof AuditRequestItem */ originType: string; /** * Endpoint used to trigger the action * @type {string} * @memberof AuditRequestItem */ originUrl?: string; /** * Type of user who triggered the action * @type {string} * @memberof AuditRequestItem */ actorType: string; /** * Realm of the user who executed action * @type {string} * @memberof AuditRequestItem */ actorGroup: string; /** * UUID of the user who executed the action * @type {string} * @memberof AuditRequestItem */ actorId?: string; /** * Category of the event * @type {string} * @memberof AuditRequestItem */ actionCategory: string; /** * String identifier of the action being executed * @type {string} * @memberof AuditRequestItem */ actionKey: string; /** * Target of the action (usually a database or business entity) * @type {string} * @memberof AuditRequestItem */ targetKey: string; /** * ID of the principal affected by the action * @type {Array} * @memberof AuditRequestItem */ targetId?: Array; /** * String describing the action. Should include as much info as possible. CANNOT include any sensitive information. * @type {string} * @memberof AuditRequestItem */ actionDetail: string; /** * Where all the action detail is stored. Will probably contain sensitive data. In the case of a modification, will contain the modified fields names and new value. * @type {object} * @memberof AuditRequestItem */ actionPayload?: object; /** * What was the result of the action * @type {string} * @memberof AuditRequestItem */ resultKey: string; /** * String describing the action result. CANNOT include any sensitive information. * @type {string} * @memberof AuditRequestItem */ resultDetail?: string; /** * Snapshot of the data delivered to the user. Will probably contain sensitive data. * @type {object} * @memberof AuditRequestItem */ resultPayload?: object; /** * Date of when the event happened in the origin service * @type {string} * @memberof AuditRequestItem */ eventTimestamp: string; } /** * * @export * @interface AuditResponse */ export interface AuditResponse { /** * * @type {{ [key: string]: string; }} * @memberof AuditResponse */ errors?: { [key: string]: string; }; /** * * @type {string} * @memberof AuditResponse */ message?: string; /** * * @type {boolean} * @memberof AuditResponse */ success?: boolean; } /** * AuditServiceApi - axios parameter creator * @export */ export declare const AuditServiceApiAxiosParamCreator: (configuration?: Configuration) => { /** * Add a new record to the store * @summary Add a new record to the store * @param {Array} auditRequestItem Audit request object to be persisted by audit service * @param {*} [options] Override http request option. * @throws {RequiredError} */ audit: (auditRequestItem: Array, options?: RawAxiosRequestConfig) => Promise; }; /** * AuditServiceApi - functional programming interface * @export */ export declare const AuditServiceApiFp: (configuration?: Configuration) => { /** * Add a new record to the store * @summary Add a new record to the store * @param {Array} auditRequestItem Audit request object to be persisted by audit service * @param {*} [options] Override http request option. * @throws {RequiredError} */ audit(auditRequestItem: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AuditServiceApi - factory interface * @export */ export declare const AuditServiceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Add a new record to the store * @summary Add a new record to the store * @param {Array} auditRequestItem Audit request object to be persisted by audit service * @param {*} [options] Override http request option. * @throws {RequiredError} */ audit(auditRequestItem: Array, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * AuditServiceApi - object-oriented interface * @export * @class AuditServiceApi * @extends {BaseAPI} */ export declare class AuditServiceApi extends BaseAPI { /** * Add a new record to the store * @summary Add a new record to the store * @param {Array} auditRequestItem Audit request object to be persisted by audit service * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuditServiceApi */ audit(auditRequestItem: Array, options?: RawAxiosRequestConfig): Promise>; } //# sourceMappingURL=api.d.ts.map