Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -35,20 +35,24 @@ A web service call is simply a HTTP call that the Runtime receives and recognize

#### Authentication

Every web service call requires authentication. Specifically, the SOAP envelope header should contain an **Authentication** element, which contains a user name and password:
The authentication method depends on the **Authentication** setting of the [published web service](/refguide/published-web-service/#authentication):

```xml
<soap:Header>
<tns:authentication>
<username>john</username>
<password>john'ssecretpassword</password>
</tns:authentication>
</soap:Header>
```
* With **No authentication**, the call does not need credentials.
* With **Username and password**, the SOAP envelope header should contain an **Authentication** element, which contains a user name and password:

These details must match an existing web service user in the Runtime. These users can be created by signing in as an Administrator and clicking **Create web service user** in the **Users** data grid in the system module. Normal (non-web service) users cannot be used to call web services and web service users cannot sign in via the standard login page.
```xml
<soap:Header>
<tns:authentication>
<username>john</username>
<password>john'ssecretpassword</password>
</tns:authentication>
</soap:Header>
```

Otherwise, there is no difference between how normal users and web service users call microflows.
These details must match an existing web service user in the Runtime. These users can be created by signing in as an Administrator and clicking **Create web service user** in the **Users** data grid in the system module. Normal (non-web service) users cannot be used to call web services and web service users cannot sign in via the standard login page.

Otherwise, there is no difference between how normal users and web service users call microflows.
* With **Custom authentication**, an import mapping converts the first element of the SOAP envelope header into an object. This object is passed to a microflow that you define, which returns the user. For more information, see [Custom Authentication](/refguide/published-web-service/#authentication-custom).

#### Parameter Handling

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,59 @@ Default: **Yes**

### Authentication

The authentication settings to define for communicating with the web service.
The authentication settings to define for communicating with the web service. Studio Pro offers the following options:

* **No authentication** – clients do not need to provide credentials to call the web service
* **Username and password** – clients authenticate with a web service user
* **Custom authentication** – a microflow that you define authenticates clients using information from the SOAP header

#### Username and Password {#authentication-username-password}

With this option, the SOAP header of each request must contain an **authentication** element with a **username** and a **password** element, as shown in [Published Web Services](/refguide/published-web-services/#authentication). The credentials must belong to a web service user. For more information, see [Authentication and Users](/refguide/integration/expose-a-web-service/#authentication-and-users).

If the header is missing, or if it does not contain a user name or a password, the call fails with a SOAP fault.

#### Custom Authentication {#authentication-custom}

With this option, the SOAP header of each request is processed in the following way:

1. The first element of the SOAP header is converted into an object by the import mapping that you select.
2. This object is passed to the authentication microflow that you select as its only parameter.
3. The microflow returns the user that the operation is executed as.

The call fails with a SOAP fault if one of the following situations occurs:

* The request does not contain a SOAP header.
* The header cannot be converted by the import mapping.
* The microflow does not return a user.
* The user that is returned is not active or is blocked.

The following settings are available:

| Setting | Description |
| --- | --- |
| **Schema import wizard** | Opens the **Schema import wizard** dialog box, which creates the XML schema and the import mapping for the header. For more information, see [Schema Import Wizard](#schema-import-wizard). |
| **Import mapping** | The [import mapping](/refguide/import-mappings/) that converts the header element into an object. Select an import mapping that you created with the wizard or created yourself. |
| **If no object was found** | The action to perform when the import mapping cannot obtain a Mendix object, for example when a database lookup finds no match. This setting is only shown when the selected import mapping has **Decide this at the place where the mapping gets used** selected. For more information, see [If No Object Was Found](/refguide/import-mappings/#if-no-object-was-found). |
| **Microflow** | The authentication microflow. It must have a single parameter of the entity type that the import mapping creates, and it must return a `System.User` object. |

##### Schema Import Wizard {#schema-import-wizard}

In the **Schema import wizard** dialog box, you first select a **Source** for the header schema:

* **Predefined** – use a schema that is included with Studio Pro. Select a **Header schema**, and then select which **Selected parameters** to include in the import mapping:
* **WS Security Username Token** – a WS-Security header with a username token
* **WS Security 2002-04 with Kerberos v5 Token Profile** – a WS-Security header that can also contain a binary security token

Each predefined schema offers these parameter sets:

* **Custom element selection...** – you select the elements to include yourself
* **Username and Password** – the `Security`, `UsernameToken`, `Username`, and `Password` elements
* **Username and BinarySecurityToken** – the `Security`, `Username`, and `BinarySecurityToken` elements and the `Id`, `ValueType`, and `EncodingType` attributes of `BinarySecurityToken`; only available for the Kerberos schema
* **Schema document** – use an XML schema document that is already in your app. Click **Select...** to choose it.
* **File** – use an XSD file from your local machine. Click **Select...** to choose it.

When you confirm the dialog box, Studio Pro imports the schema and creates an import mapping for the elements you selected.

### Target Namespace

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,20 +35,24 @@ A web service call is simply a HTTP call that the Runtime receives and recognize

#### Authentication

Every web service call requires authentication. Specifically, the SOAP envelope header should contain an **Authentication** element, which contains a user name and password:
The authentication method depends on the **Authentication** setting of the [published web service](/refguide10/published-web-service/#authentication):

```xml
<soap:Header>
<tns:authentication>
<username>john</username>
<password>john'ssecretpassword</password>
</tns:authentication>
</soap:Header>
```
* With **No authentication**, the call does not need credentials.
* With **Username and password**, the SOAP envelope header should contain an **Authentication** element, which contains a user name and password:

These details must match an existing web service user in the Runtime. These users can be created by signing in as an Administrator and clicking **Create web service user** in the **Users** data grid in the system module. Normal (non-web service) users cannot be used to call web services and web service users cannot sign in via the standard login page.
```xml
<soap:Header>
<tns:authentication>
<username>john</username>
<password>john'ssecretpassword</password>
</tns:authentication>
</soap:Header>
```

Otherwise, there is no difference between how normal users and web service users call microflows.
These details must match an existing web service user in the Runtime. These users can be created by signing in as an Administrator and clicking **Create web service user** in the **Users** data grid in the system module. Normal (non-web service) users cannot be used to call web services and web service users cannot sign in via the standard login page.

Otherwise, there is no difference between how normal users and web service users call microflows.
* With **Custom authentication**, an import mapping converts the first element of the SOAP envelope header into an object. This object is passed to a microflow that you define, which returns the user. For more information, see [Custom Authentication](/refguide10/published-web-service/#authentication-custom).

#### Parameter Handling

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,59 @@ Default: **Yes**

### Authentication

The authentication settings to define for communicating with the web service.
The authentication settings to define for communicating with the web service. Studio Pro offers the following options:

* **No authentication** – clients do not need to provide credentials to call the web service
* **Username and password** – clients authenticate with a web service user
* **Custom authentication** – a microflow that you define authenticates clients using information from the SOAP header

#### Username and Password {#authentication-username-password}

With this option, the SOAP header of each request must contain an **authentication** element with a **username** and a **password** element, as shown in [Published Web Services](/refguide10/published-web-services/#authentication). The credentials must belong to a web service user. For more information, see [Authentication and Users](/refguide10/integration/expose-a-web-service/#authentication-and-users).

If the header is missing, or if it does not contain a user name or a password, the call fails with a SOAP fault.

#### Custom Authentication {#authentication-custom}

With this option, the SOAP header of each request is processed in the following way:

1. The first element of the SOAP header is converted into an object by the import mapping that you select.
2. This object is passed to the authentication microflow that you select as its only parameter.
3. The microflow returns the user that the operation is executed as.

The call fails with a SOAP fault if one of the following situations occurs:

* The request does not contain a SOAP header.
* The header cannot be converted by the import mapping.
* The microflow does not return a user.
* The user that is returned is not active or is blocked.

The following settings are available:

| Setting | Description |
| --- | --- |
| **Schema import wizard** | Opens the **Schema import wizard** dialog box, which creates the XML schema and the import mapping for the header. For more information, see [Schema Import Wizard](#schema-import-wizard). |
| **Import mapping** | The [import mapping](/refguide10/import-mappings/) that converts the header element into an object. Select an import mapping that you created with the wizard or created yourself. |
| **If no object was found** | The action to perform when the import mapping cannot obtain a Mendix object, for example when a database lookup finds no match. This setting is only shown when the selected import mapping has **Decide this at the place where the mapping gets used** selected. For more information, see [If No Object Was Found](/refguide10/import-mappings/#if-no-object-was-found). |
| **Microflow** | The authentication microflow. It must have a single parameter of the entity type that the import mapping creates, and it must return a `System.User` object. |

##### Schema Import Wizard {#schema-import-wizard}

In the **Schema import wizard** dialog box, you first select a **Source** for the header schema:

* **Predefined** – use a schema that is included with Studio Pro. Select a **Header schema**, and then select which **Selected parameters** to include in the import mapping:
* **WS Security Username Token** – a WS-Security header with a username token
* **WS Security 2002-04 with Kerberos v5 Token Profile** – a WS-Security header that can also contain a binary security token

Each predefined schema offers these parameter sets:

* **Custom element selection...** – you select the elements to include yourself
* **Username and Password** – the `Security`, `UsernameToken`, `Username`, and `Password` elements
* **Username and BinarySecurityToken** – the `Security`, `Username`, and `BinarySecurityToken` elements and the `Id`, `ValueType`, and `EncodingType` attributes of `BinarySecurityToken`; only available for the Kerberos schema
* **Schema document** – use an XML schema document that is already in your app. Click **Select...** to choose it.
* **File** – use an XSD file from your local machine. Click **Select...** to choose it.

When you confirm the dialog box, Studio Pro imports the schema and creates an import mapping for the elements you selected.

### Target Namespace

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,20 +35,24 @@ A webservice call is simply a HTTP call that the runtime receives and recognizes

#### Authentication

Every webservice call requires authentication. Specifically, the SOAP envelope header should contain an element called "authentication", which contains a username and password:
The authentication method depends on the **Authentication** setting of the [published web service](/refguide9/published-web-service/#authentication):

```xml
<soap:Header>
<tns:authentication>
<username>john</username>
<password>john'ssecretpassword</password>
</tns:authentication>
</soap:Header>
```
* With **No authentication**, the call does not need credentials.
* With **Username and password**, the SOAP envelope header should contain an **Authentication** element, which contains a user name and password:

These details *must* match an existing webservice user in the runtime. These users can be created by signing in as an Administrator and clicking on "create webservice user" in the Users datagrid in the system module. Normal (non-webservice) users cannot be used to call webservices and webservice users cannot sign in via the standard login page.
```xml
<soap:Header>
<tns:authentication>
<username>john</username>
<password>john'ssecretpassword</password>
</tns:authentication>
</soap:Header>
```

Other than that, there is no difference between how normal users and web service users call microflows.
These details must match an existing web service user in the Runtime. These users can be created by signing in as an Administrator and clicking **Create web service user** in the **Users** data grid in the system module. Normal (non-web service) users cannot be used to call web services and web service users cannot sign in via the standard login page.

Otherwise, there is no difference between how normal users and web service users call microflows.
* With **Custom authentication**, an import mapping converts the first element of the SOAP envelope header into an object. This object is passed to a microflow that you define, which returns the user. For more information, see [Custom Authentication](/refguide9/published-web-service/#authentication-custom).

#### Parameter Handling

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,59 @@ Default: *Yes*

### Authentication

The authentication settings to define for communicating with the web service.
The authentication settings to define for communicating with the web service. Studio Pro offers the following options:

* **No authentication** – clients do not need to provide credentials to call the web service
* **Username and password** – clients authenticate with a web service user
* **Custom authentication** – a microflow that you define authenticates clients using information from the SOAP header

#### Username and Password {#authentication-username-password}

With this option, the SOAP header of each request must contain an **authentication** element with a **username** and a **password** element, as shown in [Published Web Services](/refguide9/published-web-services/#authentication). The credentials must belong to a web service user. For more information, see [Authentication and Users](/refguide9/integration/expose-a-web-service/#authentication-and-users).

If the header is missing, or if it does not contain a user name or a password, the call fails with a SOAP fault.

#### Custom Authentication {#authentication-custom}

With this option, the SOAP header of each request is processed in the following way:

1. The first element of the SOAP header is converted into an object by the import mapping that you select.
2. This object is passed to the authentication microflow that you select as its only parameter.
3. The microflow returns the user that the operation is executed as.

The call fails with a SOAP fault if one of the following situations occurs:

* The request does not contain a SOAP header.
* The header cannot be converted by the import mapping.
* The microflow does not return a user.
* The user that is returned is not active or is blocked.

The following settings are available:

| Setting | Description |
| --- | --- |
| **Schema import wizard** | Opens the **Schema import wizard** dialog box, which creates the XML schema and the import mapping for the header. For more information, see [Schema Import Wizard](#schema-import-wizard). |
| **Import mapping** | The [import mapping](/refguide9/import-mappings/) that converts the header element into an object. Select an import mapping that you created with the wizard or created yourself. |
| **If no object was found** | The action to perform when the import mapping cannot obtain a Mendix object, for example when a database lookup finds no match. This setting is only shown when the selected import mapping has **Decide this at the place where the mapping gets used** selected. For more information, see [If No Object Was Found](/refguide9/import-mappings/#if-no-object-was-found). |
| **Microflow** | The authentication microflow. It must have a single parameter of the entity type that the import mapping creates, and it must return a `System.User` object. |

##### Schema Import Wizard {#schema-import-wizard}

In the **Schema import wizard** dialog box, you first select a **Source** for the header schema:

* **Predefined** – use a schema that is included with Studio Pro. Select a **Header schema**, and then select which **Selected parameters** to include in the import mapping:
* **WS Security Username Token** – a WS-Security header with a username token
* **WS Security 2002-04 with Kerberos v5 Token Profile** – a WS-Security header that can also contain a binary security token

Each predefined schema offers these parameter sets:

* **Custom element selection...** – you select the elements to include yourself
* **Username and Password** – the `Security`, `UsernameToken`, `Username`, and `Password` elements
* **Username and BinarySecurityToken** – the `Security`, `Username`, and `BinarySecurityToken` elements and the `Id`, `ValueType`, and `EncodingType` attributes of `BinarySecurityToken`; only available for the Kerberos schema
* **Schema document** – use an XML schema document that is already in your app. Click **Select...** to choose it.
* **File** – use an XSD file from your local machine. Click **Select...** to choose it.

When you confirm the dialog box, Studio Pro imports the schema and creates an import mapping for the elements you selected.

### Target Namespace

Expand Down
Loading