Skip to content

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 JDBC SaaS 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.

The JDBC SaaS connector has no default account attributes. The connector's most important attribute is the SQL Statement. In many cases this is a stored procedure (call mystoredProcedure). In other cases it is selected from a table with any number of joins included. If this connector is configured to use the automatic discovery function, it connects to the database and executes the statement provided and then uses the meta-data returned from the result to build the column names.

Important

SQL entries can't end with a semicolon (;). Ending an SQL entry with a semicolon (;) can cause a general error message to display.

Enter the Account SQL query in the source connection before you discover the schema. Refer to Account Query Settings for more information.

Define the attributes to use for the account schema's Account Name and Account ID.

Caution

If this source is going to be used as an authoritative source for an identity profile, the Account Name and Account ID both need to be unique. If not, source accounts could correlate to the first Identity that includes that ID/Name instead of creating an additional Identity.

Refer to Discovering an Account Schema and Editing an Account Schema for more information.

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.

The JDBC SaaS connector has no default entitlement attributes. To aggregate entitlements, you must manually add and configure an entitlement schema for each entitlement type in the JDBC SaaS source. Refer to Creating and Managing Entitlement Types for more information.

The JDBC SaaS connector supports multiple group objects for entitlement aggregation. Depending on the managed system that you are connecting with the JDBC SaaS source, you can set up attributes such as entitlements and roles. You can add one or more entitlement schemas for aggregation.

Entitlement schemas you add appear in Query Settings, where you configure the connection and SQL queries for each. Refer to Query Settings for more information.

Note

Once you enter an entitlement type's name, you can't change it later.

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.