Give users access to Pipefy with a Bookmark Application connector. Automatically provision, update and deprovision users and groups in Pipefy from ºÚÁϺ£½Ç91Èë¿Ú using the Identity Management (SCIM) integration. Leverage this integration to centralize user lifecycle, user identity, and group management in ºÚÁϺ£½Ç91Èë¿Ú for Pipefy. Save time and avoid mistakes, as well as potential security risks, related to manually creating users.
Read this article to learn how to setup the Pipefy integration.
Prerequisites
- A ºÚÁϺ£½Ç91Èë¿Ú administrator account.
- ºÚÁϺ£½Ç91Èë¿Ú SSO Package or higher or SSO add-on feature.
- A Super Administrator account in Pipefy.
- Your Pipefy organization ID.
- Pipefy SCIM API is based on version 2.0 of the SCIM standard.
- If you need to update the SCIM token, you must deactivate the IdM integration, update the token, and then reactivate the integration.
- Pipefy doesn't support custom groups. Pipefy's SCIM supported groups are:
- Pipefy-Super-Administrators
- Pipefy-administrators
- Pipefy-Company-guests
- Pipefy-External-guests
- Pipefy-members
- You can add anything at the end of those names to customize your groups, but it’s required to have those prefixes.
- Groups are supported.
Attribute Considerations
- A default set of attributes are managed for users. See the Attribute Mappings section for more details.
Creating a new ºÚÁϺ£½Ç91Èë¿Ú Application Integration
- Log in to the .
- Go to USER AUTHENTICATION &²µ³Ù;ÌýSSO Applications.
- Click + Add New Application.
- Type the name of the application in the Search field and select it.
- Click Next.
- In the Display Label, type your name for the application. Optionally, you can enter a Description, adjust the User Portal Image and choose to hide or Show in User Portal.
If this is a Bookmark Application, enter your sign-in URL in the Bookmark URL field.
- Optionally, expand Advanced Settings to specify a value for the SSO IdP URL. If no value is entered, it will default to https://sso.jumpcloud.com/saml2/<applicationname>.
The SSO IdP URL is not editable after the application is created. You will have to delete and recreate the connector if you need to edit this field at a later time.
- Click Save Application.
- If successful, click:
- Configure Application and go to the next section
- Close to configure your new application at a later time
Configuring the Identity Management Integration
To configure Pipefy
- The company should be on a specific Enterprise plan tier in order to request and schedule the SSO setup. If you're not sure if your company's plan tier is compatible, please access or check with your Customer Success Manager.
- Create a request to Pipefy's technical support team using this that specifies some key details we need to properly define your implementation.
- Receive confirmation from the technical support team and integration instructions. This initial review might take up to 15 business days and it may require further details from or discussions with your IT team before proceeding to schedule the cutover date to deploy your SSO framework.
- Pipefy wil set up a custom subdomain for logins from your company. This step may take up to 7 business days.
To configure ºÚÁϺ£½Ç91Èë¿Ú
- Create a new application or select it from the Configured Applications list.
- Select the Identity Management tab.
- Select the Enable management of User Groups and Group Membership in this application checkbox if you want to provision, manage, and sync groups in Pipefy from ºÚÁϺ£½Ç91Èë¿Ú.
- Click Configure.
- You’re presented with two fields:
- Base URL: Enter the SCIM URL for Pipefy: https://scim.pipefy.com/org/{organizationId}.
- Token Key: Fill in the Token Key field with a .
- Click Activate.
- You will receive a confirmation that the Identity Management integration has been successfully verified.
- Click save.
- You can now connect user groups to the application in ºÚÁϺ£½Ç91Èë¿Ú to provision the members of that group in Pipefy. Learn how to Authorize Users to an Application.
Attribute Mappings
The following table lists attributes that ºÚÁϺ£½Ç91Èë¿Ú sends to the application. See Attribute Considerations for more information regarding attribute mapping considerations.
Learn about ºÚÁϺ£½Ç91Èë¿Ú Properties and how they work with system users in our .
Pipefy User Attributes
ºÚÁϺ£½Ç91Èë¿Ú Property | ºÚÁϺ£½Ç91Èë¿Ú UI Field Name | SCIM v2 Mapping | ±Ê¾±±è±ð´Ú²âÌý³Õ²¹±ô³Ü±ð |
---|---|---|---|
username | Username | userName | IdP Username |
active | Status | active | active |
Company Email | emails:value | emails | |
firstname | First Name | name.givenName | firstName |
lastname | Last Name | name.familyName | lastName |
Group Attributes
ºÚÁϺ£½Ç91Èë¿Ú Property | ºÚÁϺ£½Ç91Èë¿Ú UI Field Name | SCIM v2 Mapping | Application Value |
---|---|---|---|
name | Name | displayName | Name |
Group Management Considerations
Enabling Group Management
You must select the Enable management of User Groups and Group Membership in this application option to manage groups and group membership in the application from ºÚÁϺ£½Ç91Èë¿Ú.
Group Provisioning and Syncing
- Empty groups are not created
- ºÚÁϺ£½Ç91Èë¿Ú takes over management of existing groups in the application when the user group name in ºÚÁϺ£½Ç91Èë¿Ú matches the name of the group in the application
- All user groups associated with the application in ºÚÁϺ£½Ç91Èë¿Ú are synced. Syncing occurs whenever there is a membership or group change event
- Group renaming is supported
- If a user group is disassociated from the application in ºÚÁϺ£½Ç91Èë¿Ú, syncing immediately stops and the group is left as-is in the application. All members of that user group are deactivated in the application unless they are associated with another active application group that is managed from ºÚÁϺ£½Ç91Èë¿Ú
Group Deletion
- Managed groups deleted in ºÚÁϺ£½Ç91Èë¿Ú are deleted in the application
- All members of the deleted group are deactivated in the application, unless they are associated with another active application group that is managed from ºÚÁϺ£½Ç91Èë¿Ú
Disabling Group Management
- You can disable group and group membership management by unchecking the Enable management of User Groups and Group Membership in this applicationÌý´Ç±è³Ù¾±´Ç²Ô
- The managed groups and group membership are left as-is in the application
- ºÚÁϺ£½Ç91Èë¿Ú stops sending group membership information for the user, but the user’s identity will continue to be managed from ºÚÁϺ£½Ç91Èë¿Ú
Importing Users
This functionality is helpful if users have already been created in the application but have not been created in ºÚÁϺ£½Ç91Èë¿Ú.
- Log in to the .
- Go to USER AUTHENTICATION > SSO Applications.
- Search for the application and click to open its configuration panel.
- Select the Identity Management tab.
- Click manual import.
- Select the users you want to create in ºÚÁϺ£½Ç91Èë¿Ú from the application from the list of users that appear. Users in the list have two import statuses:
- ±·±ð·ÉÌý- user has not been imported
- ±õ³¾±è´Ç°ù³Ù±ð»åÌý- user has been imported and has an account in ºÚÁϺ£½Ç91Èë¿Ú
Tip: Try using the New Users-only filter when selecting users to import. This will move all of your new users to the top of the list, making them easier to identify and select.
- Click import.
- If you are importing less than 100 users, your import results will display in real time and you can continue onboarding your usersÂ
- If you have more than 100 users being imported, ºÚÁϺ£½Ç91Èë¿Ú will send you an email when your import is complete
- You can now connect and grant users access to all their ºÚÁϺ£½Ç91Èë¿Ú resources. Learn more in the Authorize Users to an Application and Connecting Users to Resources articles.
Warning: Imported users must be members of a user group bound to an application for ºÚÁϺ£½Ç91Èë¿Ú to manage their identity in, and access to, the application.
SCIM Directory Insights Events
The following Directory Insights (DI) events provide visibility into failures and detailed information about the user and group data being added or updated from HR or other external solutions to ºÚÁϺ£½Ç91Èë¿Ú.
Customers with no package or the Device Management Package will need to add the Directory Insights à la carte option. Directory Insights is included in all other .
SCIM DI Integration Events
Event Name | Event Description |
---|---|
idm_integration_activate | Logged when an IT admin attempts to activated new SCIM Identity Management integration. |
idm_integration_update | Logged when an IT admin attempts to update a configured and activated SCIM Identity Management integration. |
idm_integration_reauth | Logged when an IT admin attempts to change the credentials for an activated SCIM Identity Management integration. |
idm_integration_delete | Logged when an IT admin attempts to deactivate an activated SCIM Identity Management integration. |
SCIM DI User Events
Event Name | Event Description |
---|---|
user_create_provision | Logged when ºÚÁϺ£½Ç91Èë¿Ú tries to create a new user in service provider application. |
user_update_provision | Logged when ºÚÁϺ£½Ç91Èë¿Ú tries to update an existing user in service provider application. |
user_deprovision | Logged when ºÚÁϺ£½Ç91Èë¿Ú tries to change an existing user to inactive in the service provider application. |
user_delete_provision | Logged when ºÚÁϺ£½Ç91Èë¿Ú tries to delete an existing user in service provider application. |
user_lookup_provision | Logged when ºÚÁϺ£½Ç91Èë¿Ú encounters an issue when trying to lookup a user to determine if the user needs to be created or updated. |
SCIM DI Group Events
These DI events will only be present if SCIM Groups are supported.
Event Name | Event Description |
---|---|
group_create_provision | Logged when ºÚÁϺ£½Ç91Èë¿Ú tries to create a new group in service provider application. |
group_update_provision | Logged when ºÚÁϺ£½Ç91Èë¿Ú tries to update an existing group in service provider application. |
group_delete_provision | Logged when ºÚÁϺ£½Ç91Èë¿Ú tries to delete an existing group in service provider application. |
Removing the Integration
These are steps for removing the integration in ºÚÁϺ£½Ç91Èë¿Ú. Consult your SP's documentation for any additional steps needed to remove the integration in the SP. Failure to remove the integration successfully for both the SP and ºÚÁϺ£½Ç91Èë¿Ú may result in users losing access to the application.
To deactivate the IdM Integration
- Log in to the .
- Go to USER AUTHENTICATION > SSO Applications.
- Search for the application that you’d like to deactivate and click to open its details panel.
- Under the company name and logo on the left hand panel, click the Deactivate IdM connection link.
- Click confirm.
- If successful, you will receive a confirmation message.
To deactivate the SSO Integration or Bookmark
- Log in to the .
- Go to USER AUTHENTICATION > SSO Applications.
- Search for the application that you’d like to deactivate and click to open its details panel.
- Select the SSO or Bookmark tab.
- Scroll to the bottom of the configuration.
- Click Deactivate SSO or Deactivate Bookmark.
- Click save.
- If successful, you will receive a confirmation message.
To delete the application
- Log in to the .
- Go to USER AUTHENTICATION > SSO Applications.
- Search for the application that you’d like to delete.
- Check the box next to the application to select it.
- Click Delete.
- Enter the number of the applications you are deleting
- Click Delete Application.
- If successful, you will see an application deletion confirmation notification.