Schema Reference
The application schema is used to configure the objects returned from a connector.
Note
-
The Account Schema tab is used to define the attributes for each object type in the application being configured. The schema attributes can be defined as Entitlement or Multi-Valued. Refer to Managing Source Account Schemas for more information.
-
The schema attributes that are not present by default must be defined as strings if not specified.
The xMatters connector uses the following default correlation and object configurations.
Default Account Schema
Each source supports a variety of details, or attributes, about each user who has an account, such as their name, email address, manager name, and location.
The set of account attributes each source stores and how they're organized is known as the account's schema. To best represent your data, you can configure sources to use an account schema matching the one you use in the external connector. Refer to Managing Source Account Schemas for more information.
Default Account ID
SailPoint requires that certain attributes remain in your configuration. These attributes are referred to as account IDs.
Caution
Changing the attribute marked as the account ID after aggregating accounts can result in duplicate accounts being created. To avoid this, either reset the accounts on this source before editing the account ID attribute or edit the account ID attribute before aggregating accounts.
To resolve issues caused by changing account IDs, reconfigure them to their default values.
The following table lists the default account IDs for this connector:
| Account ID | Schema Object Type |
|---|---|
| id | Account |
Default Account Attributes
The xMatters connector supports the following default account schema attributes and customer configurable attributes. The attributes must be defined as strings if not specified.
| Attribute Name | Description |
|---|---|
| id | Unique identifier (UUID) of the user in xMatters. Used to reference the user via the REST API. |
| targetName | The user’s login or target name used for targeting notifications/message recipients. |
| firstName | User's first name as stored in xMatters. |
| lastName | User's last name. |
| webLogin | Login username for the xMatters UI (may match targetName). |
| language | Preferred language setting of the user in xMatters. |
| timezone | Time zone assigned to the user account. |
| site_id | UUID of the site (physical or logical location) associated with the user. |
| site_name | Human-readable name of the user’s site. |
| licenseType | Specifies the user’s access level or billing tier within xMatters (for example,Full Access, REST-only, etc.) |
| recipientType | Type of entity used for notifications (for example, individual, group, or role recipient). |
| role_id | Multi-valued list of Role UUIDs assigned to the user. Requires “REST Web Service User” permission or Group Supervisor to read. |
| group_id | the user belongs to (for example, On‑call, Broadcast, Dynamic, etc.) |
Default Entitlement Attributes
Entitlement attributes define the entitlements, such as groups or roles, that can be assigned to the managed system's user accounts. Refer to Managing Entitlements for more information.
Caution
Changing the attribute marked as the Entitlement ID after aggregating accounts or entitlements can result in duplicate entitlements being created, or access profiles and roles breaking. To avoid this, edit the entitlement schema before performing any aggregations.
Default Group Attributes
The xMatters connector also supports groups. The following attributes must be configured on the managed system and in the SailPoint source schema to manage groups.
| Attribute Name | Description |
|---|---|
| id | Unique identifier (UUID) of the group in xMatters. |
| targetName | Display name of the group as shown in UI/notification recipient lists. |
| description | Optional user-provided description of the group's purpose or function. |
| externallyOwned | Indicates if the group is managed externally (for example,via SCIM sync or LDAP rather than manually). |
| allowDuplicates | When true, users may appear within the group's notification rotation more than once. Affects on-call grouping behavior. |
| useDefaultDevices | If true, xMatters falls back to the user's default notification devices when explicit device times are not set. |
| observedByAll | When true, all roles can view the group; otherwise visibility is restricted. |
| groupType | Type of group (for example, On‑Call, Broadcast, Dynamic Group, etc., as defined in xMatters UI/API). |
Default Role Attributes
The xMatters connector supports roles. The following attributes must be configured on the managed system and in the SailPoint source schema to manage roles.
| Attribute Name | Description |
|---|---|
| id | UUID of the xMatters role. |
| name | Display name of the role (for example: Group Supervisor, REST Web Service User, Full Access). |
| description | Summary of the role’s capabilities and permissions within xMatters. |