MFARegistrationOptions
Realm Operations
Resource path:
/realm-config/authentication/authenticationtrees/nodes/MultiFactorRegistrationOptionsNode
Resource version: 1.0
create
Usage
am> create MFARegistrationOptions --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" : { "getApp" : { "title" : "Display Get Authenticator App", "description" : "If enabled, display the 'Get the App' button", "propertyOrder" : 20, "type" : "boolean", "exampleValue" : "" }, "optOutLabel" : { "title" : "Opt-out", "description" : "Localisation for the 'Opt-out' button.", "propertyOrder" : 70, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "mandatory" : { "title" : "Remove 'skip' option", "description" : "If checked, users will no longer be able to skip the module, and must interact with it.", "propertyOrder" : 10, "type" : "boolean", "exampleValue" : "" }, "message" : { "title" : "Message", "description" : "Localised message for skip the second factor authentication", "propertyOrder" : 30, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "registerDeviceLabel" : { "title" : "Register Device", "description" : "Localisation for the Register Device button.", "propertyOrder" : 40, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "getAppLabel" : { "title" : "Get Authenticator App", "description" : "Localisation for the Get Authenticator App button.", "propertyOrder" : 50, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "skipStepLabel" : { "title" : "Skip this Step", "description" : "Localisation for the Skip this Step button.", "propertyOrder" : 60, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" } }, "required" : [ "mandatory", "getAppLabel", "message", "optOutLabel", "skipStepLabel", "registerDeviceLabel", "getApp" ] }
delete
Usage
am> delete MFARegistrationOptions --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 MFARegistrationOptions --realm Realm --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action MFARegistrationOptions --realm Realm --actionName getCreatableTypes
listOutcomes
List the available outcomes for the node type.
Usage
am> action MFARegistrationOptions --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 MFARegistrationOptions --realm Realm --actionName nextdescendents
query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query MFARegistrationOptions --realm Realm --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read MFARegistrationOptions --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update MFARegistrationOptions --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" : { "getApp" : { "title" : "Display Get Authenticator App", "description" : "If enabled, display the 'Get the App' button", "propertyOrder" : 20, "type" : "boolean", "exampleValue" : "" }, "optOutLabel" : { "title" : "Opt-out", "description" : "Localisation for the 'Opt-out' button.", "propertyOrder" : 70, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "mandatory" : { "title" : "Remove 'skip' option", "description" : "If checked, users will no longer be able to skip the module, and must interact with it.", "propertyOrder" : 10, "type" : "boolean", "exampleValue" : "" }, "message" : { "title" : "Message", "description" : "Localised message for skip the second factor authentication", "propertyOrder" : 30, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "registerDeviceLabel" : { "title" : "Register Device", "description" : "Localisation for the Register Device button.", "propertyOrder" : 40, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "getAppLabel" : { "title" : "Get Authenticator App", "description" : "Localisation for the Get Authenticator App button.", "propertyOrder" : 50, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "skipStepLabel" : { "title" : "Skip this Step", "description" : "Localisation for the Skip this Step button.", "propertyOrder" : 60, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" } }, "required" : [ "mandatory", "getAppLabel", "message", "optOutLabel", "skipStepLabel", "registerDeviceLabel", "getApp" ] }