Amster

BoundDevice

Realm Operations

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

Resource path:

/users/{user}/devices/2fa/binding

Resource version: 1.0

delete

Delete user bounded device

Usage

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

Parameters

--id

The unique identifier for the resource.

--user

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

query

Query the user bounded devices

Usage

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

update

Update an existing user bounded device name

Usage

am> update BoundDevice --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 user bounded devices",
  "type" : "object",
  "title" : "User devices schema",
  "properties" : {
    "deviceName" : {
      "type" : "string",
      "title" : "Device Name",
      "description" : "The name of the user bounded device."
    },
    "uuid" : {
      "type" : "string",
      "title" : "UUID",
      "description" : "The unique identifier for this device."
    },
    "createdDate" : {
      "type" : "integer",
      "title" : "Device created date.",
      "description" : "schema.createDate.description"
    },
    "lastAccessDate" : {
      "type" : "integer",
      "title" : "Device last access date.",
      "description" : "The device last successfully signing and verify date."
    }
  }
}
--user

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

Copyright © 2010-2023 ForgeRock, all rights reserved.