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 Spike 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 Spike 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 ID of the user.
First Name First name of the user.
Last Name Last name of the user.
Email Email address of the user. Used for account correlation.
Role Incident management role: admin, manager, responder, or viewer.
Teams Teams this user belongs to. Aggregated as Team entitlements.
Mobile App Whether this user uses the Spike mobile app.
Email Confirmed Whether this user has confirmed their email address.
Phone Confirmed Whether this user has confirmed their phone number.
Timezone Timezone of the user.
Removed Whether this user has been removed from the organization. Removed members remain in account aggregation.
On Vacation Whether this user is currently on vacation.
Incident Management Whether incident management is enabled for this user.
Status Page Whether status pages are enabled for this user.
Background Color Background color used for this user in the dashboard.
Text Color Text color used for this user in the dashboard.
Organization ID of the organization this user belongs to.
Date Format Date format preference of the user.
Theme Theme preference of the user.
Access Role ID of the incident management (IM) role assigned to this user.
Status Page Role ID of the status page role. Values are admin, manager, or viewer.

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 Teams Attributes

The Spike 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 ID of the team.
Name Name of the team.
Description Description of the team.
UID Short slug of the team, used in dashboard URLs.
Private Whether this team is private.
Default Team Whether this is the default team.
Users Users who belong to this team.
Removed Users Users who have been removed from this team.
Organization ID of the organization this team belongs to.
Created By Who created this team.
Created At When this team was created.
Updated At When this team was last updated.
Last Incident Counter Counter of the last incident created for this team.