JSONStdout
Realm Operations
Resource path:
/realm-config/services/audit/JSONStdout
Resource version: 1.0
create
Usage
am> create JSONStdout --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" : { "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" : "" } } }, "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" : { "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" : "" } } } } }
delete
Usage
am> delete JSONStdout --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 JSONStdout --realm Realm --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action JSONStdout --realm Realm --actionName getCreatableTypes
nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action JSONStdout --realm Realm --actionName nextdescendents
query
Get the full list of instances of this collection. This query only supports _queryFilter=true
filter.
Usage
am> query JSONStdout --realm Realm --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read JSONStdout --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update JSONStdout --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" : { "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" : "" } } }, "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" : { "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" : "" } } } } }
Global Operations
Resource path:
/global-config/services/audit/JSONStdout
Resource version: 1.0
create
Usage
am> create JSONStdout --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" : "" } } }, "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" : "" } } }, "jsonConfig" : { "type" : "object", "title" : "JSON Configuration", "propertyOrder" : 2, "properties" : { "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" : "" } } } } }
delete
Usage
am> delete JSONStdout --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 JSONStdout --global --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action JSONStdout --global --actionName getCreatableTypes
nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action JSONStdout --global --actionName nextdescendents
query
Get the full list of instances of this collection. This query only supports _queryFilter=true
filter.
Usage
am> query JSONStdout --global --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read JSONStdout --global --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update JSONStdout --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" : "" } } }, "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" : "" } } }, "jsonConfig" : { "type" : "object", "title" : "JSON Configuration", "propertyOrder" : 2, "properties" : { "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" : "" } } } } }