Amster

DeviceSigningVerifier

Realm Operations

Resource path:

/realm-config/authentication/authenticationtrees/nodes/DeviceSigningVerifierNode

Resource version: 1.0

create

Usage

am> create DeviceSigningVerifier --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" : {
    "clientErrorOutcomes" : {
      "title" : "Client Error Outcomes",
      "description" : "Specify the client error outcomes",
      "propertyOrder" : 700,
      "items" : {
        "type" : "string"
      },
      "type" : "array",
      "exampleValue" : ""
    },
    "applicationIds" : {
      "title" : "Application Ids",
      "description" : "The Android package names or iOS bundle IDs that issue the binding request.",
      "propertyOrder" : 250,
      "items" : {
        "type" : "string"
      },
      "minItems" : 1,
      "type" : "array",
      "exampleValue" : ""
    },
    "timeout" : {
      "title" : "Timeout",
      "description" : "The number of seconds to wait for a valid device to be bound before failing.",
      "propertyOrder" : 600,
      "type" : "integer",
      "exampleValue" : ""
    },
    "subtitle" : {
      "title" : "Subtitle",
      "description" : "The subtitle to be displayed on the biometric prompt.",
      "propertyOrder" : 400,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    },
    "description" : {
      "title" : "Description",
      "description" : "The description to be displayed on the biometric prompt.",
      "propertyOrder" : 500,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    },
    "sharedStateAttribute" : {
      "title" : "Shared State Attribute As Challenge.",
      "description" : "Shared State attribute as challenge for signing.",
      "propertyOrder" : 200,
      "type" : "string",
      "exampleValue" : ""
    },
    "title" : {
      "title" : "Title",
      "description" : "The title to be displayed on the biometric prompt.",
      "propertyOrder" : 300,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    },
    "challenge" : {
      "title" : "Sign Random Challenge.",
      "description" : "Auto generate challenge for signing.",
      "propertyOrder" : 100,
      "type" : "boolean",
      "exampleValue" : ""
    }
  },
  "required" : [ "clientErrorOutcomes", "applicationIds", "timeout", "subtitle", "description", "sharedStateAttribute", "title", "challenge" ]
}

delete

Usage

am> delete DeviceSigningVerifier --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 DeviceSigningVerifier --realm Realm --actionName getAllTypes

getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

Usage

am> action DeviceSigningVerifier --realm Realm --actionName getCreatableTypes

listOutcomes

List the available outcomes for the node type.

Usage

am> action DeviceSigningVerifier --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 DeviceSigningVerifier --realm Realm --actionName nextdescendents

query

Get the full list of instances of this collection. This query only supports _queryFilter=true filter.

Usage

am> query DeviceSigningVerifier --realm Realm --filter filter

Parameters

--filter

A CREST formatted query filter, where "true" will query all.

read

Usage

am> read DeviceSigningVerifier --realm Realm --id id

Parameters

--id

The unique identifier for the resource.

update

Usage

am> update DeviceSigningVerifier --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" : {
    "clientErrorOutcomes" : {
      "title" : "Client Error Outcomes",
      "description" : "Specify the client error outcomes",
      "propertyOrder" : 700,
      "items" : {
        "type" : "string"
      },
      "type" : "array",
      "exampleValue" : ""
    },
    "applicationIds" : {
      "title" : "Application Ids",
      "description" : "The Android package names or iOS bundle IDs that issue the binding request.",
      "propertyOrder" : 250,
      "items" : {
        "type" : "string"
      },
      "minItems" : 1,
      "type" : "array",
      "exampleValue" : ""
    },
    "timeout" : {
      "title" : "Timeout",
      "description" : "The number of seconds to wait for a valid device to be bound before failing.",
      "propertyOrder" : 600,
      "type" : "integer",
      "exampleValue" : ""
    },
    "subtitle" : {
      "title" : "Subtitle",
      "description" : "The subtitle to be displayed on the biometric prompt.",
      "propertyOrder" : 400,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    },
    "description" : {
      "title" : "Description",
      "description" : "The description to be displayed on the biometric prompt.",
      "propertyOrder" : 500,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    },
    "sharedStateAttribute" : {
      "title" : "Shared State Attribute As Challenge.",
      "description" : "Shared State attribute as challenge for signing.",
      "propertyOrder" : 200,
      "type" : "string",
      "exampleValue" : ""
    },
    "title" : {
      "title" : "Title",
      "description" : "The title to be displayed on the biometric prompt.",
      "propertyOrder" : 300,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    },
    "challenge" : {
      "title" : "Sign Random Challenge.",
      "description" : "Auto generate challenge for signing.",
      "propertyOrder" : 100,
      "type" : "boolean",
      "exampleValue" : ""
    }
  },
  "required" : [ "clientErrorOutcomes", "applicationIds", "timeout", "subtitle", "description", "sharedStateAttribute", "title", "challenge" ]
}
Copyright © 2010-2024 ForgeRock, all rights reserved.