password-reset

password-reset config get

Usage

  usage: symp password-reset config get
[-f {adaptive_table,json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--noindent] [--prefix PREFIX]
                                        [-m [NAME=VALUE [NAME=VALUE ...]]]

Description

Get the current self-service password-reset configuration.

Returns

Returns dict: The password-reset configuration including the status and the external endpoint being used

Optional

optional arguments:
  -h, --help            show this help message and exit

password-reset config set

Usage

  usage: symp password-reset config set
[-f {adaptive_table,json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--noindent] [--prefix PREFIX]
                                        [-m [NAME=VALUE [NAME=VALUE ...]]]
                                        [--external-endpoint-id EXTERNAL_ENDPOINT_ID]

Description

Sets the self-service password-reset configuration.

Returns

Returns dict: The new password-reset configuration

Optional

optional arguments:
  -h, --help            show this help message and exit
  --external-endpoint-id EXTERNAL_ENDPOINT_ID
                        The SMTP external endpoint to be used for sending password reset links.
                        Omit this to unset the SMTP endpoint and disable password-reset

password-reset email-template get

Usage

  usage: symp password-reset email-template get
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--noindent] [--prefix PREFIX]
                                                [-m [NAME=VALUE [NAME=VALUE ...]]]

Description

Get the current self-service password-reset configuration.

Returns

Returns dict: Email template configuration containing the subject, text template and html template

Optional

optional arguments:
  -h, --help            show this help message and exit

password-reset email-template reset

Usage

  usage: symp password-reset email-template reset
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--max-width <integer>]
                                                  [--noindent] [--prefix PREFIX]
                                                  [-m [NAME=VALUE [NAME=VALUE ...]]]

Description

Resets the self-service password-reset configuration.

Optional

optional arguments:
  -h, --help            show this help message and exit

password-reset email-template update

Usage

  usage: symp password-reset email-template update
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                   [-c COLUMN]
                                                   [--max-width <integer>]
                                                   [--noindent]
                                                   [--prefix PREFIX]
                                                   [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                   [--file FILE]
                                                   [--subject SUBJECT]
                                                   [--text-template TEXT_TEMPLATE]

Description

Sets the self-service password-reset configuration.

Returns

Returns dict: The new password-reset configuration

Optional

optional arguments:
  -h, --help            show this help message and exit
  --file FILE
  --subject SUBJECT     The subject of the password-reset email
  --text-template TEXT_TEMPLATE
                        The plain-text template of the password-reset email content.
                        Need to contain ${NAME} and ${URL}
                        Used in cases where HTML is absent or cannot be displayed