WebAuthnDeviceStorageNode
Realm Operations
Resource path:
/realm-config/authentication/authenticationtrees/nodes/WebAuthnDeviceStorageNode/1.0
Resource version: 3.0
create
Usage
am> create WebAuthnDeviceStorageNode --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" : { "maxSavedDevices" : { "title" : "Maximum Saved Devices", "description" : "Specify the maximum number of WebAuthn devices to save in a user's profile. 0 for unlimited.", "propertyOrder" : 20, "type" : "integer", "exampleValue" : "" }, "generateRecoveryCodes" : { "title" : "Generate recovery codes", "description" : "If enabled, the success outcome's transient state will contain a set of recovery codes. If this success outcome is passed into a Recovery Code Display Node, these codes will be presented to the user. A user may use recovery codes to bypass the WebAuthn authentication node in the event they have lost their authenticator. A set of recovery codes is shared among all registered WebAuthn authenticators, with the latest-generated set being the only valid set of codes.", "propertyOrder" : 10, "type" : "boolean", "exampleValue" : "" } }, "required" : [ "maxSavedDevices", "generateRecoveryCodes" ] }
delete
Usage
am> delete WebAuthnDeviceStorageNode --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
getType
List information related to the node such as a name, description, tags and metadata.
Usage
am> action WebAuthnDeviceStorageNode --realm Realm --actionName getType
getUpgradedConfig
Get the upgraded configuration for the node type.
Usage
am> action WebAuthnDeviceStorageNode --realm Realm --body body --actionName getUpgradedConfig --targetVersion targetVersion
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "title" : "The current configuration of the node type." } - --targetVersion
-
=== listOutcomes
List the available outcomes for the node type.
Usage
am> action WebAuthnDeviceStorageNode --realm Realm --body body --actionName listOutcomes
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "description" : "Some configuration of the node. This does not need to be complete against the configuration schema.", "type" : "object", "title" : "Node configuration" }
query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query WebAuthnDeviceStorageNode --realm Realm --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read WebAuthnDeviceStorageNode --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update WebAuthnDeviceStorageNode --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" : { "maxSavedDevices" : { "title" : "Maximum Saved Devices", "description" : "Specify the maximum number of WebAuthn devices to save in a user's profile. 0 for unlimited.", "propertyOrder" : 20, "type" : "integer", "exampleValue" : "" }, "generateRecoveryCodes" : { "title" : "Generate recovery codes", "description" : "If enabled, the success outcome's transient state will contain a set of recovery codes. If this success outcome is passed into a Recovery Code Display Node, these codes will be presented to the user. A user may use recovery codes to bypass the WebAuthn authentication node in the event they have lost their authenticator. A set of recovery codes is shared among all registered WebAuthn authenticators, with the latest-generated set being the only valid set of codes.", "propertyOrder" : 10, "type" : "boolean", "exampleValue" : "" } }, "required" : [ "maxSavedDevices", "generateRecoveryCodes" ] }