PushUserDevices
Realm Operations
The Push devices service is responsible for exposing functions to change the collection of Push authentication devices. The supported methods are action, delete, query
Resource path:
/users/{user}/devices/2fa/push
Resource version: 1.0
check
Checks if the user’s Authenticator Push module is 'skippable' and returns the result as a boolean
Usage
am> action PushUserDevices --realm Realm --body body --user user --actionName check
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "$schema" : "http://json-schema.org/draft-04/schema#", "description" : "Push user device check action request schema", "type" : "object", "title" : "Push user device check action request schema" } - --user
-
The Push devices service is responsible for exposing functions to change the collection of Push authentication devices. The supported methods are action, delete, query
delete
Delete Push user device
Usage
am> delete PushUserDevices --realm Realm --id id --user user
Parameters
- --id
-
The unique identifier for the resource.
- --user
-
The Push devices service is responsible for exposing functions to change the collection of Push authentication devices. The supported methods are action, delete, query
query
Query the user’s device profile
Usage
am> query PushUserDevices --realm Realm --filter filter --user user
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all. Fields that can be queried: [*]
- --user
-
The Push devices service is responsible for exposing functions to change the collection of Push authentication devices. The supported methods are action, delete, query
reset
Sets the user’s 'skippable' selection of Authenticator Push module to default (NOT_SET) and deletes their profile’s attribute
Usage
am> action PushUserDevices --realm Realm --body body --user user --actionName reset
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "$schema" : "http://json-schema.org/draft-04/schema#", "description" : "Push user device reset action request schema", "type" : "object", "title" : "Push user device reset action request schema" } - --user
-
The Push devices service is responsible for exposing functions to change the collection of Push authentication devices. The supported methods are action, delete, query
skip
Sets the user’s ability to skip an Authenticator Push module
Usage
am> action PushUserDevices --realm Realm --body body --user user --actionName skip
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "description" : "Push user device skip action request schema", "type" : "object", "title" : "Push user device skip action request schema", "properties" : { "value" : { "type" : "boolean", "title" : "Skip push module response value", "description" : "True if the push device is set to skipped" } }, "required" : [ "value" ] } - --user
-
The Push devices service is responsible for exposing functions to change the collection of Push authentication devices. The supported methods are action, delete, query