About User Provisioning
As an integrations client with Interfolio, you can manage user access and provisioning through our API. This article outlines how to create and update users, as well as subscribe them to our products. To get started, you’ll need an API profile with keys and user provisioning permissions, provided by Interfolio.
User provisioning via the API ensures that each user is:
- Fully set up with an account linked to the institution's tenant: Each user account is created with a PID (Interfolio's unique user identifier) and associated with the institution's tenant through an association record.
- Assigned roles for one or more products: Access to a product is granted via a permissions record within the product application, which references the user's PID. User access can be revoked by removing the permissions record, deactivating the user's tenant association, or removing the tenant association entirely.
Clients using the API for bulk user creation will need to update to the V2 Bulk Users Endpoint to support UID and User Type.
UID is available for opt-in today in all of our products. For clients using the unique identifier (UID) feature, Interfolio now provides a dedicated data field to store a permanent, consistent identifier for each user in the Interfolio Faculty Information System (FIS). This field is designed to capture the unique identifier your institution already uses to track employees, rather than relying on email addresses or Interfolio-generated IDs.
Check out this article Overview of Interfolio's Testing Environments for more information on Interfolio's environment architecture. For testing purposes, the best practice is to create a small group (<5) of fake profiles with dummy data and fake email addresses. A user's core profile contains their name, address, phone number, and email address. Any changes to user profiles in a development tenant will be reflected in that user's profile in any other tenant to which they're related (e.g., production or another institution) and vice versa.
Provision Users via the API
- Create the underlying account with the required attributes (first name, last name, and email address) and the feature-dependent attributes (UID, SSO ID). Some products require additional attributes (such as FacultyID in FAR).
- Assign the new user(s) one of our products and assign permissions for that product.
Check out this articles on how to set up permissions in Review, Promotion & Tenure (RPT) and Faculty Search (FS) via the API