---
title: Csv
description: Resource path:
component: pingam
version: 8.1
page_id: pingam:entity-reference:sec-amster-entity-csv
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-csv.html
section_ids:
sec-amster-entity-csv-realm-ops: Realm Operations
sec-amster-entity-csv-realm-ops-create: create
sec-amster-entity-csv-realm-ops-delete: delete
sec-amster-entity-csv-realm-ops-getalltypes: getAllTypes
sec-amster-entity-csv-realm-ops-getcreatabletypes: getCreatableTypes
sec-amster-entity-csv-realm-ops-nextdescendents: nextdescendents
sec-amster-entity-csv-realm-ops-query: query
sec-amster-entity-csv-realm-ops-read: read
sec-amster-entity-csv-realm-ops-update: update
sec-amster-entity-csv-global-ops: Global Operations
sec-amster-entity-csv-global-ops-create: create
sec-amster-entity-csv-global-ops-delete: delete
sec-amster-entity-csv-global-ops-getalltypes: getAllTypes
sec-amster-entity-csv-global-ops-getcreatabletypes: getCreatableTypes
sec-amster-entity-csv-global-ops-nextdescendents: nextdescendents
sec-amster-entity-csv-global-ops-query: query
sec-amster-entity-csv-global-ops-read: read
sec-amster-entity-csv-global-ops-update: update
---
# Csv
## Realm Operations
Resource path:
```
/realm-config/services/audit/CSV
```
Resource version: `0.0`
### create
**Usage**
```
am> create Csv --realm Realm --id id --body body
```
**Parameters**
* *\--id*
The unique identifier for the resource.
* *\--body*
The resource in JSON format, described by the following JSON schema:
```json
{
"type" : "object",
"properties" : {
"commonHandler" : {
"type" : "object",
"title" : "General Handler Configuration",
"propertyOrder" : 0,
"properties" : {
"enabled" : {
"title" : "Enabled",
"description" : "Enables or disables an audit event handler.",
"propertyOrder" : 300,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
},
"topics" : {
"title" : "Topics",
"description" : "List of topics handled by an audit event handler.",
"propertyOrder" : 400,
"required" : true,
"items" : {
"type" : "string"
},
"type" : "array",
"exampleValue" : ""
}
}
},
"csvFileRotation" : {
"type" : "object",
"title" : "File Rotation",
"propertyOrder" : 3,
"properties" : {
"rotationFileSuffix" : {
"title" : "File Rotation Suffix",
"description" : "Suffix to append to audit files when they are rotated. Suffix should be a timestamp.",
"propertyOrder" : 900,
"required" : false,
"type" : "string",
"exampleValue" : ""
},
"rotationMaxFileSize" : {
"title" : "Maximum File Size",
"description" : "Maximum size, in bytes, which an audit file can grow to before rotation is triggered. A negative or zero value indicates this policy is disabled.",
"propertyOrder" : 700,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"rotationTimes" : {
"title" : "Rotation Times",
"description" : "Durations after midnight to trigger file rotation, in seconds.",
"propertyOrder" : 1100,
"required" : true,
"items" : {
"type" : "string"
},
"type" : "array",
"exampleValue" : ""
},
"rotationFilePrefix" : {
"title" : "File Rotation Prefix",
"description" : "Prefix to prepend to audit files when rotating audit files.",
"propertyOrder" : 800,
"required" : false,
"type" : "string",
"exampleValue" : ""
},
"rotationEnabled" : {
"title" : "Rotation Enabled",
"description" : "Enables and disables audit file rotation.",
"propertyOrder" : 600,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
},
"rotationInterval" : {
"title" : "Rotation Interval",
"description" : "Interval to trigger audit file rotations, in seconds. A negative or zero value disables this feature.",
"propertyOrder" : 1000,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
},
"csvSecurity" : {
"type" : "object",
"title" : "Tamper Evident Configuration",
"propertyOrder" : 6,
"properties" : {
"securitySignatureInterval" : {
"title" : "Signature Interval",
"description" : "Signature generation interval, in seconds.",
"propertyOrder" : 2000,
"required" : false,
"type" : "string",
"exampleValue" : ""
},
"securityEnabled" : {
"title" : "Is Enabled",
"description" : "Enables the CSV tamper evident feature.",
"propertyOrder" : 1700,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
},
"securityFilename" : {
"title" : "Certificate Store Location",
"description" : "Path to Java keystore.",
"propertyOrder" : 1800,
"required" : false,
"type" : "string",
"exampleValue" : ""
},
"securityPassword" : {
"title" : "Certificate Store Password",
"description" : "Password for Java keystore.",
"propertyOrder" : 1900,
"required" : false,
"type" : "string",
"format" : "password",
"exampleValue" : ""
}
}
},
"csvFileRetention" : {
"type" : "object",
"title" : "File Retention",
"propertyOrder" : 4,
"properties" : {
"retentionMaxDiskSpaceToUse" : {
"title" : "Maximum Disk Space",
"description" : "The maximum amount of disk space the audit files can occupy, in bytes. A negative or zero value indicates this policy is disabled.",
"propertyOrder" : 1300,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"retentionMaxNumberOfHistoryFiles" : {
"title" : "Maximum Number of Historical Files",
"description" : "Maximum number of backup audit files allowed. A value of -1 disables pruning of old history files.",
"propertyOrder" : 1200,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"retentionMinFreeSpaceRequired" : {
"title" : "Minimum Free Space Required",
"description" : "Minimum amount of disk space required, in bytes, on the system where audit files are stored. A negative or zero value indicates this policy is disabled.",
"propertyOrder" : 1400,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
},
"csvConfig" : {
"type" : "object",
"title" : "CSV Configuration",
"propertyOrder" : 2,
"properties" : {
"location" : {
"title" : "Log Directory",
"description" : "Directory in which to store audit log CSV files.",
"propertyOrder" : 500,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
},
"commonHandlerPlugin" : {
"type" : "object",
"title" : "Audit Event Handler Factory",
"propertyOrder" : 1,
"properties" : {
"handlerFactory" : {
"title" : "Factory Class Name",
"description" : "The fully qualified class name of the factory responsible for creating the Audit Event Handler. The class must implement org.forgerock.openam.audit.AuditEventHandlerFactory.",
"propertyOrder" : 2100,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
},
"csvBuffering" : {
"type" : "object",
"title" : "Buffering",
"propertyOrder" : 5,
"properties" : {
"bufferingAutoFlush" : {
"title" : "Flush Each Event Immediately",
"description" : "Performance may be improved by writing all buffered events before flushing.",
"propertyOrder" : 1600,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
},
"bufferingEnabled" : {
"title" : "Buffering Enabled",
"description" : "Enables or disables buffering.",
"propertyOrder" : 1500,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
}
}
}
}
}
```
### delete
**Usage**
```
am> delete Csv --realm Realm --id id
```
**Parameters**
* *\--id*
The unique identifier for the resource.
### getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
**Usage**
```
am> action Csv --realm Realm --actionName getAllTypes
```
### getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
**Usage**
```
am> action Csv --realm Realm --actionName getCreatableTypes
```
### nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
**Usage**
```
am> action Csv --realm Realm --actionName nextdescendents
```
### query
Get the full list of instances of this collection. This query only supports `_queryFilter=true` filter.
**Usage**
```
am> query Csv --realm Realm --filter filter
```
**Parameters**
* *\--filter*
A CREST formatted query filter, where "true" will query all.
### read
**Usage**
```
am> read Csv --realm Realm --id id
```
**Parameters**
* *\--id*
The unique identifier for the resource.
### update
**Usage**
```
am> update Csv --realm Realm --id id --body body
```
**Parameters**
* *\--id*
The unique identifier for the resource.
* *\--body*
The resource in JSON format, described by the following JSON schema:
```json
{
"type" : "object",
"properties" : {
"commonHandler" : {
"type" : "object",
"title" : "General Handler Configuration",
"propertyOrder" : 0,
"properties" : {
"enabled" : {
"title" : "Enabled",
"description" : "Enables or disables an audit event handler.",
"propertyOrder" : 300,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
},
"topics" : {
"title" : "Topics",
"description" : "List of topics handled by an audit event handler.",
"propertyOrder" : 400,
"required" : true,
"items" : {
"type" : "string"
},
"type" : "array",
"exampleValue" : ""
}
}
},
"csvFileRotation" : {
"type" : "object",
"title" : "File Rotation",
"propertyOrder" : 3,
"properties" : {
"rotationFileSuffix" : {
"title" : "File Rotation Suffix",
"description" : "Suffix to append to audit files when they are rotated. Suffix should be a timestamp.",
"propertyOrder" : 900,
"required" : false,
"type" : "string",
"exampleValue" : ""
},
"rotationMaxFileSize" : {
"title" : "Maximum File Size",
"description" : "Maximum size, in bytes, which an audit file can grow to before rotation is triggered. A negative or zero value indicates this policy is disabled.",
"propertyOrder" : 700,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"rotationTimes" : {
"title" : "Rotation Times",
"description" : "Durations after midnight to trigger file rotation, in seconds.",
"propertyOrder" : 1100,
"required" : true,
"items" : {
"type" : "string"
},
"type" : "array",
"exampleValue" : ""
},
"rotationFilePrefix" : {
"title" : "File Rotation Prefix",
"description" : "Prefix to prepend to audit files when rotating audit files.",
"propertyOrder" : 800,
"required" : false,
"type" : "string",
"exampleValue" : ""
},
"rotationEnabled" : {
"title" : "Rotation Enabled",
"description" : "Enables and disables audit file rotation.",
"propertyOrder" : 600,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
},
"rotationInterval" : {
"title" : "Rotation Interval",
"description" : "Interval to trigger audit file rotations, in seconds. A negative or zero value disables this feature.",
"propertyOrder" : 1000,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
},
"csvSecurity" : {
"type" : "object",
"title" : "Tamper Evident Configuration",
"propertyOrder" : 6,
"properties" : {
"securitySignatureInterval" : {
"title" : "Signature Interval",
"description" : "Signature generation interval, in seconds.",
"propertyOrder" : 2000,
"required" : false,
"type" : "string",
"exampleValue" : ""
},
"securityEnabled" : {
"title" : "Is Enabled",
"description" : "Enables the CSV tamper evident feature.",
"propertyOrder" : 1700,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
},
"securityFilename" : {
"title" : "Certificate Store Location",
"description" : "Path to Java keystore.",
"propertyOrder" : 1800,
"required" : false,
"type" : "string",
"exampleValue" : ""
},
"securityPassword" : {
"title" : "Certificate Store Password",
"description" : "Password for Java keystore.",
"propertyOrder" : 1900,
"required" : false,
"type" : "string",
"format" : "password",
"exampleValue" : ""
}
}
},
"csvFileRetention" : {
"type" : "object",
"title" : "File Retention",
"propertyOrder" : 4,
"properties" : {
"retentionMaxDiskSpaceToUse" : {
"title" : "Maximum Disk Space",
"description" : "The maximum amount of disk space the audit files can occupy, in bytes. A negative or zero value indicates this policy is disabled.",
"propertyOrder" : 1300,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"retentionMaxNumberOfHistoryFiles" : {
"title" : "Maximum Number of Historical Files",
"description" : "Maximum number of backup audit files allowed. A value of -1 disables pruning of old history files.",
"propertyOrder" : 1200,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"retentionMinFreeSpaceRequired" : {
"title" : "Minimum Free Space Required",
"description" : "Minimum amount of disk space required, in bytes, on the system where audit files are stored. A negative or zero value indicates this policy is disabled.",
"propertyOrder" : 1400,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
},
"csvConfig" : {
"type" : "object",
"title" : "CSV Configuration",
"propertyOrder" : 2,
"properties" : {
"location" : {
"title" : "Log Directory",
"description" : "Directory in which to store audit log CSV files.",
"propertyOrder" : 500,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
},
"commonHandlerPlugin" : {
"type" : "object",
"title" : "Audit Event Handler Factory",
"propertyOrder" : 1,
"properties" : {
"handlerFactory" : {
"title" : "Factory Class Name",
"description" : "The fully qualified class name of the factory responsible for creating the Audit Event Handler. The class must implement org.forgerock.openam.audit.AuditEventHandlerFactory.",
"propertyOrder" : 2100,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
},
"csvBuffering" : {
"type" : "object",
"title" : "Buffering",
"propertyOrder" : 5,
"properties" : {
"bufferingAutoFlush" : {
"title" : "Flush Each Event Immediately",
"description" : "Performance may be improved by writing all buffered events before flushing.",
"propertyOrder" : 1600,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
},
"bufferingEnabled" : {
"title" : "Buffering Enabled",
"description" : "Enables or disables buffering.",
"propertyOrder" : 1500,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
}
}
}
}
}
```
## Global Operations
Resource path:
```
/global-config/services/audit/CSV
```
Resource version: `1.0`
### create
**Usage**
```
am> create Csv --global --id id --body body
```
**Parameters**
* *\--id*
The unique identifier for the resource.
* *\--body*
The resource in JSON format, described by the following JSON schema:
```json
{
"type" : "object",
"properties" : {
"csvSecurity" : {
"type" : "object",
"title" : "Tamper Evident Configuration",
"propertyOrder" : 6,
"properties" : {
"securitySignatureInterval" : {
"title" : "Signature Interval",
"description" : "Signature generation interval, in seconds.",
"propertyOrder" : 2000,
"required" : false,
"type" : "string",
"exampleValue" : ""
},
"securityPassword" : {
"title" : "Certificate Store Password",
"description" : "Password for Java keystore.",
"propertyOrder" : 1900,
"required" : false,
"type" : "string",
"format" : "password",
"exampleValue" : ""
},
"securityFilename" : {
"title" : "Certificate Store Location",
"description" : "Path to Java keystore.",
"propertyOrder" : 1800,
"required" : false,
"type" : "string",
"exampleValue" : ""
},
"securityEnabled" : {
"title" : "Is Enabled",
"description" : "Enables the CSV tamper evident feature.",
"propertyOrder" : 1700,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
}
}
},
"csvFileRetention" : {
"type" : "object",
"title" : "File Retention",
"propertyOrder" : 4,
"properties" : {
"retentionMaxDiskSpaceToUse" : {
"title" : "Maximum Disk Space",
"description" : "The maximum amount of disk space the audit files can occupy, in bytes. A negative or zero value indicates this policy is disabled.",
"propertyOrder" : 1300,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"retentionMinFreeSpaceRequired" : {
"title" : "Minimum Free Space Required",
"description" : "Minimum amount of disk space required, in bytes, on the system where audit files are stored. A negative or zero value indicates this policy is disabled.",
"propertyOrder" : 1400,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"retentionMaxNumberOfHistoryFiles" : {
"title" : "Maximum Number of Historical Files",
"description" : "Maximum number of backup audit files allowed. A value of -1 disables pruning of old history files.",
"propertyOrder" : 1200,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
},
"csvFileRotation" : {
"type" : "object",
"title" : "File Rotation",
"propertyOrder" : 3,
"properties" : {
"rotationFilePrefix" : {
"title" : "File Rotation Prefix",
"description" : "Prefix to prepend to audit files when rotating audit files.",
"propertyOrder" : 800,
"required" : false,
"type" : "string",
"exampleValue" : ""
},
"rotationEnabled" : {
"title" : "Rotation Enabled",
"description" : "Enables and disables audit file rotation.",
"propertyOrder" : 600,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
},
"rotationMaxFileSize" : {
"title" : "Maximum File Size",
"description" : "Maximum size, in bytes, which an audit file can grow to before rotation is triggered. A negative or zero value indicates this policy is disabled.",
"propertyOrder" : 700,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"rotationInterval" : {
"title" : "Rotation Interval",
"description" : "Interval to trigger audit file rotations, in seconds. A negative or zero value disables this feature.",
"propertyOrder" : 1000,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"rotationTimes" : {
"title" : "Rotation Times",
"description" : "Durations after midnight to trigger file rotation, in seconds.",
"propertyOrder" : 1100,
"required" : true,
"items" : {
"type" : "string"
},
"type" : "array",
"exampleValue" : ""
},
"rotationFileSuffix" : {
"title" : "File Rotation Suffix",
"description" : "Suffix to append to audit files when they are rotated. Suffix should be a timestamp.",
"propertyOrder" : 900,
"required" : false,
"type" : "string",
"exampleValue" : ""
}
}
},
"commonHandler" : {
"type" : "object",
"title" : "General Handler Configuration",
"propertyOrder" : 0,
"properties" : {
"topics" : {
"title" : "Topics",
"description" : "List of topics handled by an audit event handler.",
"propertyOrder" : 400,
"required" : true,
"items" : {
"type" : "string"
},
"type" : "array",
"exampleValue" : ""
},
"enabled" : {
"title" : "Enabled",
"description" : "Enables or disables an audit event handler.",
"propertyOrder" : 300,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
}
}
},
"csvConfig" : {
"type" : "object",
"title" : "CSV Configuration",
"propertyOrder" : 2,
"properties" : {
"location" : {
"title" : "Log Directory",
"description" : "Directory in which to store audit log CSV files.",
"propertyOrder" : 500,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
},
"csvBuffering" : {
"type" : "object",
"title" : "Buffering",
"propertyOrder" : 5,
"properties" : {
"bufferingEnabled" : {
"title" : "Buffering Enabled",
"description" : "Enables or disables buffering.",
"propertyOrder" : 1500,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
},
"bufferingAutoFlush" : {
"title" : "Flush Each Event Immediately",
"description" : "Performance may be improved by writing all buffered events before flushing.",
"propertyOrder" : 1600,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
}
}
},
"commonHandlerPlugin" : {
"type" : "object",
"title" : "Audit Event Handler Factory",
"propertyOrder" : 1,
"properties" : {
"handlerFactory" : {
"title" : "Factory Class Name",
"description" : "The fully qualified class name of the factory responsible for creating the Audit Event Handler. The class must implement org.forgerock.openam.audit.AuditEventHandlerFactory.",
"propertyOrder" : 2100,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
}
}
}
```
### delete
**Usage**
```
am> delete Csv --global --id id
```
**Parameters**
* *\--id*
The unique identifier for the resource.
### getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
**Usage**
```
am> action Csv --global --actionName getAllTypes
```
### getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
**Usage**
```
am> action Csv --global --actionName getCreatableTypes
```
### nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
**Usage**
```
am> action Csv --global --actionName nextdescendents
```
### query
Get the full list of instances of this collection. This query only supports `_queryFilter=true` filter.
**Usage**
```
am> query Csv --global --filter filter
```
**Parameters**
* *\--filter*
A CREST formatted query filter, where "true" will query all.
### read
**Usage**
```
am> read Csv --global --id id
```
**Parameters**
* *\--id*
The unique identifier for the resource.
### update
**Usage**
```
am> update Csv --global --id id --body body
```
**Parameters**
* *\--id*
The unique identifier for the resource.
* *\--body*
The resource in JSON format, described by the following JSON schema:
```json
{
"type" : "object",
"properties" : {
"csvSecurity" : {
"type" : "object",
"title" : "Tamper Evident Configuration",
"propertyOrder" : 6,
"properties" : {
"securitySignatureInterval" : {
"title" : "Signature Interval",
"description" : "Signature generation interval, in seconds.",
"propertyOrder" : 2000,
"required" : false,
"type" : "string",
"exampleValue" : ""
},
"securityPassword" : {
"title" : "Certificate Store Password",
"description" : "Password for Java keystore.",
"propertyOrder" : 1900,
"required" : false,
"type" : "string",
"format" : "password",
"exampleValue" : ""
},
"securityFilename" : {
"title" : "Certificate Store Location",
"description" : "Path to Java keystore.",
"propertyOrder" : 1800,
"required" : false,
"type" : "string",
"exampleValue" : ""
},
"securityEnabled" : {
"title" : "Is Enabled",
"description" : "Enables the CSV tamper evident feature.",
"propertyOrder" : 1700,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
}
}
},
"csvFileRetention" : {
"type" : "object",
"title" : "File Retention",
"propertyOrder" : 4,
"properties" : {
"retentionMaxDiskSpaceToUse" : {
"title" : "Maximum Disk Space",
"description" : "The maximum amount of disk space the audit files can occupy, in bytes. A negative or zero value indicates this policy is disabled.",
"propertyOrder" : 1300,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"retentionMinFreeSpaceRequired" : {
"title" : "Minimum Free Space Required",
"description" : "Minimum amount of disk space required, in bytes, on the system where audit files are stored. A negative or zero value indicates this policy is disabled.",
"propertyOrder" : 1400,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"retentionMaxNumberOfHistoryFiles" : {
"title" : "Maximum Number of Historical Files",
"description" : "Maximum number of backup audit files allowed. A value of -1 disables pruning of old history files.",
"propertyOrder" : 1200,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
},
"csvFileRotation" : {
"type" : "object",
"title" : "File Rotation",
"propertyOrder" : 3,
"properties" : {
"rotationFilePrefix" : {
"title" : "File Rotation Prefix",
"description" : "Prefix to prepend to audit files when rotating audit files.",
"propertyOrder" : 800,
"required" : false,
"type" : "string",
"exampleValue" : ""
},
"rotationEnabled" : {
"title" : "Rotation Enabled",
"description" : "Enables and disables audit file rotation.",
"propertyOrder" : 600,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
},
"rotationMaxFileSize" : {
"title" : "Maximum File Size",
"description" : "Maximum size, in bytes, which an audit file can grow to before rotation is triggered. A negative or zero value indicates this policy is disabled.",
"propertyOrder" : 700,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"rotationInterval" : {
"title" : "Rotation Interval",
"description" : "Interval to trigger audit file rotations, in seconds. A negative or zero value disables this feature.",
"propertyOrder" : 1000,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"rotationTimes" : {
"title" : "Rotation Times",
"description" : "Durations after midnight to trigger file rotation, in seconds.",
"propertyOrder" : 1100,
"required" : true,
"items" : {
"type" : "string"
},
"type" : "array",
"exampleValue" : ""
},
"rotationFileSuffix" : {
"title" : "File Rotation Suffix",
"description" : "Suffix to append to audit files when they are rotated. Suffix should be a timestamp.",
"propertyOrder" : 900,
"required" : false,
"type" : "string",
"exampleValue" : ""
}
}
},
"commonHandler" : {
"type" : "object",
"title" : "General Handler Configuration",
"propertyOrder" : 0,
"properties" : {
"topics" : {
"title" : "Topics",
"description" : "List of topics handled by an audit event handler.",
"propertyOrder" : 400,
"required" : true,
"items" : {
"type" : "string"
},
"type" : "array",
"exampleValue" : ""
},
"enabled" : {
"title" : "Enabled",
"description" : "Enables or disables an audit event handler.",
"propertyOrder" : 300,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
}
}
},
"csvConfig" : {
"type" : "object",
"title" : "CSV Configuration",
"propertyOrder" : 2,
"properties" : {
"location" : {
"title" : "Log Directory",
"description" : "Directory in which to store audit log CSV files.",
"propertyOrder" : 500,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
},
"csvBuffering" : {
"type" : "object",
"title" : "Buffering",
"propertyOrder" : 5,
"properties" : {
"bufferingEnabled" : {
"title" : "Buffering Enabled",
"description" : "Enables or disables buffering.",
"propertyOrder" : 1500,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
},
"bufferingAutoFlush" : {
"title" : "Flush Each Event Immediately",
"description" : "Performance may be improved by writing all buffered events before flushing.",
"propertyOrder" : 1600,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
}
}
},
"commonHandlerPlugin" : {
"type" : "object",
"title" : "Audit Event Handler Factory",
"propertyOrder" : 1,
"properties" : {
"handlerFactory" : {
"title" : "Factory Class Name",
"description" : "The fully qualified class name of the factory responsible for creating the Audit Event Handler. The class must implement org.forgerock.openam.audit.AuditEventHandlerFactory.",
"propertyOrder" : 2100,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
}
}
}
```