Multifactor devices deprecated

Manage multifactor devices for OX App Suite Middleware.

This article describes how to manage the OX App Suite Middleware multifactor devices.

Prerequisites

  • An active shell to a running Toolkit Container within the cluster. See Starting.
  • Access to the OX App Suite Middleware's Admin REST API.

Commands

To manage the OX App Suite Middleware multifactor, use the mwctl multifactor tool with its various sub commands.


Note:

All mwctl multifactor sub commands operate on the OX App Suite Middleware Admin REST API and therefore require admin credentials when invoked.

By default, the commands operate on multifactor devices within the specified user's context across all available OX App Suite Middleware containers detected in the current namespace. This discovery happens through the default app=core-mw Kubernetes label.


Tip:

You can also use the --urls flag to specify a list of URLs or a single URL of hosts to get the multifactor devices.

Getting multifactor devices

Use the get subcommand to list all multifactor devices with their ID, name, provider name, enabled status, and whether they are backup devices.:

mwctl multifactor get

Use the --contextid (or -c) flag to specify a particular context. Additionally, the flags --userid (or -i) must be used to display multifactor devices associated with a specific user.

Both flags are required to show the device list:

mwctl multifactor get -c <CONTEXT-ID> -i <USER-ID>

Deleting multifactor devices

Use the delete subcommand to remove all multifactor devices related to a specific context or user, or to delete a specific multifactor device.

Use the --providerName flag and the --deviceId flag to delete a specific device or use the -a flag to remove all multifactor devices.

mwctl multifactor delete -c <CONTEXT-ID> -i <USER-ID> -a  
mwctl multifactor delete -c <CONTEXT-ID> -i <USER-ID> -d <DEVICE-ID> -P <PROVIDER-NAME>

Tip:

If you omit specifying a device, your have to set the --all flag to delete all multifactor devices within the specified scope.

See also

See "mwtctl multifactor" for detailed documentation of the multifactor subcommand.