audits.json

{
  "openapi": "3.0.0",
  "paths": {
    "/": {
      "get": {
        "operationId": "AuditsController_getAudits",
        "summary": "Get audits",
        "description": "This route gets all audit logs for a tenant. Send the tenant’s id in the **`frontegg-tenant-id`** header to declare the tenant. Optionally, use the query params to filter and organize the results. There's a limit of 200 audits. You can use the 'offset' query param to get the following 200 results. For example: \n?count=200&offset=0&sortBy=createdAt&sortDirection=desc returns audits 1-200, \n?count=200&offset=200&sortBy=createdAt&sortDirection=desc returns audits 201-400",
        "deprecated": true,
        "parameters": [
          {
            "name": "vendorId",
            "required": true,
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": ""
          },
          {
            "name": "tenantId",
            "required": true,
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": ""
          },
          {
            "name": "limit",
            "required": false,
            "in": "query",
            "schema": {
              "type": "number"
            },
            "description": ""
          },
          {
            "name": "offset",
            "required": true,
            "in": "query",
            "schema": {
              "type": "number"
            },
            "description": ""
          },
          {
            "name": "count",
            "required": true,
            "in": "query",
            "schema": {
              "type": "number"
            },
            "description": ""
          },
          {
            "name": "paginationMode",
            "required": false,
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": ""
          },
          {
            "name": "filter",
            "required": false,
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": ""
          },
          {
            "name": "sortBy",
            "required": false,
            "in": "query",
            "schema": {
              "pattern": "/^[a-zA-z0-9_]+$/",
              "type": "string"
            },
            "description": ""
          },
          {
            "name": "sortDirection",
            "required": false,
            "in": "query",
            "schema": {
              "pattern": "/^(a|de)sc$/i",
              "type": "string"
            },
            "description": ""
          },
          {
            "name": "frontegg-tenant-id",
            "in": "header",
            "description": "The tenant ID identifier",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": ""
          }
        },
        "tags": [
          "Main"
        ]
      },
      "post": {
        "operationId": "AuditsController_addAudits",
        "summary": "Add audits",
        "description": "Add audits",
        "parameters": [
          {
            "name": "frontegg-tenant-id",
            "in": "header",
            "description": "The tenant ID identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AuditRequest"
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": ""
          }
        },
        "tags": [
          "Main"
        ]
      }
    },
    "/stats": {
      "get": {
        "operationId": "AuditsController_getAuditsStats",
        "summary": "Get audits statistics",
        "description": "Get audits statistics",
        "parameters": [
          {
            "name": "frontegg-tenant-id",
            "in": "header",
            "description": "The tenant ID identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": ""
          }
        },
        "tags": [
          "Main"
        ]
      }
    },
    "/export/csv": {
      "post": {
        "operationId": "AuditsController_exportCsv",
        "summary": "Export CSV",
        "description": "Export CSV",
        "deprecated": true,
        "parameters": [
          {
            "name": "vendorId",
            "required": true,
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": ""
          },
          {
            "name": "tenantId",
            "required": true,
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": ""
          },
          {
            "name": "limit",
            "required": false,
            "in": "query",
            "schema": {
              "type": "number"
            },
            "description": ""
          },
          {
            "name": "offset",
            "required": true,
            "in": "query",
            "schema": {
              "type": "number"
            },
            "description": ""
          },
          {
            "name": "count",
            "required": true,
            "in": "query",
            "schema": {
              "type": "number"
            },
            "description": ""
          },
          {
            "name": "paginationMode",
            "required": false,
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": ""
          },
          {
            "name": "filter",
            "required": false,
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": ""
          },
          {
            "name": "sortBy",
            "required": false,
            "in": "query",
            "schema": {
              "pattern": "/^[a-zA-z0-9_]+$/",
              "type": "string"
            },
            "description": ""
          },
          {
            "name": "sortDirection",
            "required": false,
            "in": "query",
            "schema": {
              "pattern": "/^(a|de)sc$/i",
              "type": "string"
            },
            "description": ""
          },
          {
            "name": "frontegg-tenant-id",
            "in": "header",
            "description": "The tenant ID identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ExportCSV"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": ""
          }
        },
        "tags": [
          "Main"
        ]
      }
    },
    "/export/csv/v2": {
      "post": {
        "operationId": "AuditsController_exportCsvToStream",
        "summary": "Export CSV to stream",
        "description": "Export CSV to stream",
        "parameters": [
          {
            "name": "vendorId",
            "required": true,
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": ""
          },
          {
            "name": "tenantId",
            "required": true,
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": ""
          },
          {
            "name": "limit",
            "required": false,
            "in": "query",
            "schema": {
              "type": "number"
            },
            "description": ""
          },
          {
            "name": "offset",
            "required": true,
            "in": "query",
            "schema": {
              "type": "number"
            },
            "description": ""
          },
          {
            "name": "count",
            "required": true,
            "in": "query",
            "schema": {
              "type": "number"
            },
            "description": ""
          },
          {
            "name": "paginationMode",
            "required": false,
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": ""
          },
          {
            "name": "filter",
            "required": false,
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": ""
          },
          {
            "name": "sortBy",
            "required": false,
            "in": "query",
            "schema": {
              "pattern": "/^[a-zA-z0-9_]+$/",
              "type": "string"
            },
            "description": ""
          },
          {
            "name": "sortDirection",
            "required": false,
            "in": "query",
            "schema": {
              "pattern": "/^(a|de)sc$/i",
              "type": "string"
            },
            "description": ""
          },
          {
            "name": "frontegg-tenant-id",
            "in": "header",
            "description": "The tenant ID identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ExportCSV"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": ""
          }
        },
        "tags": [
          "Main"
        ]
      }
    },
    "/resources/audits/v2": {
      "get": {
        "operationId": "AuditsController_V2_getAudits",
        "summary": "Get audits (V2)",
        "description": "This route gets all audit logs for a tenant. Send the tenant’s id in the **`frontegg-tenant-id`** header to declare the tenant. Optionally, use the query params to filter and organize the results. There's a limit of 200 audits. You can use the 'offset' query param to get the following 200 results. For example: \n?count=200&offset=0&sortBy=createdAt&sortDirection=desc returns audits 1-200, \n?count=200&offset=200&sortBy=createdAt&sortDirection=desc returns audits 201-400",
        "parameters": [
          {
            "name": "created_from",
            "required": false,
            "in": "query",
            "schema": {
              "format": "date-time",
              "type": "string"
            },
            "description": ""
          },
          {
            "name": "created_to",
            "required": false,
            "in": "query",
            "schema": {
              "format": "date-time",
              "type": "string"
            },
            "description": ""
          },
          {
            "name": "tenant_ids",
            "required": false,
            "in": "query",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "description": ""
          },
          {
            "name": "users",
            "required": false,
            "in": "query",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "description": ""
          },
          {
            "name": "email",
            "required": false,
            "in": "query",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "description": ""
          },
          {
            "name": "count",
            "required": true,
            "in": "query",
            "schema": {
              "minimum": 1,
              "maximum": 200,
              "type": "number"
            },
            "description": ""
          },
          {
            "name": "offset",
            "required": true,
            "in": "query",
            "schema": {
              "minimum": 0,
              "type": "number"
            },
            "description": ""
          },
          {
            "name": "sortBy",
            "required": false,
            "in": "query",
            "schema": {
              "pattern": "/^[a-zA-z0-9_]+$/",
              "type": "string"
            },
            "description": ""
          },
          {
            "name": "sortDirection",
            "required": false,
            "in": "query",
            "schema": {
              "pattern": "/^(a|de)sc$/i",
              "type": "string"
            },
            "description": ""
          },
          {
            "name": "filter",
            "required": false,
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": ""
          },
          {
            "name": "featureFlagId",
            "required": false,
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": ""
          },
          {
            "name": "frontegg-tenant-id",
            "in": "header",
            "description": "The tenant ID identifier",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": ""
          }
        },
        "tags": [
          "Main"
        ]
      }
    },
    "/resources/audits/v2/export/csv": {
      "post": {
        "operationId": "AuditsController_V2_exportCsvToStream",
        "summary": "Export CSV to stream (V2)",
        "description": "Export CSV to stream",
        "parameters": [
          {
            "name": "created_from",
            "required": false,
            "in": "query",
            "schema": {
              "format": "date-time",
              "type": "string"
            },
            "description": ""
          },
          {
            "name": "created_to",
            "required": false,
            "in": "query",
            "schema": {
              "format": "date-time",
              "type": "string"
            },
            "description": ""
          },
          {
            "name": "tenant_ids",
            "required": false,
            "in": "query",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "description": ""
          },
          {
            "name": "users",
            "required": false,
            "in": "query",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "description": ""
          },
          {
            "name": "email",
            "required": false,
            "in": "query",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "description": ""
          },
          {
            "name": "count",
            "required": true,
            "in": "query",
            "schema": {
              "minimum": 1,
              "maximum": 200,
              "type": "number"
            },
            "description": ""
          },
          {
            "name": "offset",
            "required": true,
            "in": "query",
            "schema": {
              "minimum": 0,
              "type": "number"
            },
            "description": ""
          },
          {
            "name": "sortBy",
            "required": false,
            "in": "query",
            "schema": {
              "pattern": "/^[a-zA-z0-9_]+$/",
              "type": "string"
            },
            "description": ""
          },
          {
            "name": "sortDirection",
            "required": false,
            "in": "query",
            "schema": {
              "pattern": "/^(a|de)sc$/i",
              "type": "string"
            },
            "description": ""
          },
          {
            "name": "filter",
            "required": false,
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": ""
          },
          {
            "name": "featureFlagId",
            "required": false,
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": ""
          },
          {
            "name": "frontegg-tenant-id",
            "in": "header",
            "description": "The tenant ID identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ExportCSV"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": ""
          }
        },
        "tags": [
          "Main"
        ]
      }
    },
    "/resources/metrics/v1": {
      "get": {
        "operationId": "MetricsController_getMetrics",
        "summary": "Get metrics",
        "description": "Get metrics",
        "parameters": [
          {
            "name": "from",
            "required": false,
            "in": "query",
            "schema": {
              "type": "number"
            },
            "description": ""
          },
          {
            "name": "to",
            "required": false,
            "in": "query",
            "schema": {
              "type": "number"
            },
            "description": ""
          },
          {
            "name": "limit",
            "required": false,
            "in": "query",
            "schema": {
              "type": "number"
            },
            "description": ""
          },
          {
            "name": "frequency",
            "required": false,
            "in": "query",
            "schema": {
              "type": "number"
            },
            "description": ""
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MetricsResponseDto"
                }
              }
            }
          }
        },
        "tags": [
          "Metrics"
        ]
      }
    }
  },
  "info": {
    "title": "Audits Overview",
    "description": {
      "$ref": "descriptions/audits.md"
    },
    "version": ""
  },
  "servers": [
    {
      "url": "https://api.frontegg.com/audits",
      "description": "EU Region"
    },
    {
      "url": "https://api.us.frontegg.com/audits",
      "description": "US Region"
    },
    {
      "url": "https://api.ca.frontegg.com/audits",
      "description": "CA Region"
    },
    {
      "url": "https://api.au.frontegg.com/audits",
      "description": "AU Region"
    },
    {
      "url": "https://{domain}.frontegg.com/audits",
      "description": "Frontegg sub-domain for use with user tokens",
      "variables": {
        "domain": {
          "default": "app-xxx"
        }
      }
    }
  ],
  "components": {
    "securitySchemes": {
      "bearer": {
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "type": "http"
      }
    },
    "schemas": {
      "AuditRequest": {
        "type": "object",
        "properties": {
          "severity": {
            "type": "string",
            "enum": [
              "Info",
              "Medium",
              "High",
              "Critical",
              "Error"
            ],
            "description": ""
          }
        },
        "required": [
          "severity"
        ]
      },
      "Property": {
        "type": "object",
        "properties": {
          "displayName": {
            "type": "string",
            "description": ""
          },
          "name": {
            "type": "string",
            "description": ""
          }
        },
        "required": [
          "displayName",
          "name"
        ]
      },
      "ExportCSV": {
        "type": "object",
        "properties": {
          "properties": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Property"
            },
            "description": ""
          }
        },
        "required": [
          "properties"
        ]
      },
      "TopResources": {
        "type": "object",
        "properties": {}
      },
      "TopTenants": {
        "type": "object",
        "properties": {}
      },
      "MetricsResponseDto": {
        "type": "object",
        "properties": {
          "topResources": {
            "$ref": "#/components/schemas/TopResources",
            "description": ""
          },
          "topTenants": {
            "$ref": "#/components/schemas/TopTenants",
            "description": ""
          },
          "auditsCounterByTime": {
            "type": "object",
            "description": ""
          }
        },
        "required": [
          "topResources",
          "topTenants",
          "auditsCounterByTime"
        ]
      }
    }
  },
  "security": [
    {
      "bearer": []
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-tagGroups": [
    {
      "name": "Management",
      "tags": [
        "Metrics"
      ]
    },
    {
      "name": "Self-Service",
      "tags": [
        "Main"
      ]
    }
  ]
}