DeviceMatch
Realm Operations
Resource path:
/realm-config/authentication/authenticationtrees/nodes/DeviceMatchNode
Resource version: 1.0
create
Usage
am> create DeviceMatch --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" : { "useScript" : { "title" : "Use Custom Matching Script", "description" : "Use a custom script for matching device profiles. When enabled, the Acceptable Variance and Expiration properties are ignored. The script's type has to be: Decision Node Script.", "propertyOrder" : 300, "type" : "boolean", "exampleValue" : "" }, "script" : { "title" : "Custom Matching Script", "description" : "Decision Node Script", "propertyOrder" : 400, "type" : "string", "exampleValue" : "" }, "expiration" : { "title" : "Expiration", "description" : "Specify the number of days until profile expiration. Expired profiles will not match.", "propertyOrder" : 200, "type" : "integer", "exampleValue" : "" }, "acceptableVariance" : { "title" : "Acceptable Variance", "description" : "Specify the maximum amount of device attribute differences that is still acceptable for a match.", "propertyOrder" : 100, "type" : "integer", "exampleValue" : "" } }, "required" : [ "expiration", "useScript", "acceptableVariance", "script" ] }
delete
Usage
am> delete DeviceMatch --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 DeviceMatch --realm Realm --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action DeviceMatch --realm Realm --actionName getCreatableTypes
listOutcomes
List the available outcomes for the node type.
Usage
am> action DeviceMatch --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 DeviceMatch --realm Realm --actionName nextdescendents
query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query DeviceMatch --realm Realm --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read DeviceMatch --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update DeviceMatch --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" : { "useScript" : { "title" : "Use Custom Matching Script", "description" : "Use a custom script for matching device profiles. When enabled, the Acceptable Variance and Expiration properties are ignored. The script's type has to be: Decision Node Script.", "propertyOrder" : 300, "type" : "boolean", "exampleValue" : "" }, "script" : { "title" : "Custom Matching Script", "description" : "Decision Node Script", "propertyOrder" : 400, "type" : "string", "exampleValue" : "" }, "expiration" : { "title" : "Expiration", "description" : "Specify the number of days until profile expiration. Expired profiles will not match.", "propertyOrder" : 200, "type" : "integer", "exampleValue" : "" }, "acceptableVariance" : { "title" : "Acceptable Variance", "description" : "Specify the maximum amount of device attribute differences that is still acceptable for a match.", "propertyOrder" : 100, "type" : "integer", "exampleValue" : "" } }, "required" : [ "expiration", "useScript", "acceptableVariance", "script" ] }