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 Workiva 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 Workiva source, the default correlation mapping is:
| Account Attribute | Operation | Identity Attribute |
|---|---|---|
| UserName | Equals | name |
| emails.work.primary.value | Equals | Work Email |
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 Attributes
The Workiva 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 | The unique identifier for the user. |
| userName | The unique identifier for the user is typically used by the user to directly authenticate to Workiva. |
| name.formatted | The full name of the user. |
| name.familyName | The family name of the user. |
| name.givenName | The given name of the user. |
| displayName | The name of the user, suitable for display to end-users. |
| Title | The user's title, such as 'Vice President'. |
| active | A Boolean value indicating the user's administrative status. |
| emails.work.primary.display | A human-readable name, primarily used for display purposes. |
| emails.work.secondary.display | A human-readable name, primarily used for display purposes. |
| emails.work.primary.value | The email address value. |
| emails.work.secondary.value | The email address value. |
| emails.home.primary.display | A human-readable name, primarily used for display purposes. |
| emails.home.secondary.display | A human-readable name, primarily used for display purposes. |
| emails.home.primary.value | Email address value. |
| emails.home.secondary.value | The email address value. |
| emails.other.primary.display | A human-readable name, primarily used for display purposes. |
| emails.other.secondary.display | A human-readable name, primarily used for display purposes. |
| emails.other.primary.value | The email address value. |
| emails.other.secondary.value | The email address value. |
| groups | A list of groups to which the user belongs, either through direct membership, through nested groups, or dynamically calculated. |
| locale | Used to indicate the User's default location for purposes of localizing items such as currency, date time format, numerical representations, etc. |
| nickName | The casual way to address the user in real life. |
| phoneNumbers.work.primary.display | A human-readable name, primarily used for display purposes. |
| phoneNumbers.work.secondary.display | A human-readable name, primarily used for display purposes. |
| phoneNumbers.work.primary.value | Phone number of the user. |
| phoneNumbers.work.secondary.value | Phone number of the user. |
| phoneNumbers.home.primary.display | A human-readable name, primarily used for display purposes. |
| phoneNumbers.home.secondary.display | A human-readable name, primarily used for display purposes. |
| phoneNumbers.home.primary.value | The phone number of the user. |
| phoneNumbers.home.secondary.value | The phone number of the user. |
| phoneNumbers.mobile.primary.display | A human-readable name, primarily used for display purposes. |
| phoneNumbers.mobile.secondary.display | A human-readable name, primarily used for display purposes. |
| phoneNumbers.mobile.primary.value | The phone number of the user. |
| phoneNumbers.mobile.secondary.value | Phone number of the user. |
| preferredLanguage | Indicates the user's preferred written or spoken language. Generally used for selecting a localized user interface. For example, 'en_US' specifies the language English and country US |
| timezone | The user's time zone in the 'Olson' timezone database format; for example, 'America/Los_Angeles'. |
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 Workiva 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 | The unique identifier of the group. |
| displayName | A human-readable name for the group. |
| members | A list of members of the group. |
| location | The URL of group. |
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.