Add error message in JSON response #54389
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When the SAML authentication is not successful, we return a SAML Respnonse with a status that indicates a failure. This commit adds an error message in the REST API response along with the SAML Response XML string so that the caller of the API can identify that this is an unsuccessful response without needing to parse the XML.
|
Pinging @elastic/es-security (:Security/Security) |
|
@elasticmachine update branch |
tvernum
approved these changes
Mar 31, 2020
| @@ -65,6 +65,7 @@ public RestResponse buildResponse(SamlInitiateSingleSignOnResponse response, XCo | |||
| builder.startObject(); | |||
| builder.field("post_url", response.getPostUrl()); | |||
| builder.field("saml_response", response.getSamlResponse()); | |||
| builder.field("error", response.getError()); | |||
There was a problem hiding this comment.
Is the contract that if error is null then it's a success and if it's non-null then there's a failure?
There was a problem hiding this comment.
yes. I contemplated adding a boolean isSuccess field but felt like this extra check wouldn't make much sense on the consumer side but I don't feel strongly about it if you think it makes this clearer/easier to consume.
There was a problem hiding this comment.
It feels a little weird, but I can't think of anything better, unless we add the saml status as well.
There was a problem hiding this comment.
I ended up doing just that after all
… into return-error-init
|
ping @tvernum in case you want to take another look since I also cleaned up the SamlAuthenticationState and added a field to the response as we talked about |
tvernum
approved these changes
Apr 1, 2020
jkakavas
added a commit
to jkakavas/elasticsearch
that referenced
this pull request
Apr 1, 2020
When the SAML authentication is not successful, we return a SAML Response with a status that indicates a failure. This commit adds an error message in the REST API response along with the SAML Response XML string so that the caller of the API can identify that this is an unsuccessful response without needing to parse the XML.
|
backport to 7.7 depends on #54553 being merged |
jkakavas
added a commit
that referenced
this pull request
Apr 1, 2020
When the SAML authentication is not successful, we return a SAML Response with a status that indicates a failure. This commit adds an error message in the REST API response along with the SAML Response XML string so that the caller of the API can identify that this is an unsuccessful response without needing to parse the XML.
jkakavas
added a commit
to jkakavas/elasticsearch
that referenced
this pull request
Apr 2, 2020
When the SAML authentication is not successful, we return a SAML Response with a status that indicates a failure. This commit adds an error message in the REST API response along with the SAML Response XML string so that the caller of the API can identify that this is an unsuccessful response without needing to parse the XML.
jkakavas
added a commit
that referenced
this pull request
Apr 2, 2020
When the SAML authentication is not successful, we return a SAML Response with a status that indicates a failure. This commit adds an error message in the REST API response along with the SAML Response XML string so that the caller of the API can identify that this is an unsuccessful response without needing to parse the XML.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When the SAML authentication is not successful, we return a SAML
Response with a status that indicates a failure. This commit adds
an error message in the REST API response along with the SAML
Response XML string so that the caller of the API can identify
that this is an unsuccessful response without needing to parse the
XML.