Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate change_password in favor of reset_password #297

Merged
merged 2 commits into from
Sep 9, 2021

Conversation

davidpatrick
Copy link
Contributor

The method change_password took a password argument that was only supported on legacy tenants with the flag change_pwd_flow_v1 enabled. In order to resolve confusion, we're introducing a new method reset_password to fire off a password reset email, and deprecating the old method.

Fixes #292

The method `change_password` took a password argument that was only supported on legacy tenants with the flag `change_pwd_flow_v1` enabled.  In order to resolve confusion, we're introducing a new method `reset_password` to fire off a password reset email, and deprecating the old method.
# @param password [string] User's new password; empty to trigger a
# password reset email
# @param password [string] User's new password. This is only available
# on legacy tenants with the change_pwd_flow_v1 flag enabled
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Honestly not sure, but do we expose the flag identifier anywhere in a customer-facing fashion? If not, it might be better to identify this as the "Change Password Flow" toggle indicated in their tenant account settings, under the advanced tab: if v2 is enabled it's locked out for them.

@evansims
Copy link
Member

evansims commented Sep 9, 2021

Question aside LGTM

evansims
evansims previously approved these changes Sep 9, 2021
@davidpatrick davidpatrick added this to the vNext milestone Sep 9, 2021
@davidpatrick davidpatrick merged commit de62458 into master Sep 9, 2021
@davidpatrick davidpatrick deleted the davidpatrick-patch-1 branch September 9, 2021 18:09
@davidpatrick davidpatrick mentioned this pull request Sep 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unsupported parameter password for change_password API
2 participants