WebAuthnUserDevices

Realm Operations

The WebAuthn devices service is responsible for exposing functions to change the collection of WebAuthn authentication devices. The supported methods are update, delete, query

Resource path: /users/{user}/devices/2fa/webauthn

Resource version: 1.0

delete

Delete WebAuthn user device

Usage:

am> delete WebAuthnUserDevices --realm Realm --id id --user user

Parameters:

--id: The unique identifier for the resource.
--user: The WebAuthn devices service is responsible for exposing functions to change the collection of WebAuthn authentication devices. The supported methods are update, delete, query

query

Query the user's WebAuthn devices

Usage:

am> query WebAuthnUserDevices --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 WebAuthn devices service is responsible for exposing functions to change the collection of WebAuthn authentication devices. The supported methods are update, delete, query

update

Update an existing WebAuthn user device

Usage:

am> update WebAuthnUserDevices --realm Realm --id id --body body --user user

Parameters:

--id

The unique identifier for the resource.

--body

The resource in JSON format, described by the following JSON schema:

{
  "$schema" : "http://json-schema.org/draft-04/schema#",
  "description" : "User devices schema that is used for WebAuthn authentication devices",
  "type" : "object",
  "title" : "User devices schema",
  "properties" : {
    "deviceName" : {
      "type" : "string",
      "title" : "Device Name",
      "description" : "The name of the WebAuthn device."
    },
    "uuid" : {
      "type" : "string",
      "title" : "UUID",
      "description" : "The unique identifier for this device."
    }
  }
}

--user

The WebAuthn devices service is responsible for exposing functions to change the collection of WebAuthn authentication devices. The supported methods are update, delete, query