Create the MID Server user and grant the role

Create the MID Server user ID and grant this user the role it needs to communicate with the instance.

Before you begin

Role required: admin

About this task

The MID Server connects to an instance by using the SOAP web service. To allow authentication with the instance, create a separate user account for each MID Server or share the same account across multiple MID Servers. Grant each MID Server user the mid_server role, which is required for the MID Server user on any instance on which basic authentication is enabled. The mid_server role allows the MID Server to access protected tables when strict SOAP security is in place. The system adds the necessary SOAP roles automatically with this role.
Note: The strict SOAP security feature, enabled by default for any instance that uses basic authentication, protects all tables with Access Control Lists (ACL).

Procedure

  1. From the instance, navigate to User Administration > Users.
  2. Click New.
  3. Complete the fields in the form.
    Field Description
    User ID The same user ID that will be specified in the mid.instance.username parameter of config.xml. If you use special characters, such as an ampersand (&), you must encode the special character using character references in the config.xml file.
    First name The user's first name.
    Last name The user's last name.
    Password The same password that will be specified in the mid.instance.password parameter of config.xml. If you use special characters, such as an ampersand (&), you must encode the special character using character references in the config.xml file.
  4. To configure your MID Server to use special characters in the user name or password, such as passw&rd:
    1. Open the config.xml file and find these lines:
      <parameter name="mid.instance.username" value="mid_user"/>

      <parameter encrypt="false" name="mid.instance.password" value="passw&rd"/>

    2. Make the following change:
      <parameter encrypt="false" name="mid.instance.password" value="passw&amp;rd"/>
    3. Save the file.
      Note: For examples of the character references required for well-formed XML, see Character Entity References.
  5. Right-click the header and select Save.
  6. Under the Roles related list, click Edit.
  7. Select the mid_server role for this user.
    Each MID Server account must have this role to access protected tables.
    Important: The mid_server and security_admin roles are incompatible and cannot be assigned to the same user. For information on how the instance checks role assignments, see MID Server role validation
  8. Click Save.
  9. To see if the Logged in user is the same as the user in the configuration file, look in the MID Server dashboard or view the list view of MID Servers.
    The icon in the Logged in user column indicates the following:
    • Red: Incompatible. The user does not have the mid_server role or the user does not match the value in the mid.instance.username parameter (in the config.xml configuration file). Reconfigure the MID Server user and verify that it has the proper user and role.
    • Green: Compatible. The user has the mid_server role and matches the user in the configuration file.
  10. Confirm that the MID Server account was created successfully and the account has connectivity to the instance.
    1. On the MID Server host, Open a supported web browser on the MID Server host and navigate to the instance.
    2. If the account is already logged into the instance, log out.
    3. Right-click the header and select Save.
    4. Use the previously created MID Server user credentials and sign in. If the user name or password includes special characters, make sure that you edit the config.xml file to allow for well-formed XML.