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 1.1 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 | Account |
| id | Group |
Default Account Attributes
The SCIM 1.1 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 | A unique identifier for a SCIM resource. This is an Account ID which must not be changed. |
| userName | Name of the user |
| externalId | A String that is an identifier for the resource |
| displayName | The name of the user |
| nickName | The casual way to address the user in real life |
| profileUrl | A fully qualified URL to a page representing the user's Online profile |
| title | The user's title, such as Vice President |
| userType | Used to identify the organization to user relationship. Values can be: - Contractor - Employee - Intern - Temp - External - Unknown |
| preferredLanguage | Indicates the user's preferred written or spoken language |
| locale | Used to indicate the user's default location for purposes of localizing items such as currency, date time format, numerical representations, etc. |
| timezone | The user's time zone in the Olson timezone database format |
| formattedName | The full name, including all middle names, titles, and suffixes as appropriate, formatted for display |
| familyName | The family name of the user, or last name in most Western languages |
| givenName | The given name of the user, or first name in most Western languages |
| middleName | The middle name(s) of the user |
| honorificPrefix | The honorific prefix(es) of the user, or Title in most Western languages. For example, Ms. given the full name Ms. Barbara Jane Jensen, III |
| honorificSuffix | The honorific suffix(es) of the user, or Suffix in most Western languages. For example, III given the full name Ms. Barbara Jane Jensen, III |
| employeeNumber | Numeric or alphanumeric identifier assigned to a person, typically based on order of hire or association with an organization |
| costCenter | Identifies the name of a cost center |
| organization | Identifies the name of an organization |
| division | Identifies the name of a division |
| department | Identifies the name of a department |
| managerId | The ID of the SCIM resource representing the user's manager |
| managerName | Name of the manager |
| emails | Email addresses for the user. The value must be canonicalized by the Service Provider. For example, bjensen@example.com instead of bjensen@EXAMPLE.COM |
| emails.home.primary.value | Primary home email address for the user |
| emails.home.secondary.value | Secondary home email addresses for the user |
| emails.work.primary.value | Primary work email address for the user |
| emails.work.secondary.value | Secondary work email addresses for the user |
| emails.other.primary.value | Primary other email address for the user |
| emails.other.secondary.value | Secondary other email addresses for the user |
| emails_objects | A list of all of the user's email addresses, including their type (for example, home, work) and whether it is their primary address |
| emails_primary | The user's primary email address |
| phoneNumbers | Phone numbers for the user. The value must be Canonicalized by the Service Provider |
| phoneNumbers.home.primary.value | Primary home phone number for the user |
| phoneNumbers.home.secondary.value | Secondary home phone numbers for the user |
| phoneNumbers.work.primary.value | Primary work phone number for the user |
| phoneNumbers.work.secondary.value | Secondary work phone numbers for the user |
| phoneNumbers.mobile.primary.value | Primary mobile phone number for the user |
| phoneNumbers.mobile.secondary.value | Secondary mobile phone numbers for the user |
| phoneNumbers.other.primary.value | Primary other phone number for the user |
| phoneNumbers.other.secondary.value | Secondary other phone numbers for the user |
| phoneNumbers.fax.primary.value | Primary fax number for the user |
| phoneNumbers.fax.secondary.value | Secondary fax numbers for the user |
| phoneNumbers.pager.primary.value | Primary pager number for the user |
| phoneNumbers.pager.secondary.value | Secondary pager numbers for the user |
| phoneNumbers_objects | A list of all of the user's phone numbers, including their type (for example, home, work) and whether it is their primary phone number |
| phoneNumbers_primary | The user's primary phone number |
| ims | Instant messaging address for the user |
| ims.aim.value | AIM instant messaging address for the user |
| ims.gtalk.value | Gtalk instant messaging address for the user |
| ims.icq.value | ICQ instant messaging address for the user |
| ims.xmpp.value | XMPP instant messaging address for the user |
| ims.msn.value | MSN instant messaging address for the user |
| ims.skype.value | Skype instant messaging address for the user |
| ims.qq.value | QQ instant messaging address for the user |
| ims.yahoo.value | Yahoo instant messaging address for the user |
| ims_objects | A list of all of the instant messaging usernames, including their type (for example, aim, gtalk) and whether it is their primary messaging username |
| ims_primary | The user's primary instant messaging username |
| photos | URL of a photo of the user |
| photos.photo.value | URL of a photo of the user |
| photos.thumbnail.value | URL of a thumbnail photo of the user |
| photos_objects | A list of URLs of all of the user's photos, including the photo type (for example, photo, thumbnail) and whether it is their primary photo |
| photos_primary | The URL of the user's primary photo |
| addresses | A physical mailing address for this user |
| addresses.home.formatted | Formatted home address for this user |
| addresses.home.streetAddress | Home Street address for this user |
| addresses.home.locality | Home address locality address for this user |
| addresses.home.region | Home address region for this user |
| addresses.home.postalCode | Home address postal code for this user |
| addresses.home.country | Home address country for this user |
| addresses.work.formatted | Formatted work address for this user |
| addresses.work.streetAddress | Work Street address for this user |
| addresses.work.locality | Work address locality address for this user |
| addresses.work.region | Work address region for this user |
| addresses.work.postalCode | Work address postal code for this user |
| addresses.work.country | Work address country for this user |
| addresses.other.formatted | Formatted other address for this user |
| addresses.other.streetAddress | Other Street address for this user |
| addresses.other.locality | Other address locality address for this user |
| addresses.other.region | Other address region for this user |
| addresses.other.postalCode | Other address postal code for this user |
| addresses.other.country | Other address country for this user |
| addresses_objects | A list of all of the user's physical mailing addresses, including their type (home or work) and whether it is their primary address |
| addresses_primary | The user's primary physical mailing address |
| groups | A list of groups that the user belongs to, either thorough direct membership, nested groups, or dynamically calculated |
| groups_objects | A list of all of the user's group memberships, including how they are assigned to the group. For example: - direct - If assigned directly - indirect - If assigned indirectly through another group and whether it is their primary group |
| groups_primary | The user's primary group membership |
| entitlements | A list of entitlements for the user that represent a thing the user has |
| entitlements.primary.value | Primary entitlement for the user that represent a thing the user has |
| entitlements.secondary.value | A list of secondary entitlements for the user that represent a thing the user has |
| entitlements.primary.display | Primary entitlement for the user that represent a thing the user has |
| entitlements.secondary.display | A list of secondary entitlements for the user that represent a thing the user has |
| entitlements_objects | A list of all of the user's entitlements, including whether it is their primary entitlement |
| entitlements_primary | The user's primary entitlement |
| roles | A list of roles for the user that collectively represent who the user is. For example, Student, Faculty |
| roles.primary.value | User's primary role |
| roles.secondary.value | User's secondary roles |
| roles_objects | A list of all of the user's roles, including whether it is their primary role |
| roles_primary | The user's primary role |
| created | The date and time the Resource was added to the Service Provider |
| lastModified | The most recent date and time the details of this Resource were updated at the Service Provider |
| location | The URL of the Resource being returned. This value MUST be the same as the Location HTTP response header |
| version | The version of the Resource being returned |
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 SCIM 1.1 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 | A unique identifier for a SCIM resource |
| externalId | A String that is an identifier for the resource |
| displayName | The name for the group |
| members | A list of members in the group |
| memberGroups | A list of the group's sub-groups |
| created | The DateTime the resource was added to the Service Provider |
| lastModified | The most recent DateTime the details of this resource were updated at the Service Provider |
| location | The URI of the resource being returned. This value MUST be the same as the Location HTTP response header |
| version | The version of the resource being returned |
Complex Schema Attributes
When Enable Complex Attribute Support is selected on Aggregation Settings, the following complex, multi-valued attributes are available:
| Attribute Name | Description |
|---|---|
| emails.home.primary.value | Primary home email address for the user |
| emails.home.secondary.value | Secondary home email addresses for the user |
| emails.work.primary.value | Primary work email address for the user |
| emails.work.secondary.value | Secondary work email addresses for the user |
| emails.other.primary.value | Primary other email address for the user |
| emails.other.secondary.value | Secondary other email addresses for the user |
| phoneNumbers.home.primary.value | Primary home phone number for the user |
| phoneNumbers.home.secondary.value | Secondary home phone numbers for the user |
| phoneNumbers.work.primary.value | Primary work phone number for the user |
| phoneNumbers.work.secondary.value | Secondary work phone numbers for the user |
| phoneNumbers.mobile.primary.value | Primary mobile phone number for the user |
| phoneNumbers.mobile.secondary.value | Secondary mobile phone numbers for the user |
| phoneNumbers.other.primary.value | Primary other phone number for the user |
| phoneNumbers.other.secondary.value | Secondary other phone numbers for the user |
| phoneNumbers.fax.primary.value | Primary fax number for the user |
| phoneNumbers.fax.secondary.value | Secondary fax numbers for the user |
| phoneNumbers.pager.primary.value | Primary pager number for the user |
| phoneNumbers.pager.secondary.value | Secondary pager numbers for the user |
| ims.aim.value | AIM instant messaging address for the user |
| ims.gtalk.value | Gtalk instant messaging address for the user |
| ims.icq.value | ICQ instant messaging address for the user |
| ims.xmpp.value | XMPP instant messaging address for the user |
| ims.msn.value | MSN instant messaging address for the user |
| ims.skype.value | Skype instant messaging address for the user |
| ims.qq.value | QQ instant messaging address for the user |
| ims.yahoo.value | Yahoo instant messaging address for the user |
| photos.photo.value | URL of a photo of the user |
| photos.thumbnail.value | URL of a thumbnail photo of the user |
| addresses.home.formatted | Formatted home address for this user |
| addresses.home.streetAddress | Home Street address for this user |
| addresses.home.locality | Home address locality address for this user |
| addresses.home.region | Home address region for this user |
| addresses.home.postalCode | Home address postal code for this user |
| addresses.home.country | Home address country for this user |
| addresses.work.formatted | Formatted work address for this user |
| addresses.work.streetAddress | Work Street address for this user |
| addresses.work.locality | Work address locality address for this user |
| addresses.work.region | Work address region for this user |
| addresses.work.postalCode | Work address postal code for this user |
| addresses.work.country | Work address country for this user |
| addresses.other.formatted | Formatted other address for this user |
| addresses.other.streetAddress | Other Street address for this user |
| addresses.other.locality | Other address locality address for this user |
| addresses.other.region | Other address region for this user |
| addresses.other.postalCode | Other address postal code for this user |
| addresses.other.country | Other address country for this user |
| roles.primary.value | User's primary role |
| roles.secondary.value | User's secondary roles |
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.