Add documentation for AuthenticateResult.Fail failureMessage parameter.
Open
area-security
Docs
- Dominant language
- C#
- Stars
- 38.4k
- Forks
- 10.9k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 281
Description
## Background and Motivation
This is not an API change proposal but documentation change/extension proposal.
In `AuthenticationHandler` (namespace `Microsoft.AspNetCore.Authentication`), when `AuthenticateResult.Fail` is used, it accepts `failureMessage` parameter. It does not make it into the response.
Please add documentation for what is intended purpose of this parameter.
There is an upvoted comment for that on this response: https://stackoverflow.com/a/58643186/3625699
## Proposed API
Update documentation
## Usage Examples
## Alternative Designs
None
## Risks
None
Contributor guide
Assessment
This issue has not been assessed yet.