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 Shortcut 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 | Member |
Default Account Attributes
The Shortcut 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 | Member’s unique UUID |
| profile | Nested object with personal information |
| role | User’s role within the organization |
| entity_type | Resource type string |
| disabled | Whether the user is disabled in the org |
| state | Status: full, partial, disabled, or imported |
| updated_at | Timestamp when the member was last updated |
| created_without_invite | Whether the user was created without inviting |
| group_ids | IDs of groups the member belongs to |
| deactivated | Whether the user is deactivated |
| two_factor_auth_activated | Whether 2FA is enabled |
| mention_name | Username used for mentions |
| name | User’s full name |
| gravatar_hash | Avatar hash for Gravitar |
| display_icon | User avatar/icon |
| is_owner | Whether the member is an organizational owner |
| email_address | Member’s registered email |
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 Shortcut 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 | UUID uniquely identifying this group |
| name | Human-readable name of the group |
| app_url | The URL to view this group in the Shortcut web app |
| description | A textual description for the group |
| archived | Boolean indicating if the group is archived |
| entity_type | Indicates the type of object returned |
| color | A CSS color value associated with the group |
| num_stories_started | Number of stories in the "started" state within this group |
| mention_name | The handle used to mention this team in Shortcut |
| global_id | A globally unique identifier for the group, used across APIs |
| color_key | An alternate color identifier or key used by the UI; may be null |
| num_stories | Total number of stories assigned to this group |
| num_epics_started | Number of epics assigned to this team that are in the "started" state |
| updated_at | Timestamp indicating when the group was last updated |
| num_stories_backlog | Number of stories assigned to this group that are in backlog/unstarted |
| display_icon | Display icon/avatar for the group |
| default_workflow_id | The workflow ID that is the default for new stories created in this group |