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 Memberful 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 | Member |
Default Account Attributes
The Memberful 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 member |
| Email address of the member | |
| fullName | Full name of the member |
| phoneNumber | Phone number of the member |
| totalOrders | Total number of orders placed by the member |
| totalSpendCents | Total amount spent by the member in cents |
| username | Username of the member |
| unrestrictedAccess | Indicates whether the member has unrestricted access |
| stripeCustomerId | Stripe customer ID associated with the member |
| customField | Custom field value defined |
| subscriptions_id | subscription IDs associated with the 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 Memberful 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 for the subscription |
| active | Indicates whether the subscription is currently active |
| activatedAt | Timestamp when subscription was activated |
| createdAt | Timestamp when subscription was created |
| expiresAt | Timestamp when subscription will expire |
| trialStartAt | Timestamp when trial started |
| trialEndAt | Timestamp when trial ends |
| autorenew | Indicates whether subscription renews automatically |
| pastDue | Indicates whether subscription is past due |
| additionalMembers | Number of additional members included |
| plan_id | Identifier of the associated plan |
| plan_name | Name of the associated plan |
| plan_priceCents | Price of the plan in cents |