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 Slack SaaS connector uses the following default correlation and object configurations.
Default Correlation Configuration
Before you aggregate accounts from this source, you can map account attributes with their corresponding identity attributes based on your requirements.
You can customize the correlation configuration. Refer to Assigning Source Accounts to Identities for more information.
When you first create the Slack SaaS source, the default correlation mapping is:
| Account Attribute | Operation | Identity Attribute |
|---|---|---|
| username | Equals | SailPoint User Name (uid) |
| emails.work.primary.value | Equals | Work Email (email) |
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 |
| id | Group |
| id | channel |
| id | workspace |
Default Account Attributes
The Slack SaaS 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 | A unique identifier for a Slack resource. |
| userName | Name of the user. |
| externalId | A String that is an identifier for the resource. |
| displayName | The name of the user. |
| nickName | The casual way to address the user in real life. |
| profileUrl | A fully qualified URL to a page representing the users online profile. |
| title | The users title. |
| userType | Used to identify the organization to user relationship. |
| preferredLanguage | Indicates the users preferred written or spoken language. |
| locale | Used to indicate the users default location for purposes of localizing items. |
| timezone | The users time zone in the Olson timezone database format. |
| familyName | The last name of the user. |
| givenName | The first name of the user. |
| honorificPrefix | The honorific prefix(es) of the user. |
| employeeNumber | Numeric or alphanumeric identifier assigned to a person. |
| costCenter | Identifies the name of a cost center. |
| organization | Identifies the name of an organization. |
| division | Identifies the name of a division. |
| department | Identifies the name of a department. |
| managerID | The id of the Slack resource representing the users manager. |
| emails | Email addresses for the user. |
| emails.work.primary.value | Primary work email address for the user. |
| emails.work.secondary.value | Secondary work email addresses for the user. |
| phoneNumbers | Phone numbers for the user. |
| phoneNumbers.work.primary.value | Primary work phone number for the user. |
| phoneNumbers.mobile.value | Mobile number for the user. |
| photos | URL of a photo of the user. |
| photo.photo.value | URL of a photo of the user. |
| addresses | A physical mailing address for the user. |
| addresses.home.streetAddress | Home Street address for the user. |
| addresses.home.locality | Home address locality for the user. |
| addresses.home.region | Home address region for the user. |
| addresses.home.postalCode | Home address postal code for the user. |
| addresses.home.country | Home address country for the user. |
| groups | A list of groups that the user belongs to. |
| roles | A list of roles for the user that collectively represent who the user is. |
| created | The date and time details of the account when it was added to Slack. |
| startDate | The date the user started. This attribute is optional. The value uses ISO 8601 format. For example, 2000-05-06T00:00:00+0000. |
| location | The URL of the user being returned. |
| channels | Channels assigned to the user. |
| workspaces | Workspaces assigned to the user. |
| is_ultra_restricted | The value of this attribute should be true if the user is a single channel guest user. The default value is "false" (Boolean). |
| is_restricted | The value of this attribute should be true if the user is multi-channel guest user. The default value is "false" (Boolean). |
Note
The channels attribute increases the aggregation execution time.
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 Slack SaaS connector also supports groups. The following attributes must be configured on the managed system and in the SailPoint source schema to manage groups.
Entitlement Type: group
Object Type: group
| Attribute Name | Description |
|---|---|
| id | A unique identifier for the group. |
| displayName | The name of the group. |
| created | The date and time details of the group when it was added to Slack. |
| location | The URL of the group being returned. |
Entitlement Type: channel
Object Type: channel
| Attribute Name | Description |
|---|---|
| id | ID of the Slack channel. |
| name | The name of the Slack channel. |
| created | The timestamp when the channel is created. |
| creator | The User ID of the member who created the channel. |
| num_Members | The number of members in the channel. |
| channel_type | The type of the Slack channel. |
| teamId | The team ID associated with the Slack channel. |
Entitlement Type: workspace
Object Type: workspace
| Attribute Name | Description |
|---|---|
| id | A unique identifier for the Workspace. |
| name | The Workspaces name. |
| primary_owner | The user ID for the Workspaces owner. |
| team_url | The Workspaces URL. |
Documentation Feedback
Feedback is provided as an informational resource only and does not form part of SailPoint’s official product documentation. SailPoint does not warrant or make any guarantees about the feedback (including without limitation as to its accuracy, relevance, or reliability). All feedback is subject to the terms set forth at https://developer.sailpoint.com/discuss/tos.