Json
Realm Operations
Resource path:
/realm-config/services/audit/JSON
Resource version: 1.0
create
Usage
am> create Json --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:
{ "type" : "object", "properties" : { "jsonFileRotation" : { "type" : "object", "title" : "File Rotation", "propertyOrder" : 3, "properties" : { "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" : "" }, "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" : "" }, "rotationEnabled" : { "title" : "Rotation Enabled", "description" : "Enables and disables audit file rotation.", "propertyOrder" : 600, "required" : true, "type" : "boolean", "exampleValue" : "" }, "rotationFilePrefix" : { "title" : "File Rotation Prefix", "description" : "Prefix to prepend to audit files when rotating audit files.", "propertyOrder" : 800, "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" : "" } } }, "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 <code>org.forgerock.openam.audit.AuditEventHandlerFactory</code>.", "propertyOrder" : 1900, "required" : true, "type" : "string", "exampleValue" : "" } } }, "jsonBuffering" : { "type" : "object", "title" : "Buffering", "propertyOrder" : 5, "properties" : { "bufferingWriteInterval" : { "title" : "Write interval", "description" : "Interval at which buffered events are written to a file, in milliseconds.", "propertyOrder" : 1600, "required" : true, "type" : "string", "exampleValue" : "" }, "bufferingMaxSize" : { "title" : "Batch Size", "description" : "Maximum number of events that can be buffered (default/minimum: 100000)", "propertyOrder" : 1500, "required" : true, "type" : "string", "exampleValue" : "" } } }, "jsonFileRetention" : { "type" : "object", "title" : "File Retention", "propertyOrder" : 4, "properties" : { "retentionMaxNumberOfHistoryFiles" : { "title" : "Maximum Number of Historical Files", "description" : "Maximum number of backup audit files allowed. A value of <code>-1</code> disables pruning of old history files.", "propertyOrder" : 1200, "required" : true, "type" : "string", "exampleValue" : "" }, "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" : "" } } }, "jsonConfig" : { "type" : "object", "title" : "JSON Configuration", "propertyOrder" : 2, "properties" : { "rotationRetentionCheckInterval" : { "title" : "File Rotation Retention Check Interval", "description" : "Interval to check time-based file rotation policies, in seconds.", "propertyOrder" : 1800, "required" : true, "type" : "string", "exampleValue" : "" }, "elasticsearchCompatible" : { "title" : "ElasticSearch JSON Format Compatible", "description" : "JSON format should be transformed to be compatible with ElasticSearch format restrictions.", "propertyOrder" : 1700, "required" : true, "type" : "boolean", "exampleValue" : "" }, "location" : { "title" : "Log Directory", "description" : "Directory in which to store audit log JSON files.", "propertyOrder" : 500, "required" : true, "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" : "" } } } } }
delete
Usage
am> delete Json --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 Json --realm Realm --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action Json --realm Realm --actionName getCreatableTypes
nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action Json --realm Realm --actionName nextdescendents
query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query Json --realm Realm --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read Json --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update Json --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:
{ "type" : "object", "properties" : { "jsonFileRotation" : { "type" : "object", "title" : "File Rotation", "propertyOrder" : 3, "properties" : { "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" : "" }, "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" : "" }, "rotationEnabled" : { "title" : "Rotation Enabled", "description" : "Enables and disables audit file rotation.", "propertyOrder" : 600, "required" : true, "type" : "boolean", "exampleValue" : "" }, "rotationFilePrefix" : { "title" : "File Rotation Prefix", "description" : "Prefix to prepend to audit files when rotating audit files.", "propertyOrder" : 800, "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" : "" } } }, "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 <code>org.forgerock.openam.audit.AuditEventHandlerFactory</code>.", "propertyOrder" : 1900, "required" : true, "type" : "string", "exampleValue" : "" } } }, "jsonBuffering" : { "type" : "object", "title" : "Buffering", "propertyOrder" : 5, "properties" : { "bufferingWriteInterval" : { "title" : "Write interval", "description" : "Interval at which buffered events are written to a file, in milliseconds.", "propertyOrder" : 1600, "required" : true, "type" : "string", "exampleValue" : "" }, "bufferingMaxSize" : { "title" : "Batch Size", "description" : "Maximum number of events that can be buffered (default/minimum: 100000)", "propertyOrder" : 1500, "required" : true, "type" : "string", "exampleValue" : "" } } }, "jsonFileRetention" : { "type" : "object", "title" : "File Retention", "propertyOrder" : 4, "properties" : { "retentionMaxNumberOfHistoryFiles" : { "title" : "Maximum Number of Historical Files", "description" : "Maximum number of backup audit files allowed. A value of <code>-1</code> disables pruning of old history files.", "propertyOrder" : 1200, "required" : true, "type" : "string", "exampleValue" : "" }, "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" : "" } } }, "jsonConfig" : { "type" : "object", "title" : "JSON Configuration", "propertyOrder" : 2, "properties" : { "rotationRetentionCheckInterval" : { "title" : "File Rotation Retention Check Interval", "description" : "Interval to check time-based file rotation policies, in seconds.", "propertyOrder" : 1800, "required" : true, "type" : "string", "exampleValue" : "" }, "elasticsearchCompatible" : { "title" : "ElasticSearch JSON Format Compatible", "description" : "JSON format should be transformed to be compatible with ElasticSearch format restrictions.", "propertyOrder" : 1700, "required" : true, "type" : "boolean", "exampleValue" : "" }, "location" : { "title" : "Log Directory", "description" : "Directory in which to store audit log JSON files.", "propertyOrder" : 500, "required" : true, "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" : "" } } } } }
Global Operations
Resource path:
/global-config/services/audit/JSON
Resource version: 1.0
create
Usage
am> create Json --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:
{ "type" : "object", "properties" : { "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 <code>org.forgerock.openam.audit.AuditEventHandlerFactory</code>.", "propertyOrder" : 1900, "required" : true, "type" : "string", "exampleValue" : "" } } }, "jsonConfig" : { "type" : "object", "title" : "JSON Configuration", "propertyOrder" : 2, "properties" : { "location" : { "title" : "Log Directory", "description" : "Directory in which to store audit log JSON files.", "propertyOrder" : 500, "required" : true, "type" : "string", "exampleValue" : "" }, "elasticsearchCompatible" : { "title" : "ElasticSearch JSON Format Compatible", "description" : "JSON format should be transformed to be compatible with ElasticSearch format restrictions.", "propertyOrder" : 1700, "required" : true, "type" : "boolean", "exampleValue" : "" }, "rotationRetentionCheckInterval" : { "title" : "File Rotation Retention Check Interval", "description" : "Interval to check time-based file rotation policies, in seconds.", "propertyOrder" : 1800, "required" : true, "type" : "string", "exampleValue" : "" } } }, "jsonFileRotation" : { "type" : "object", "title" : "File Rotation", "propertyOrder" : 3, "properties" : { "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" : "" }, "rotationFilePrefix" : { "title" : "File Rotation Prefix", "description" : "Prefix to prepend to audit files when rotating audit files.", "propertyOrder" : 800, "required" : false, "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" : "" }, "rotationEnabled" : { "title" : "Rotation Enabled", "description" : "Enables and disables audit file rotation.", "propertyOrder" : 600, "required" : true, "type" : "boolean", "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" : { "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" : "" } } }, "jsonBuffering" : { "type" : "object", "title" : "Buffering", "propertyOrder" : 5, "properties" : { "bufferingWriteInterval" : { "title" : "Write interval", "description" : "Interval at which buffered events are written to a file, in milliseconds.", "propertyOrder" : 1600, "required" : true, "type" : "string", "exampleValue" : "" }, "bufferingMaxSize" : { "title" : "Batch Size", "description" : "Maximum number of events that can be buffered (default/minimum: 100000)", "propertyOrder" : 1500, "required" : true, "type" : "string", "exampleValue" : "" } } }, "jsonFileRetention" : { "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 <code>-1</code> disables pruning of old history files.", "propertyOrder" : 1200, "required" : true, "type" : "string", "exampleValue" : "" } } } } }
delete
Usage
am> delete Json --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 Json --global --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action Json --global --actionName getCreatableTypes
nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action Json --global --actionName nextdescendents
query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query Json --global --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
update
Usage
am> update Json --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:
{ "type" : "object", "properties" : { "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 <code>org.forgerock.openam.audit.AuditEventHandlerFactory</code>.", "propertyOrder" : 1900, "required" : true, "type" : "string", "exampleValue" : "" } } }, "jsonConfig" : { "type" : "object", "title" : "JSON Configuration", "propertyOrder" : 2, "properties" : { "location" : { "title" : "Log Directory", "description" : "Directory in which to store audit log JSON files.", "propertyOrder" : 500, "required" : true, "type" : "string", "exampleValue" : "" }, "elasticsearchCompatible" : { "title" : "ElasticSearch JSON Format Compatible", "description" : "JSON format should be transformed to be compatible with ElasticSearch format restrictions.", "propertyOrder" : 1700, "required" : true, "type" : "boolean", "exampleValue" : "" }, "rotationRetentionCheckInterval" : { "title" : "File Rotation Retention Check Interval", "description" : "Interval to check time-based file rotation policies, in seconds.", "propertyOrder" : 1800, "required" : true, "type" : "string", "exampleValue" : "" } } }, "jsonFileRotation" : { "type" : "object", "title" : "File Rotation", "propertyOrder" : 3, "properties" : { "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" : "" }, "rotationFilePrefix" : { "title" : "File Rotation Prefix", "description" : "Prefix to prepend to audit files when rotating audit files.", "propertyOrder" : 800, "required" : false, "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" : "" }, "rotationEnabled" : { "title" : "Rotation Enabled", "description" : "Enables and disables audit file rotation.", "propertyOrder" : 600, "required" : true, "type" : "boolean", "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" : { "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" : "" } } }, "jsonBuffering" : { "type" : "object", "title" : "Buffering", "propertyOrder" : 5, "properties" : { "bufferingWriteInterval" : { "title" : "Write interval", "description" : "Interval at which buffered events are written to a file, in milliseconds.", "propertyOrder" : 1600, "required" : true, "type" : "string", "exampleValue" : "" }, "bufferingMaxSize" : { "title" : "Batch Size", "description" : "Maximum number of events that can be buffered (default/minimum: 100000)", "propertyOrder" : 1500, "required" : true, "type" : "string", "exampleValue" : "" } } }, "jsonFileRetention" : { "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 <code>-1</code> disables pruning of old history files.", "propertyOrder" : 1200, "required" : true, "type" : "string", "exampleValue" : "" } } } } }