OathUserDevices
Realm Operations
The Oath devices service is responsible for exposing functions to change the collection of OATH authentication devices. The supported methods are action, delete, query
Resource path:
/users/{user}/devices/2fa/oath
Resource version: 1.0
check
Checks if the user’s Authenticator OATH module is 'skippable' and returns the result as a boolean
Usage
am> action OathUserDevices --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" : "OATH user device check action request schema", "type" : "object", "title" : "OATH user device check action request schema" } - --user
-
The Oath devices service is responsible for exposing functions to change the collection of OATH authentication devices. The supported methods are action, delete, query
delete
Delete OATH user device
Usage
am> delete OathUserDevices --realm Realm --id id --user user
Parameters
- --id
-
The unique identifier for the resource.
- --user
-
The Oath devices service is responsible for exposing functions to change the collection of OATH authentication devices. The supported methods are action, delete, query
query
Query the user’s device profile
Usage
am> query OathUserDevices --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 Oath devices service is responsible for exposing functions to change the collection of OATH authentication devices. The supported methods are action, delete, query
reset
Sets the user’s 'skippable' selection of Authenticator OATH module to default (NOT_SET) and deletes their profiles attribute
Usage
am> action OathUserDevices --realm Realm --body body --user user --actionName reset
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "description" : "OATH user device reset action request schema", "type" : "object", "title" : "OATH user device reset action request schema" } - --user
-
The Oath devices service is responsible for exposing functions to change the collection of OATH authentication devices. The supported methods are action, delete, query
skip
Sets the user’s ability to skip an Authenticator OATH module
Usage
am> action OathUserDevices --realm Realm --body body --user user --actionName skip
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "description" : "OATH user device skip action request schema", "type" : "object", "title" : "OATH user device skip action request schema", "properties" : { "value" : { "type" : "boolean", "title" : "Skip OATH module response value", "description" : "True if the OATH device is set to skipped" } }, "required" : [ "value" ] } - --user
-
The Oath devices service is responsible for exposing functions to change the collection of OATH authentication devices. The supported methods are action, delete, query