Manage web service users

The use of SOAP web services has been deprecated in favor of the xMatters REST API. These web service users were used to access xMatters via SOAP web services and are not needed for REST API requests.

SOAP web service operation requests must specify a valid web service user. All web service user management is performed on the users tab in the xMatters web user interface. Web service users are different from other users in xMattters in that they cannot be assigned to a role, they cannot log in to the web user interface, and they cannot have devices or receive notifications. They are only able to authenticate SOAP web service requests, such as those used by the EPIC data sync feature.

Web service users data access

Web service users do not have limits to the data they can access that is usually enforced by roles and permissions (such as a Group Supervisor). All data is returned as though the request was made by an administrator.

Adding and modifying web service users

Company administrators and users with the Web Service supervisor role can manage web service users. When adding or modifying a web service user, you can specify which web services the user is allowed to use.

Instances with a Web Services license have a default web service user account with the following credentials:

  • User ID: IA_User
  • Password: ia_complex
  • Allowed Web Services: Submit APXML, Receive APXML, Register Integration Agent

It is recommended that you immediately change the password for this user, or disable the account once you have added the web service users for your company.

  1. Log in to the xMatters web user interface.
  2. In the Users menu, under Web Service Users, click Add Web Service User.
  3. Specify a User ID, Description (optional), and Password.
    1. If you are creating a user for an Integration Agent and you want the Integration Agent to be able to interact with all of the companies in your deployment, select the Service Provider Access check box. For more information about Integration Agent web services users, see The Integration Agent. This check box is not visible to tenant company administrators, or on single company deployments.
  4. In the Denied Web Services list, select the web services the user should be allowed to access, and then click Add.
    • If you are creating a web services user that will be used by an Integration Agent, you must select the Receive APXML, Register Integration Agent, and Submit APXML web services.
    • To deny access to a web service, select it in the Allowed Web Services list, and then click Remove.
  5. Click Save.
  1. Log in to the xMatters web user interface.
  2. In the Users menu, under Web Service Users, click Find Web Service Users.
  3. Use the search page to find the web service user you want to modify or delete.
  4. In the Results table, do one of the following:
    • To modify details for an existing web service user, click the associated link in the User ID column, specify the new details, and then click Save.
    • To delete a web services user, select the associated check box and click Remove Selected.