Configuring connections to IMS with Docker Desktop and Basic Authentication

Connect to IMS with Basic Authentication.

Before you begin

Make sure that the following prerequisite tasks are complete:
  1. Prepare the sample IMS application
  2. Downloading the IMS API project sample
  3. Downloading the z/OS Connect Designer image
  4. Creating the IMS tutorial workspace with Docker Desktop

About this task

This topic is applicable to: Content applicable to
application developers Content applicable to
security administrators

In this task, you create the IMS.xml file. This file uses the environmental variables that are defined in the docker-compose.yaml file as inputs for the IPIC connection when you start your container at run time.

With this configuration, the z/OS Connect Designer can use basic authentication to authenticate with IMS. It is assumed that the target IMS region is configured to expect basic authentication credentials. That is, USERAUTH(VERIFY) is specified on the IMS IPCONN resource.

Tip: This tutorial demonstrates Basic Authentication. For other security configuration, see Configuring security for IMS connections.
You provide your user ID and password, then z/OS Connect Designer passes your credentials to IMS for authentication.
Figure 1. Passing only user credentials to IMS
Passing only user credentials to IMS


  1. In your text editor, create a file with the following content.
    <zosconnect_imsConnection id="imsConn"
        <connectionFactory id="imsConnectionFactory" containerAuthDataRef="IMSCredentials">
            <properties.gmoa hostName="${IMS_HOST}" portNumber="${IMS_PORT}" />
        <authData id="IMSCredentials" user="${IMS_USER}" password="${IMS_PASSWORD}" />
  2. Save the file as ims.xml in the directory ZCWorkspace/PhonebookApi/src/main/liberty/config.
  3. Verify that the new files and directories are listed correctly.
    The following screen image shows the resulting project structure:
    |-- /certs
    |-- /logs
    |-- /PhonebookApi/src/main/liberty/config/ims.xml
    |-- docker-compose.yaml

What to do next

Start the z/OS Connect Designer and import an OpenAPI definition. See the task Starting the z/OS Connect Designer with Docker Desktop and importing an OpenAPI definition.