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 Teamwork 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 | Description |
|---|---|---|
| id | Account | Unique identifier for a Teamwork user |
| id | Group | Unique identifier for a company (group) in Teamwork |
| id | Role | Unique identifier for a job role in Teamwork |
Default Account Attributes
The Teamwork 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 of the user account |
| firstName | User’s first name |
| lastName | User’s last name |
| title | User’s job title (if available) |
| Email address of the user | |
| companyId | ID of the company the user belongs to |
| companyRoleId | Role ID assigned within the company |
| isAdmin | Boolean indicating if the user has admin privileges |
| isClientUser | Indicates if the account is a client user |
| isServiceAccount | Indicates if the account is a service account |
| type | Object type (always account for users) |
| deleted | Indicates if the account is deleted |
| avatarUrl | URL of the user’s profile avatar |
| lengthOfDay | Standard workday length in hours |
| workingHoursId | ID referencing assigned working hours |
| canAccessPortfolio | Indicates if user can access portfolios |
| canAddProjects | Indicates if user can create projects |
| canManagePortfolio | Indicates if user can manage portfolios |
| jobRoles | List of role IDs assigned to the user |
| isPlaceholderResource | Boolean indicating if user is a placeholder resource |
| timezone | Timezone of the user |
| lastLogin | Timestamp of the last login |
| createdAt | Account creation timestamp |
| updatedAt | Last updated timestamp |
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 Teamwork 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 of the company (group) |
| name | Company name |
| logoUrl | Company logo URL |
| createdAt | Timestamp when the company was created |
| updatedAt | Timestamp when the company was last updated |
| addressOne | Address line one |
| addressTwo | Address line two |
| city | City |
| state | State |
| zip | ZIP code |
| countryCode | Country code |
| emailOne | Primary company email |
| emailTwo | Secondary company email |
| emailThree | Additional company email |
| website | Company website URL |
| phone | Company phone number |
| fax | Company fax number |
| canSeePrivate | Boolean indicating if the company can see private items |
| isOwner | Indicates if the company is the owner |
| companyNameUrl | URL-friendly company identifier |
| accounts | Number of associated accounts |
| collaborators | Number of collaborators |
| contacts | Number of contacts |
| clients | Number of clients |
| status | Company status (e.g., active) |
| currency | Currency object associated with the company |
Default Role Attributes
The Teamwork 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 | Unique identifier of the role |
| name | Name of the role |
| description | Role description |
| createdAt | Timestamp when the role was created |
| updatedAt | Timestamp when the role was last updated |