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 Imprivata VPAM 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 Imprivata VPAM SaaS source, the default correlation mapping is:
| Account Attribute | Operation | Identity Attribute |
|---|---|---|
| userId | Equals | Username |
| Equals | Work Email |
You can modify the correlation configuration in accordance with your requirements.
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 |
|---|---|
| objectid | Account |
| objectid | Group |
| id | userGroup |
| id | role |
| id | applicationGroups |
| id | credentialCategory |
Default Account Attributes
The Imprivata VPAM SaaS 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 ID of the User/ Vendor Rep. This is the Account ID which should not get changed. |
| name | The full name of the User/ Vendor Rep |
| dateLastLogin | The last login date of the User/ Vendor Rep |
| dateLastActive | The last active date of the User/ Vendor Rep |
| adminUser | If true, the User is an administrator. Type: Boolean |
| userType | The type of the User |
| statusText | A text representation of the status of the User/ Vendor Rep |
| totalLoginCount | The total number of times the User/ Vendor Rep has logged in. Type: Integer |
| department | The name of the Department associated with the User/ Vendor Rep |
| noAutoDisable | If true, the User will not be disabled automatically. Type: Boolean |
| approvalRequestIds | The IDs of the Approval Requests associated with the User/ Vendor Rep |
| userId | The User ID for login |
| The email of the User/ Vendor Rep | |
| departmentId | The ID of the Department that the User belongs to. Type: Integer |
| phone | The phone number of the User/ Vendor Rep |
| altPhone | The alternative phone number of the User/ Vendor Rep |
| status | The status of the User/ Vendor Rep. Values: 0 = active, 1 = disabled, 2 = unregistered. Type: Integer |
| authProvider | Authentication provider to use for the User |
| active | If true, the Vendor Rep has been registered. Type: Boolean |
| disabled | If true, this Vendor Rep is disabled. Type: Boolean |
| dateAccessExpires | The date when access for the Vendor Rep expires. |
| vendorId | The ID of the Vendor associated with the Vendor Rep Type: Integer |
| userGroups | The User Groups that the User belongs to. Type: userGroup, Entitlement, Multivalued |
| roleIds | The IDs of the Roles assigned to the User. Type: role, Entitlement, Multivalued |
| applicationGroupIds | A list of Application Group IDs assigned to the Vendor Rep. Required when the chosen Vendor has Application Groups enabled. Type: applicationGroups, Entitlement, Multivalued |
| credentialCategoryId | The ID of the Credential Category associated with the User/ Vendor Rep. Type: credentialCategory, Entitlement |
Note
The vendorId is a unique identifier assigned to each Vendor in the Imprivata VPAM system. You will need this Vendor ID when creating a new Vendor Rep associated with that specific Vendor. For more information, refer to Steps to find Vendor ID from the managed Imprivata VPAM system.
Custom Attributes
The Imprivata VPAM SaaS connector supports custom fields, allowing you to extend the default user attributes.
Note
Provisioning of custom attribute is supported for vendor representatives only.
To utilize custom fields, follow these steps:
- Create the custom field on the Imprivata VPAM managed portal:
- Go to System Admin > Settings > User Fields.
- Click on New.
- Add a Label for the custom field and select the appropriate Type.
- Select Save.
-
Add the created custom field to the SailPoint Account Schema:
-
In the SailPoint Account Schema, add a new field with the prefix
customFieldsfollowed by the custom field name.For example, if the created custom field name is
officeLocation, then in the schema, it should be defined ascustomFields.officeLocation.This helps SailPoint recognize and include the custom field during the aggregation process.
-
After adding the custom field to the account schema, you can also include it in the Create Account template for provisioning.
This ensures that the custom field is populated with the appropriate value when creating new user accounts in Imprivata VPAM source.
-
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 User Group Attributes
The Imprivata VPAM SaaS connector also supports groups. The following attributes must be configured on the managed system and in the SailPoint source schema to manage groups.
Object Type: userGroup
| Attribute Name | Description |
|---|---|
| id | The unique identifier of the User Group. This is an Entitlement ID. |
| name | The name of the User Group. |
| description | The description of the User Group |
| userCount | The number of Users associated with this User Group. Type: Integer |
| gkGroupCount | The number of Gatekeeper Groups associated with this User Group. Type: Integer |
| isSeamless | If true, this Gatekeeper Group is Seamless. Type: Boolean |
| groupType | The type of the User Group |
| applicationIds | The list of Application IDs associated with the User Group. Type: String, Multi-Valued |
| adminUserIds | The list of User IDs that are User Group administrators associated with the User Group. Type: String, Multi-Valued |
Default Role Attributes
The Imprivata VPAM SaaS connector supports roles. The following attributes must be configured on the managed system and in the SailPoint source schema to manage roles.
Object Type: role
| Attribute Name | Description |
|---|---|
| id | The unique ID for the role. This is an Entitlement ID. |
| name | The name of the role. |
| description | The description of the role. |
| roleBindIds | An array of role bind IDs with this role assigned. |
Application Groups Attributes
Object Type: applicationGroups
The following lists the application groups attributes:
| Attribute Name | Description |
|---|---|
| id | The unique ID of the application group. This is an Entitlement ID. |
| name | The name of the application group. |
| vendorId | The ID of the vendor that owns the application group. Type: Integer |
| appCount | The number of applications that the application group contains. Type: Integer |
| vrepCount | The number of vendor reps that the application group contains. Type: Integer |
Credential Category Attributes
Object Type: credentialCategory
The following lists the credential category attributes:
| Attribute Name | Description |
|---|---|
| id | The unique ID of the credential category. This is an Entitlement ID. |
| name | The name of the credential category. |
| description | The description of the credential category. |
Default Machine Identity Attributes
Machine Identity attributes define the multiple types of machine identities that can be assigned to the managed system's user accounts.
For more information, refer to Machine Identity Security Overview.
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.