Autional Autional
API Reference GitHub autional.com →

GET /admin/audit/reports/security

Generate and return a security audit report for a specified tenant and period. Reference: ISO 27001:2022 Annex A.12.4 (Event Logging), PCI DSS v4.0 Req 10 (Log & Monitor).

Audit Service `bearerAuth` application/json

Request Parameters

NameInTypeRequiredDefaultExampleConstraintsDescription
period query string No Report period: 7d/30d/90d
tenant_id query string No Tenant ID

Responses

StatusDescriptionSchema
200Security reportdto.SecurityReportDetailResponse
400Request parameter validation faileddto.Problem
401Unauthenticateddto.Problem
500Internal server errordto.Problem

Referenced Schemas

dto.FieldViolation

FieldTypeRequiredExampleConstraintsDescription
code string No Code is the error code (optional) Used by programs to identify error types, e.g., "required", "format", "range"
description string No Description is a human-readable error description Should explain what rule was violated, e.g., "Must be a valid email address"
field string No Field is the path to the error field Uses dot notation for nested fields, e.g., "user.email" or "addresses[0].city"
value object No Value is the value that caused the error (optional, used in development mode) May not be returned in production to avoid leaking sensitive information

dto.Problem

FieldTypeRequiredExampleConstraintsDescription
code integer No Code is the business error code Used by programs to handle specific error scenarios Example: 30101001
detail string No Detail is a human-readable explanation for this specific error instance Can contain specific error details, e.g., "Field 'email' is required"
errors array of

See dto.FieldViolation

No Errors is a list of field-level validation errors (extension field) Follows Web API standard practices, each error contains field name and error message
i18n_args object No I18nArgs are internationalization parameters Used to dynamically fill translation templates
i18n_key string No I18nKey is the internationalization key Used for client-side localization of error messages Example: "error.user_not_found"
instance string No Instance is the specific URI reference where the problem occurred Usually the request URL, may include query parameters Example: "/api/v1/users?limit=invalid"
request_id string No RequestID is the unique request identifier Used for log correlation and issue tracking Example: "req_550e8400-e29b-41d4-a716-446655440000"
retry_after integer No RetryAfter is used for 429 Too Many Requests responses Indicates the number of seconds the client should wait before retrying (RFC 6585)
service string No Service is the service name Used in microservice architecture to locate the error source Example: "auth-service"
span_id string No SpanID is the current span identifier Used to precisely locate the current node in a distributed trace
status integer No Status is the HTTP status code generated Used by clients to distinguish problem types, does not change with Accept-Language Example: 400, 401, 403, 404, 500
timestamp string No Timestamp is the error occurrence time ISO 8601 format Example: "2026-04-03T12:00:00Z"
title string No Title is a short, human-readable summary of the problem type The same Type should always have the same Title (does not change per instance) Example: "Invalid Request Parameters"
trace_id string No TraceID is the distributed tracing identifier Follows W3C Trace Context standard Example: "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01"
type string No Type is a URI reference identifying the problem type When dereferenced, should provide human-readable documentation Example: "https://api.example.com/errors/invalid-request"

dto.SecurityDetailsResp

Security details

FieldTypeRequiredExampleConstraintsDescription
failed_login_ips object No extra keys: `integer` Failed login IP
suspicious_users array of

string

No Suspicious user
unusual_access_times array of

See dto.TimeRangeResp

No Abnormal access time

dto.SecurityReportDetailResponse

FieldTypeRequiredExampleConstraintsDescription
code integer No
data dto.SecurityReportResponse No
message string No
timestamp string No

dto.SecurityReportResponse

Security audit report

FieldTypeRequiredExampleConstraintsDescription
details object No Details
generated_at integer No 1713175800 Generation timestamp
period string No 7d Period
recommendations array of

string

No Recommendation
summary object No Summary
top_risks array of

See dto.SecurityRiskResp

No Key risks

dto.SecurityRiskResp

Single security risk

FieldTypeRequiredExampleConstraintsDescription
count integer No 15 Count
description string No Brute force detected Description
severity string No high Severity
type string No brute_force Type

dto.SecuritySummaryResp

Security summary statistics

FieldTypeRequiredExampleConstraintsDescription
anomalies_detected integer No 10 Anomalies
blocked_ips integer No 5 Blocked IPs
failed_logins integer No 50 Failed logins
suspicious_activities integer No 20 Suspicious activities
total_events integer No 10000 Total events

dto.TimeRangeResp

Time range

FieldTypeRequiredExampleConstraintsDescription
end integer No 1713179400 End timestamp
start integer No 1713175800 Start timestamp