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

Added the Reset password API documentation #3334

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

aleksandrychev
Copy link
Contributor

Ticket: ENT-10837

@aleksandrychev
Copy link
Contributor Author

@cf-bottom jenkins

Copy link
Contributor

@craigcomstock craigcomstock left a comment

Choose a reason for hiding this comment

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

yeah, if we can, remove the error codes which reveal information about user accounts existing and backoff algorithms. I understand if Mission Portal needs this information from this API, I wonder if we could limit the response codes only in the case that the request came from not localhost essentially?

api/enterprise-api-ref/reset-password.markdown Outdated Show resolved Hide resolved
api/enterprise-api-ref/reset-password.markdown Outdated Show resolved Hide resolved
api/enterprise-api-ref/reset-password.markdown Outdated Show resolved Hide resolved
Ticket: ENT-10837
Signed-off-by: Ihor Aleksandrychiev <[email protected]>
Copy link
Contributor

@craigcomstock craigcomstock left a comment

Choose a reason for hiding this comment

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

Shouldn't there generally be comments about what RBAC privileges a user needs to perform these operations?

Other than that a formatting quibble which you can take or leave. 👍

Comment on lines +9 to +12
This call initiates the password reset process by sending a reset password
link and token to the user's registered email address. User can click the link from the email
and set a new password in the Mission Portal or invalidate the request.
Every request has an expiration time equal to 48 hours.
Copy link
Contributor

Choose a reason for hiding this comment

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

I am pretty sure that for markdown we can use one-sentence-per-line which is easier to edit/manipulate/see changes.

Suggested change
This call initiates the password reset process by sending a reset password
link and token to the user's registered email address. User can click the link from the email
and set a new password in the Mission Portal or invalidate the request.
Every request has an expiration time equal to 48 hours.
This call initiates the password reset process by sending a reset password link and token to the user's registered email address. User can click the link from the email and set a new password in the Mission Portal or invalidate the request.
Every request has an expiration time equal to 48 hours.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants