multi-factor-auth

multi-factor-auth enforcement get

Usage

usage: -c multi-factor-auth enforcement get [-h]
                                         [-f {adaptive_table,json,shell,table,value,yaml}]
                                         [-c COLUMN]
                                         [-m [NAME=VALUE [NAME=VALUE ...]]]
                                         [--max-width <integer>]
                                         [--noindent] [--prefix PREFIX]
                                         [--entity-type ENTITY_TYPE]
                                         [--entity-id ENTITY_ID]
                                         [--explicit]

Description

Get the Multi-Factor Authentication enforcement status of the given entity. If no entity is provided, the enforcement status of the system is returned.

Return

None

Optional

 optional arguments:
-h, --help            show this help message and exit
--entity-type ENTITY_TYPE
                      The type of the entity of which the enforcement status will be returned.
                      Valid values are: domain, user
--entity-id ENTITY_ID
                      The id of the entity of which the enforcement status will be returned
--explicit            Wether to return the explicit enforcement status, or the effective status (inherited from upper scope)

multi-factor-auth enforcement set

Usage

usage: -c multi-factor-auth enforcement set [-h]
                                         [-f {adaptive_table,json,shell,table,value,yaml}]
                                         [-c COLUMN]
                                         [-m [NAME=VALUE [NAME=VALUE ...]]]
                                         [--max-width <integer>]
                                         [--noindent] [--prefix PREFIX]
                                         [--entity-type ENTITY_TYPE]
                                         [--entity-id ENTITY_ID]

Description

Enforces Multi-Factor Authentication on the given entity. If no entity is provided, the enforcement will apply on the cluster/system level (available for system admins only). The enforcement won’t take effect until the user will log in. Already logged in users will not be affected. Enforcement is inherited from upper scopes and cannot be exempt. The scope order is cluster (system) > domain (account) > user.

Return

None

Optional

 optional arguments:
-h, --help            show this help message and exit
--entity-type ENTITY_TYPE
                      The type of the entity of which the enforcement status will be returned.
                      Valid values are: domain, user
--entity-id ENTITY_ID
                      The id of the entity of which the enforcement status will be returned

multi-factor-auth enforcement unset

Usage

usage: -c multi-factor-auth enforcement unset [-h]
                                           [-f {adaptive_table,json,shell,table,value,yaml}]
                                           [-c COLUMN]
                                           [-m [NAME=VALUE [NAME=VALUE ...]]]
                                           [--max-width <integer>]
                                           [--noindent] [--prefix PREFIX]
                                           [--entity-type ENTITY_TYPE]
                                           [--entity-id ENTITY_ID]

Description

Removes explicit Multi-Factor Authentication enforcement on the given entity. If no entity is provided, the enforcement will removed from cluster/system level (available for system admins only). Users with Multi-Factor Authentication enabled won’t be affected. This only removes an explicit Multi-Factor Authentication from the object, if it exists, if the object still inherits Multi-Factor Authentication enforcement from upper scopes, he will still be enforced. The scope order is cluster (system) > domain (account) > user.

Return

None

Optional

 optional arguments:
-h, --help            show this help message and exit
--entity-type ENTITY_TYPE
                      The type of the entity of which the enforcement status will be returned.
                      Valid values are: domain, user
--entity-id ENTITY_ID
                      The id of the entity of which the enforcement status will be returned