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 Zoho Invoice 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 |
Default Account Attributes
The Zoho Invoice 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 |
|---|---|
| user_id | Unique identifier assigned to the user |
| role_id | Identifier of the role assigned to the user |
| name | Full name of the user associated with the account |
| Email address used by the user to log in and receive notifications | |
| mobile | Mobile phone number of the user, if provided |
| invitation_type | Method used to invite the user to the organization |
| is_super_admin | Indicates whether the user has super administrator privileges |
| user_role | Name of the role assigned to the user |
| status | Current status of the user account |
| is_current_user | Indicates whether the user in the response is the authenticated user making the API request |
| user_type | Type of account associated with the user |
| is_customer_segmented | Indicates whether the user has restricted access to specific customer segments |
| is_vendor_segmented | Indicates whether the user has restricted access to specific vendor segments |
| is_employee | Specifies whether the user is configured as an employee |
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 Zoho Invoice 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 |
|---|---|
| access_type | Defines the overall access scope granted by the role |
| role_type | Indicates the category of the role |
| role_displayname | Display label of the role shown in the UI |
| is_accountant | Indicates whether the role has accountant-specific access |
| is_default | Indicates whether the role is a system-provided default role |
| status_formatted | User-friendly formatted version of the role status |
| is_vendor_segment | Indicates whether the role is restricted to specific vendor segments |
| role_description | Description of the permissions and access provided by the role |
| is_segment | Indicates whether the role is restricted to assigned segments instead of full data access |
| role_name | Internal or canonical name of the role |
| user_action_required | Indicates whether any pending user action is needed for this role |
| role_id | Unique identifier assigned to the role in the organization |
| is_admin_role | Indicates whether the role has administrator-level privileges |
| status | Current status of the role |
| role_type_formatted | User-friendly formatted version of the role type |