Overview
Forma supports System for Cross-domain Identity Management (SCIM 2.0) as a way to automatically provision and de-provision employees between your business systems and Forma's internal system. SCIM is a good alternative to SFTP processing as it provides immediate response to the status of the provisioning.
Note: SCIM can be used to provision employee demographic data for post-tax benefits only. Employee demographic, election, and contribution data for pre-tax benefits must be provided through an SFTP file integration.
Authentication
API Token
Your Onboarding Manager or Customer Success Manager will provide you with credentials to the Forma Admin where you will be able to generate an API token for authenticating into our SCIM API endpoint.
Endpoint
The production endpoint is at https://api.joinforma.com/external/scim/v2
SSO Providers
Forma has integrated with various SSO providers and currently offers a pre-built SCIM solution on Okta and OneLogin. If you're a customer of either of these SSO providers, turn on provisioning, add the API token, and you should be able to start assigning users to Forma via their UI.
API Document
Forma provides a complete API document that outlines the expected request and response format for various GET, PUT, POST DELETE, PATCH operations related to our SCIM endpoint.
API Access Token
Log in to the Forma Admin Portal and navigate to Settings on the left menu bar and select the Integrations tab at the top of the screen to generate and manage the API access token as needed.
Fields and Namespaces
Standard Fields
By default, Forma supports standard fields such as employee id, first name, last name, email in SCIM 2.0 compliant format. Please refer to our API doc for the request and response format.
Advanced Fields
In addition to the standard fields, Forma also supports advanced fields like department, organization, and other fields used to provide more metadata information about an employee. In SCIM 2.0, these advanced fields should be sent under the
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User namespace.
Custom Fields
Forma also has the ability to support custom fields as your business sees fit. All custom fields should be sent under the urn:ietf:params:scim:schemas:extension:twic:2.0:User namespace