WebAuthnDeviceStorageNode
Realm Operations
Resource path:
/realm-config/authentication/authenticationtrees/nodes/WebAuthnDeviceStorageNode
Resource version: 1.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" : { "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" : "" }, "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" : "" } }, "required" : [ "generateRecoveryCodes", "maxSavedDevices" ] }
delete
Usage
am> delete WebAuthnDeviceStorageNode --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 WebAuthnDeviceStorageNode --realm Realm --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action WebAuthnDeviceStorageNode --realm Realm --actionName getCreatableTypes
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:
{ "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 WebAuthnDeviceStorageNode --realm Realm --actionName nextdescendents
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" : { "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" : "" }, "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" : "" } }, "required" : [ "generateRecoveryCodes", "maxSavedDevices" ] }