Skip to content

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 ServiceM8 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
uuid Account

Default Account Attributes

The ServiceM8 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
uuid Unique identifier for the user account
email User's email address
first User's first name
last User's family (last) name
mobile User's mobile phone number
active Indicates whether the user account is currently active or inactive
geo_timestamp Timestamp of geolocation for the user account
job_title User's job title within the organization
labour_material_uuid Unique identifier that links the user to a labour/material record
security_role_uuid Unique identifier that links the user to the assigned security role

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.

Attribute Name Description
security_role_uuid Unique identifier that links the user to the assigned security role
name Display name of the role (for example, Default Business Owner Role)
edit_date Timestamp of when this role was last modified
active Indicates whether the role is currently active or inactive
role_description A brief description of what permissions/access this role grants