app.models.user.User.get_redirect_qparams

User.get_redirect_qparams(existing: Optional[Dict[str, Any]] = None) → Dict[str, Any]

Return user info that will be added to redirect query params.

Parameters

existing – A dict that will be updated.

Returns

A dict whose keys will be query params and values will be query values.

The returned dict will always have an ‘identity’ key/value. If the User Model contains ‘email’, an ‘email’ key/value will added. All keys provided in ‘existing’ will also be merged in.

New in version 3.2.0.

Changed in version 4.0.0: Add ‘identity’ using UserMixin.calc_username() - email is optional.