Capabilities
| Resource | Sync | Provision |
|---|---|---|
| Users | ||
| Groups |
Gather xMatters credentials
In xMatters, create or choose a user account for the connector and make
sure it has the REST Web Service User role.
To authenticate with an xMatters API key instead of a password, open the
user’s profile, create an API key, and copy both the key ID and the key
secret. The key ID is entered as the user name prefixed with
x-api-key- (for example x-api-key-2249a8e8-...), and the key secret
is entered as the password.Copy your xMatters API base URL: the host you see in your browser when
signed in to xMatters, followed by
/api/xm/1 — for example
https://yourcompany.xmatters.com/api/xm/1. Some instances include a
deployment segment in the hostname, such as
https://yourcompany.cs1.xmatters.com/api/xm/1; copy the host exactly
as it appears.Configuration fields
| Field | Required | Description |
|---|---|---|
base-url | Yes | Full base URL of the xMatters REST API, with no trailing slash, for example https://yourcompany.xmatters.com/api/xm/1. |
username | Yes | The xMatters user name to authenticate as. To use an API key, enter the key ID prefixed with x-api-key-. |
password | Yes | The password for the user name above. When using an API key, this is the key’s secret. |
Synced resource types
- Users: people from
/people, including their active or inactive status. - Groups: groups from
/groups, with one member entitlement per group. - Group memberships: person members of each group from
/groups/{id}/members. Nested groups and device members are listed by xMatters but are not synced as access grants.
Special notes
- Provisioning is not supported in the current build.
- The connector is read-only and never modifies xMatters data.
- Device contact information is not synced; xMatters keeps contact details on device records, which are out of scope for this connector.
- Membership of nested groups is not expanded: a group inside another group is skipped rather than resolved to its individual members.
Configure the xMatters connector
- Cloud-hosted
- Self-hosted
Follow these instructions to use a built-in, no-code connector hosted by C1.Done. Your xMatters connector is now pulling access data into C1.
Enter the xMatters credentials:
- xMatters API base URL: The full API base URL, for example
https://yourcompany.xmatters.com/api/xm/1. - Username: The connector account’s user name, or an API key ID
prefixed with
x-api-key-. - Password: The account’s password, or the API key’s secret.