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.

Sign up for GitHub

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

[IN-6784] Updated docs for List [HttpHeader] auth. microflow params #8651

Draft
wants to merge 4 commits into
base: development
Choose a base branch
from
Draft

[IN-6784] Updated docs for List [HttpHeader] auth. microflow params #8651

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
360381e
Updated docs for List [HttpHeader] auth. microflow params
adeel2023 Nov 14, 2024
28f08ba
Revise and move changes to refguide10
quinntracy Nov 14, 2024
42bfa54
Merge branch 'development' into auth-microflow-should-accept-headers-…
quinntracy Nov 14, 2024
0d3803a
Revise via feedback
quinntracy Nov 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions ...refguide/modeling/integration/odata-services/published-odata-services/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,11 +197,15 @@ xmlHttp.send(null);

##### Custom {#authentication-microflow}

Specify which microflow to use for custom authentication.
{{% alert color="info" %}}
Support for using a list of `System.HttpHeader` in authentication microflows was introduced in [Studio Pro 10.18.0](/releasenotes/studio-pro/10.18/).
{{% /alert %}}

The microflow may take an [HttpRequest](/refguide/http-request-and-response-entities/#http-request) as a parameter, so it can inspect the incoming request.
Specify which microflow to use for custom authentication. The microflow may take the following as a parameter:

The microflow may also take an [HttpResponse](/refguide/http-request-and-response-entities/#http-response) as a parameter. When the microflow sets the status code of this response to something other then **200**, this value is returned and the operation will not be executed. Any headers set on the response are returned (except when the microflow returns an empty user).
* A list of [HttpHeader](/refguide/http-request-and-response-entities/#http-header). This cannot be used in combination with [HttpRequest](/refguide/http-request-and-response-entities/#http-request) parameter.
* [HttpResponse](/refguide/http-request-and-response-entities/#http-response). When the microflow sets the status code of this response to something other then **200**, this value is returned and the operation will not be executed. Any headers set on the response are returned (except when the microflow returns an empty user).
* [HttpRequest](/refguide/http-request-and-response-entities/#http-request), so it can inspect the incoming request.

The authentication microflow should return a User.

Expand Down
9 changes: 9 additions & 0 deletions ...fguide/modeling/integration/rest-services/http-request-and-response-entities.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,15 @@ You can retrieve or create response headers via the `HttpHeaders` association.

An important `HttpResponse` header is `Content-Type`, which indicates how the content should be interpreted. For more information on this header, see the [W3C specification of Content-Type](https://www.w3.org/Protocols/rfc1341/4_Content-Type.html).

## HttpHeader {#http-header}

The `HttpHeader` entity has the following attributes:

| Attribute | Type | Default Value | Description |
| --- | --- | --- | --- |
| `Key` | String | empty | Header key. |
| `Value` | String | empty | Header value. |

### Why Does Setting `ReasonPhrase` Have No Effect? {#reason-phrase}

The HTTP/1.x protocol allowed servers to include a reason phrase in the response, including non-standard ones. In HTTP/2, reason phrases have been removed. Many web servers (including the one Mendix Runtime uses), do not allow setting anything other than the default reason phrase for the status code (even in HTTP/1.x, which technically allows it).
Expand Down