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 SCIM 2.0 SaaS connector uses the following default correlation and object configurations.
Default Correlation Configuration
Before you aggregate accounts from this source, you can map account attributes with their corresponding identity attributes based on your requirements.
You can customize the correlation configuration. Refer to Assigning Source Accounts to Identities for more information.
When you first create the SCIM 2.0 SaaS source, the default correlation mapping is:
| Account Attribute | Operation | Identity Attribute |
|---|---|---|
| emails.work.primary | Equals | Work Email (email) |
| userName | Equals | SailPoint User Name (uid) |
| displayName | Equals | displayname |
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 | Account |
| id | Group |
Default Account Attributes
The SCIM 2.0 SaaS connector supports the following default account schema attributes and customer configurable attributes. The attributes must be defined as strings if not specified.
The SCIM 2.0 SaaS source provides the default Account Schema for illustrative purposes. You can discover the schema from SCIM 2.0 compliant systems using the Discover Schema feature.
| Attribute Name | Description |
|---|---|
| active | The user's active status. |
| costCenter | Cost center associated with the user. |
| department | The user's department. |
| displayName | The user's public-facing name. |
| division | The user's division. |
| emails.home.primary | The user's primary home email address. |
| emails.home.secondary | The user's secondary home email address. |
| emails.other.primary | The user's alternate email address. |
| emails.other.secondary | The user's secondary email address. |
| emails.work.primary | The user's primary work email address. |
| emails.work.secondary | The user's secondary work email address. |
| employeeNumber | The user's employee identifier. |
| groups | Groups assigned to the user. |
| id | The user's unique ID. |
| locale | The user's default location. |
| manager.displayName | The user's manager's display name. |
| manager.value | The user's manager's SCIM resource ID. |
| meta.location | The user's location. |
| meta.resourceType | The user's resource type. |
| name.familyName | The user's last name. |
| name.formatted | The user's full name. |
| name.givenName | The user's first name. |
| name.middleName | The user's middle name. |
| nickName | The user's friendly name. |
| organization | The user's organization. |
| phoneNumbers.home.primary | The user's primary home phone number. |
| phoneNumbers.home.secondary | The user's secondary home phone number. |
| phoneNumbers.mobile.primary | The user's primary mobile number. |
| phoneNumbers.mobile.secondary | The user's secondary mobile number. |
| phoneNumbers.work.primary | The user's primary work phone number. |
| phoneNumbers.work.secondary | The user's secondary work phone number. |
| preferredLanguage | The user's preferred language. |
| profileUrl | The user's online profile URL. |
| timezone | The user's Olson time zone format. |
| title | The user's title, such as "Vice President". |
| userName | The user's unique name. |
| userType | The user's classification type within the organization. |
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.
| Attribute Name | Description |
|---|---|
| displayName | The name of the group, suitable for display. |
| id | Unique identifier for the resource as defined by the SCIM service provider. |
| members | The count of user membership. |
| meta.created | Created date time. |
| meta.lastModified | Last modified date time. |
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.