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 AppDirect 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 |
|---|---|
| uuid | Account |
Default Account Attributes
The AppDirect 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 |
|---|---|
| uuid | Unique user ID, used as the account native identity attribute |
| userName | Marketplace login name (often same as email), used as the account display attribute |
| Primary email; used for invites and correlation | |
| firstName | User's given name |
| lastName | User's family name |
| allowLogin | Whether this user can sign in |
| activated | Whether the user has activated their account or invite |
| roles | Membership roles for this user in the configured company (multi-valued), aggregated as a Role entitlement |
Account Correlation
Accounts are correlated to identities by matching the identity email attribute to the account email attribute.
| Identity Attribute | Operation | Account Attribute |
|---|---|---|
| EQ |
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 connector's entitlementSchemas is empty. Roles are modeled as multi-valued account entitlements on the roles attribute (not a separate Group schema). Membership roles are aggregated from the top-level roles array on the user-company membership response (not from user.roles).
| API role value | AppDirect UI name | Description |
|---|---|---|
| ROLE_USER | User | Base end-user access, present on every user; cannot be removed. |
| ROLE_SYS_ADMIN | Company Admin | Administers users, purchases, and company settings for that company |
| ROLE_BILLING_ADMIN | Billing Admin | Manages billing and payment-related access for the company |
| ROLE_DEVELOPER | Developer | Manages product and developer functions for the company |
| ROLE_CHANNEL_ADMIN | Marketplace Manager | Manages marketplace-wide users, companies, and products |
| ROLE_CHANNEL_SUPPORT | Customer Support | Support access across marketplace companies and users |
| ROLE_CHANNEL_PRODUCT_SUPPORT | Product Support | Supports product integration and catalog-related tasks |
| ROLE_SALES_SUPPORT | Sales Support | Creates companies and can purchase on behalf of users |
| ROLE_RESELLER | Reseller | Reseller access for selling and managing reseller activity |
| ROLE_RESELLER_MANAGER | Reseller Manager | Manages reseller teams, companies, and sales opportunities |