Logs Realm Settings Endpoint

Introduction

Use the /logsettings PATCH endpoint to enable and integrate specific logs for the realm's reporting.

Prerequisites

1. Complete the Enablement and Header Steps in the Admin API Guide

2. Have access to the application code that calls to the API endpoint(s)

3. Integrate a membership and profile directory(s) with SecureAuth IdP (Data Realm Settings Endpoint)

4. (OPTIONAL) Have a Syslog Server or Database Server with which to integrate

/logsettings Endpoint

Note

The following endpoints are prepended with the URL, https://<SecureAuth IdP Domain>/api/v2/realms/<realm ID>

Logs Settings /logsettings PATCH Endpoint

Notice

Use this endpoint to configure the realm's logs settings, including audit, debug, and error log enablement; and Syslog and database configuration.

HTTP Method	Endpoint	Example	SecureAuth IdP version
PATCH	/logsettings	https://secureauth.company.com/api/v2/realms/26/logsettings	v9.2 or later

Field	Description	Accepted Values	Note
logInstanceId	Name of log instance	any, defaulted to SecureAuth<realm ID>
enableAuditSyslog	Enable Syslog audit logs	true false
enableAuditEventLog	Enable audit event logs	true false
enableAuditTextLog	Enable audit text logs	true false
enableAuditDatabaseLog	Enable audit database logs	true false
enableAuditExtendedOtpLog	Enable audit extended OTP logs	true false
enableDebugSyslog	Enable Syslog debug logs	true false
enableDebugEventLog	Enable debug event logs	true false
enableDebugTextLog	Enable debug text logs	true false
enableErrorSyslog	Enable Syslog error logs	true false
enableErrorEventLog	Enable error event logs	true false
enableErrorTextLog	Enable error text logs	true false
customErrorMode	Redirect end-users to distinct URL if error occurs rather than default error page provided by browser	On Off RemoteOnly
customErrorRedirect	URL to which end-users are redirect if error occurs	URL path, defaulted to customerror.htm	If "customErrorMode": "On" or "RemoteOnly"
syslogSetting	Settings for Syslog integration	N / A	If Syslog logs enabled
server	IP address or Fully Qualified Domain Name (FQDN) of Syslog Server	IP address or FQDN
port	Port on which Syslog Server listens	any, defaulted to 514
rfcSpec	Required spec per Syslog	None RFC3164 RFC5424
privateEnterpriseNumber	PEN of Syslog Server	any
logDatabaseConnectionString	Connection string of log database to enable SecureAuth IdP integration	any, in required format Example Data Source=localhost\SQLEXPRESS;Initial Catalog=Logging;User ID=SecureAuthSQLUser;

Parameters	Success Response
{ "logInstanceId": "SecureAuth26", "enableAuditSyslog": true, "enableAuditEventLog": true, "enableAuditTextLog": true, "enableAuditDatabaseLog": true, "enableAuditExtendedOtpLog": false, "enableDebugSyslog": true, "enableDebugEventLog": false, "enableDebugTextLog": false, "enableErrorSyslog": true, "enableErrorEventLog": false, "enableErrorTextLog": true, "customErrorMode": "On", "customErrorRedirect": "customerror.htm", "syslogSetting": { "server": "", "port": 514, "rfcSpec": "None", "privateEnterpriseNumber": 1234 }, "logDatabaseConnectionString": "<CONNECTION STRING>" }	{ "status": "Success", "message": [] }

Parameters

Success Response

{
        "logInstanceId": "SecureAuth26",
        "enableAuditSyslog": true,
        "enableAuditEventLog": true,
        "enableAuditTextLog": true,
        "enableAuditDatabaseLog": true,
        "enableAuditExtendedOtpLog": false,
        "enableDebugSyslog": true,
        "enableDebugEventLog": false,
        "enableDebugTextLog": false,
        "enableErrorSyslog": true,
        "enableErrorEventLog": false,
        "enableErrorTextLog": true,
        "customErrorMode": "On",
        "customErrorRedirect": "customerror.htm",
        "syslogSetting": {
                "server": "",
                "port": 514,
                "rfcSpec": "None",
                "privateEnterpriseNumber": 1234
        },
        "logDatabaseConnectionString": "<CONNECTION STRING>"
}

{
 "status": "Success",
 "message": []
}

In this section: