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 Freshchat 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 | Agent |
Default Account Attributes
The Freshchat 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 Freshchat agent |
| first_name | First name of the agent |
| last_name | Last name of the agent |
| Primary email address of the agent. Unique within the account. | |
| role_name | Display name of the role assigned to the agent |
| is_deactivated | Whether the agent account has been deactivated |
| is_deleted | Whether the agent account has been deleted |
| locale | Locale setting of the agent (for example, en-us) |
| agent_status | Current status name of the agent (for example, Inactive on Intelli Assign) |
| routing_type | Routing type assigned to the agent (for example, DISABLED) |
| agent_capacity | Maximum concurrent conversation capacity of the agent |
| round_robin_access | Whether the agent is included in round-robin routing |
| freshchat_access | Whether the agent has access to Freshchat |
| login_status | Current login status of the agent |
| role_id | Identifier of the Freshchat role assigned to the agent (managed entitlement) |
| groups | Identifiers of Freshchat groups the agent belongs to (managed entitlement) |
| created_time | Timestamp when the agent account was created (ISO 8601 UTC) |
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 Freshchat 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 Freshchat group |
| name | Display name of the group |
| routing_type | Routing type for the group (for example, DISABLED, SKILL_BASED, ROUND_ROBIN) |
| routing_logic | Routing logic applied to the group (for example, DISABLED, OMNIROUTE) |
| chat_group_id | Internal chat group identifier associated with this group |
Default Role Attributes
The Freshchat 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 Freshchat role |
| name | Display name of the role |
| description | Description of the role |
| is_custom_role | Whether this is a custom role (true) or a built-in system role (false) |