DeviceProfileCollector
Realm Operations
Resource path:
/realm-config/authentication/authenticationtrees/nodes/DeviceProfileCollectorNode
Resource version: 1.0
create
Usage
am> create DeviceProfileCollector --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" : { "message" : { "title" : "Message", "description" : "Optional message to display to the user when capturing device information. Enter a locale in the KEY field, for example `en-us`, and the localized message as the VALUE.", "propertyOrder" : 400, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "deviceMetadata" : { "title" : "Collect Device Metadata", "description" : "Instructs the client to collect device metadata.", "propertyOrder" : 200, "type" : "boolean", "exampleValue" : "" }, "maximumSize" : { "title" : "Maximum Profile Size (KB)", "description" : "Specify the maximum accepted size for a device profile in kilobytes. If the returned profile size exceeds this maximum the authentication will fail. Note that larger profiles can impact performance.", "propertyOrder" : 100, "type" : "string", "exampleValue" : "" }, "deviceLocation" : { "title" : "Collect Device Location", "description" : "Instructs the client to collect device location.", "propertyOrder" : 300, "type" : "boolean", "exampleValue" : "" } }, "required" : [ "maximumSize", "deviceMetadata", "deviceLocation", "message" ] }
delete
Usage
am> delete DeviceProfileCollector --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 DeviceProfileCollector --realm Realm --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action DeviceProfileCollector --realm Realm --actionName getCreatableTypes
listOutcomes
List the available outcomes for the node type.
Usage
am> action DeviceProfileCollector --realm Realm --body body --actionName listOutcomes
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "title" : "Some configuration of the node. This does not need to be complete against the configuration schema." }
nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action DeviceProfileCollector --realm Realm --actionName nextdescendents
query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query DeviceProfileCollector --realm Realm --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read DeviceProfileCollector --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update DeviceProfileCollector --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" : { "message" : { "title" : "Message", "description" : "Optional message to display to the user when capturing device information. Enter a locale in the KEY field, for example `en-us`, and the localized message as the VALUE.", "propertyOrder" : 400, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "deviceMetadata" : { "title" : "Collect Device Metadata", "description" : "Instructs the client to collect device metadata.", "propertyOrder" : 200, "type" : "boolean", "exampleValue" : "" }, "maximumSize" : { "title" : "Maximum Profile Size (KB)", "description" : "Specify the maximum accepted size for a device profile in kilobytes. If the returned profile size exceeds this maximum the authentication will fail. Note that larger profiles can impact performance.", "propertyOrder" : 100, "type" : "string", "exampleValue" : "" }, "deviceLocation" : { "title" : "Collect Device Location", "description" : "Instructs the client to collect device location.", "propertyOrder" : 300, "type" : "boolean", "exampleValue" : "" } }, "required" : [ "maximumSize", "deviceMetadata", "deviceLocation", "message" ] }