Managing Web Service Users
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 services access
Web service users can access only data specific to their
Company; otherwise their data visibility does not have limits that
may be enforced by other Roles, such as Group Supervisor. All data is returned as though
the request was made by an Administrator with visibility to all the data.
Multiple-Company deployments have an exception to the above rule when a User in the host Company (the "Default Company") is allowed to access web services on behalf of tenant Companies in the deployment. This feature is controlled by the Service Provider Access check box on the Web Service Users details page in the xMatters web user interface. This check box is visible to host-Company Users only.
Adding and modifying Web Service Users
Company Administrators and Users with the Web Service Supervisor
Role have the ability to administer web service users. When
adding or modifying a web service user, you can specify which web services
the User is allowed to use.
When you add a Web Services license to a new or existing xMatters installation, a default web service user account is created 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 change the password for this User, or disable
the account, once you have added the web service users for your Company.
To add a Web Service User:
- Specify a User
ID, Description (optional),
and Password.
- If you are creating a User in the host Company of a multiple-Company deployment, and want the Web Service User to be able to access web services on behalf of all tenant Companies, select the Service Provider Access check box.
- This check box is not visible to tenant Company Administrators, or on single Company deployments.
- In the Denied Web Services list, select the web services the User should be allowed
to access (Ctrl+click or Shift+click to select multiple web services),
and then click Add.
- If you are creating a web service user to connect to the xMatters Scripts, ensure that you enable access to the following web services: Check In Scripts, Check Out Scripts, Delete Scripts, and List Scripts. Also, note that this Web Service User MUST belong to the default Company; Users from Companies other than the default cannot access the Developer IDE via web services.
- To deny access to a web service, select it
in the Allowed Web Services list,
and then click Remove.
- Click Save.
To modify or delete a Web Service User:
- Click the Users
tab, and then click Find Web Service
Users.
- Use the search page to find the web service user
you want to modify or delete.
- 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.