Documentation

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

The following endpoints are prepended with the URL, https://<SecureAuth IdP Domain>/api/v1/realms/<realm ID>, if running SecureAuth IdP v9.1 – in which realm ID is the ID number of the realm to configure –

or https://<SecureAuth IdP Domain>/api/v2/realms/<realm ID>, if running SecureAuth IdP v9.2 or later

Logs Settings /logsettings PATCH Endpoint

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

HTTP MethodEndpointExampleSecureAuth IdP version
PATCH
/logsettings
https://secureauth.company.com/api/v1/realms/26/logsettings
v9.1
PATCH
/logsettings
https://secureauth.company.com/api/v2/realms/26/logsettings
v9.2 or later
Field Definitions and Accepted Values for Configuration
FieldDescriptionAccepted ValuesNote
logInstanceIdName of log instanceany, defaulted to SecureAuth<realm ID> 
enableAuditSyslogEnable Syslog audit logs
  • true
  • false
 
enableAuditEventLogEnable audit event logs
  • true
  • false
 
enableAuditTextLogEnable audit text logs
  • true
  • false
 
enableAuditDatabaseLogEnable audit database logs
  • true
  • false
 
enableAuditExtendedOtpLogEnable audit extended OTP logs
  • true
  • false
 
enableDebugSyslogEnable Syslog debug logs
  • true
  • false
 
enableDebugEventLogEnable debug event logs
  • true
  • false
 
enableDebugTextLogEnable debug text logs
  • true
  • false
 
enableErrorSyslogEnable Syslog error logs
  • true
  • false
 
enableErrorEventLogEnable error event logs
  • true
  • false
 
enableErrorTextLogEnable error text logs
  • true
  • false
 
customErrorModeRedirect end-users to distinct URL if error occurs rather than default error page provided by browser
  • On
  • Off
  • RemoteOnly
 
customErrorRedirectURL to which end-users are redirect if error occursURL path, defaulted to customerror.htmIf "customErrorMode": "On" or "RemoteOnly"
syslogSettingSettings for Syslog integrationN / AIf Syslog logs enabled
serverIP address or Fully Qualified Domain Name (FQDN) of Syslog ServerIP address or FQDN 
portPort on which Syslog Server listensany, defaulted to 514 
rfcSpecRequired spec per Syslog
  • None
  • RFC3164
  • RFC5424
 
privateEnterpriseNumberPEN of Syslog Server

any

 
logDatabaseConnectionStringConnection 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 and Response Examples
ParametersSuccess 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": []
}
Related Documentation
  • No labels