SOAP web services account details

To establish a connection to a SOAP web service, you must add an account that defines the account details to connect with. You can define these details by creating a configuration object in the App Connect Dashboard, the Red Hat® OpenShift® web console or CLI, or the Kubernetes CLI.

Account parameters
Examples

Account parameters

You can define one or more accounts for a SOAP web service.

For each account that you require, you can specify a new set of account details in any of the following ways:

If you are using the App Connect Dashboard, either complete the Account details fields in the Create configuration panel, or specify the account parameters in an accounts.yaml file before importing it into the Create configuration panel. For more information, see Accounts type.
If you are using the Red Hat OpenShift web console or CLI, or the Kubernetes CLI, specify the account parameters in an accounts.yaml file, and then use this configuration file to create a configuration object. For more information, see Creating the file for a configuration object of type Accounts.

The set of required and optional Account fields or parameters are listed in the following table.

The values that are required to connect to your SOAP web service are dependent on the security scheme that is configured for the web service, and whether the endpoint is publicly available or private.

If no authentication or override values are required for connecting to or calling the web service, you don't need to specify any connection details, but must specify an account name by using the name parameter, and the API name, which is appended to a soapwsdl. prefix.
If the web service is secured through the Web Services Security (WS-Security) UsernameToken element, use the wssecUsername and wssecPassword parameters to provide a username and password for validation.
If HTTP basic authentication is configured for the web service, use the httpTransportBasicUsername and httpTransportBasicPassword parameters to provide a username and password for validation.
If you want to override the soap:address location host and port in your WSDL file with values that point to a public endpoint, use the endpointUrl parameter to provide an override URL.
If the web service is in a private network, use the endpointUrl and agentId parameters to provide an override URL and the name of a configured private network connection.

Tip: You can also optionally configure settings to allow self-signed certificates or to connect to an endpoint by using an override URL.

Field	Parameter	Values	Condition	Description
API name		User defined	Required	The name that is assigned to the imported web service in App Connect Designer. This name is appended to the soapwsdl keyword with a period (.) separator; for example, `soapwsdl.My APIname`.
Account name	name	User defined	Required	The name of a SOAP web services account that is used in the exported flow.
WS-Security username	wssecUsername	User defined	Optional Use in conjunction with the wssecPassword parameter.	A WS-Security username that is authorized to access the web service. Applicable if the web service is secured through the Web Services Security (WS-Security) `UsernameToken` element.
WS-Security password	wssecPassword	User defined	Optional Use in conjunction with the wssecUsername parameter.	The WS-Security password for the specified WS-Security username.
HTTP basic auth username	httpTransportBasicUsername	User defined	Optional Use in conjunction with the httpTransportBasicPassword parameter.	The name of a user that is authorized to access the web service on an endpoint that is secured by using basic authentication.
HTTP basic auth password	httpTransportBasicPassword	User defined	Optional Use in conjunction with the httpTransportBasicUsername parameter.	The password for the user connecting with basic authentication.
Override the hostname and port of the SOAP address	endpointUrl	User defined	Required if connecting to a private network. Use in conjunction with the agentId parameter.	A URL that includes the protocol, hostname or IP address, and the port number in the format `http://host:port` or `https://host:port`. Use this value to override the host and port of the SOAP address, which are defined by using `soap:address location` in your WSDL file, with values that point to a publicly available or protected endpoint. If you want to override the host and port of the SOAP address with values that point to a publicly available endpoint, specify the override URL in endpointUrl. (Leave the agentId parameter blank.) When you deploy the integration, the host and port in the WSDL SOAP address are overwritten with the specified host and port. This setting enables you to use the same flow to call different endpoints for the web service by setting up multiple accounts with different override URLs. If you want to override the host and port of the WSDL SOAP address with values that point to an endpoint in a private network (for example, behind a firewall in an on-premises location), you need to configure a private network connection that App Connect will use to securely access the endpoint. Both endpointUrl and agentId are required. When you create and run a flow, the host and port in the WSDL SOAP address are overwritten with a generated destination host and port, which enables the SOAP request to be routed to the protected endpoint.
Private network connection	agentId	User defined	Required if connecting to a private network. Use in conjunction with the endpointUrl parameter.	The name of a private network connection that App Connect uses to connect to your private network. You create private network connections in the Private network connections page. (You see this field only if a switch server is configured for this Dashboard instance.) For information about creating and configuring private network connections, see Connecting to a private network from the App Connect Dashboard. (In App Connect Dashboard 12.0.10.0-r1 or earlier instances that include this field, the display name is shown as Agent name.)

Examples

Remember: An accounts.yaml file that defines one or more accounts must always begin with the following line:
accounts:

Example 1 (Connecting to an un-authenticated web service named BooksAPI):

  soapwsdl.BooksAPI:
    - name: Account 1
      credentials: {}
      endpoint: {}

Example 2 (Connecting to a web service named Petstore with WS-Security credentials):

  soapwsdl.Petstore:
    - name: Account 1
      credentials:
        wssecUsername: janebloggs
        wssecPassword: mypassw0rd
      endpoint: {}

Example 3 (Connecting with basic authentication):

  soapwsdl.Petstore:
    - name: Account 1
      credentials:
        httpTransportBasicUsername: janedoe
        httpTransportBasicPassword: myPassw0rd
      endpoint: {}

Example 4 (Connecting to a publicly available web service by specifying basic authentication and an override URL):

  soapwsdl.Petstore:
    - name: Account 1
      credentials:
        httpTransportBasicUsername: johnbloggs
        httpTransportBasicPassword: myPassw0rD
      endpoint:
        endpointUrl: 'https://publicwebservice.example.com:1234'

Example 5 (Connecting to a web service in a private network with WS-Security credentials):

  soapwsdl.Petstore:
    - name: Account 1
      credentials:
        wssecUsername: WSjohnbloggs
        wssecPassword: WSjohnbloggs
        agentId: pnc-mon-06-nov-2023-22-13-44-gmt-453
      endpoint:
        endpointUrl: 'https://myhost.com:1234'