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 Sendbird 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 |
|---|---|
| user_id | Account |
| channel_URL | Group |
Default Account Attributes
The Sendbird 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 |
|---|---|
| is_active | Indicates whether the user account is currently active |
| preferred_languages | List of preferred languages for the user |
| profile_url | URL to the user's profile image or avatar |
| discovery_keys | Keys used for user discovery and search functionality |
| created_at | Timestamp when the user account was created |
| has_ever_logged_in | Indicates whether the user has ever logged into the system |
| user_id | Unique identifier for the Sendbird user |
| nickname | Display name or nickname of the user |
| is_online | Indicates whether the user is currently online |
| last_seen_at | Timestamp when the user was last seen online |
| groups | List of groups in which the user is a member |
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 Sendbird 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 |
|---|---|
| channel_url | Unique identifier for the group |
| name | Specifies the channel topic, or the name of the channel. |
| cover_url | URL or file for the group's image |
| data | Specifies additional channel information such as a long description of the channel or JSON formatted string |
| member_count | Specifies the number of members in the channel |
| joined_member_count | Specifies the number of joined members in the channel |
| max_length_message | Defines the maximum allowed length for a message within a specific group channel |
| created_at | Timestamp when the channel was created |
| custom_type | Specifies the custom channel type which is used for channel grouping |
| user_last_read | Timestamp for the last time a user has read the channel |