You are viewing an earlier version of the admin guide. For the latest version, please visit EmpowerID Admin Guide v7.211.0.0.

Skip to end of banner
Go to start of banner

Connect to Salesforce (SCIM Connector)

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Before connecting EmpowerID to an external directory, please review the Getting Started with Directory Systems topic. The topic walks you through the prerequisites you need to complete before connecting to an external directory for the first time. These prerequisites include:

  • Configuring the appropriate server roles for your EmpowerID servers

  • Reviewing the Join and Provision Rules for your environment

  • Reviewing the Join and Provision Filters for your environment

If you have already connected EmpowerID to another external directory, you can skip the above prerequisites.

EmpowerID provides connectors for a wide range of user directories and resource systems. As an administrator, you can use these connectors to quickly connect EmpowerID to your organization's identity-aware systems and applications. When you do so, you create an account store for that application in the EmpowerID Identity Warehouse and use that account store to configure how you want EmpowerID to manage the identity information in that system.

Prerequisites

In order to connect EmpowerID to Salesforce you must have a Salesforce tenant with an account that EmpowerID can use to connect to Salesforce and do the following in the tenant:

  • Register a connected app for EmpowerID with a certificate in Salesforce using the OAuth 2.0 JWT bearer authorization flow. Give the app the following OAuth Scopes:

    • Access and manage your data (api)

    • Perform requests on your behalf at any time (refresh_token, offline_access)

    • Provide access to your data via the Web (web)

  • Upload the private key for the certificate to the EmpowerID certificate store.

For directions on setting up a connected up in Salesforce, please see the Salesforce documentation on the subject at https://help.salesforce.com/articleView?id=sf.connected_app_overview.htm&type=5.

Step 1 – Create a Salesforce account store in EmpowerID

  1. On the navbar, expand Admin > Applications and Directories and then select Account Stores and Systems.

  2. On the Account Stores page, select the Actions tab and then click Create Account Store.

  3. Under System Types, search for Salesforce.

  4. Click the Salesforce.com record to select the type and then click Submit.

  5. On the Salesforce settings page that appears, enter the following information:

    • Name – Enter a name for the account store

    • Service URL – Enter the URL for your Salesforce tenant

    • API Endpoint – Enter /services/data/v36.0/

    • Certificate Thumbprint – Enter the thumbprint of the certificate you uploaded to Azure for the service principal application created earlier.

    • User Name – Enter the username of the Salesforce service account you created in Salesforce for EmpowerID.

    • Client Secret – Enter the value of the token generated by Salesforce for the selected user account.

    • Service Account Token – Enter the value of the token generated by Salesforce for the selected user account.

    • SCIM URL – Enter the URL for the Salesforce SCIM app service created earlier.

  6. When you have added your settings, click Submit to create the account store.

EmpowerID creates the account store and the associated resource system. The next step is to configure attribute flow between the account store and EmpowerID.

Step 2 – Configure Attribute flow

EmpowerID supports the configuration of attribute synchronization rules for flowing attribute changes between directories and the EmpowerID Identity Warehouse. Attribute Flow rules are visually configured and are always relative to the relationship between an attribute in a directory and the corresponding attribute in the EmpowerID Identity Warehouse. Attribute Flow rules define the specific fields and attributes that are synchronized between the EmpowerID Identity Warehouse person objects and the external user accounts to which they are linked. Additionally, Attribute Flow rules can be weighted by account store. For example, if you have connected EmpowerID to an HR system as well as Active Directory, and you want any changes made to an attribute in the HR system to take priority over changes made in Active Directory or EmpowerID (while allowing changes to be made in any system), you would give a higher score for each CRUD operation originating from the HR account store and correspondingly lower scores for the Active Directory account store.

The following flow rules are available:

  • No Sync 🔴 – When this option is selected, no information flows between EmpowerID and the native system.

  • Bidirectional Flow (blue star) – When this option is selected, changes made within EmpowerID update the native system and vice-versa. For most attributes, this is the default setting.

  • Account Store Changes Only (blue star) – When this option is selected, changes can only be made in the native system and are then passed to EmpowerID.

  • EmpowerID Changes Only (blue star) – When this option is selected, changes can only be made in EmpowerID and are then passed to the native system.

The following CRUD operations are available:

  • Create – This operation is used to create an attribute value for an existing attribute when the value of that attribute is null.

  • Update – This operation is used to update the value of an attribute.

  • Delete – This operation is used to delete the value of an attribute.

  1. From the Account Stores tab of the Account Stores and Systems page, search for the account store you just created and click the Account Store link for it.

  2. Click the Attribute Flow Rules tab to view the current rules for the account store. Please note that the attributes available depend on the account store.

  3. To change the flow for an attribute, click the Attribute Flow drop-down located between the Person Attribute column and the External Directory Attribute column, and select the desired flow direction from the context menu.

  4. To change the score for any of the available CRUD operations (Create, Update and Delete), enter the new score in the appropriate field. By default, scores are weighted evenly, which means that a change to an attribute originating in one connected external directory has the same authority as a change to an attribute occurring in another connected external directory.

EmpowerID only considers scores for attribute CRUD operations when multiple account stores with the same user records are connected to EmpowerID, such as would be the case if an HR System and this account store were being inventoried by EmpowerID.

Now that the attribute flow has been set, the next steps include configuring the account store and enabling EmpowerID to inventory it.

Step 3 – Configure account store settings

  1. On the Account Store and Resource System page for Salesforce, click the Account Store tab and then click the pencil icon to put the account store in edit mode.


    This opens the edit page for the account store. This page allows you to specify the account proxy used to connect EmpowerID to your Salesforce account as well as how you want EmpowerID to handle the user information it discovers in UltiPro during inventory. Settings that can be edited are described in the table below the image.

    Account Store Settings

    Setting

    Description

    General Settings

    IT Environment Type

    Allows you to specify the type of environment in which you are creating the account store.

    Account Store Type

    Allows you to specify the type for the account store.

    Option 1 Specify an Account Proxy

    Allows you to change the credentials for the account that EmpowerID uses to connect to and manage the account store.

    Option 2 Select a Vaulted Credential as Account Proxy

    Allows you to use a credential that you have vaulted in EmpowerID as the account that EmpowerID uses to connect to and manage the account store.

    Inventoried Directory Server

    Allows you to select a connected server as the directory server for the account store.

    Is Visible in ITShop

    Specifies whether the account store can be used to filter IT Shop resources to show resources, such as groups, contained in the account store.

    Authentication and Password Settings

    Allow Password Sync

    Enables or disables the synchronization of password changes to user accounts in the domain based on password changes for the owning person object or another account owned by the person. This setting does not prevent password changes by users running the reset user account password workflows.

    Queue Password Changes

    Specifies whether EmpowerID sends password changes to the Account Password Reset Inbox for batch processing.

    Password Manager Policy for Accounts without Person

    Specifies the Password Manager Policy to be used for user accounts not joined to an EmpowerID Person.

    Provisioning Settings

    Allow Person Provisioning (Joiner Source)

    Specifies whether EmpowerID Persons can be provisioned from user accounts in the account store.

    Allow Attribute Flow

    Specifies whether attribute changes should flow between the account store and EmpowerID.

    Allow Provisioning (By RET)

    Allows or disallows the Resource Entitlement (RET) Inbox process to auto-provision accounts for this domain for users who receive RET policy-assigned user accounts, but have not yet had them provisioned.

    Allow Deprovisioning (By RET)

    Allows or disallows the Resource Entitlement Inbox process to auto de-provision accounts for this domain for users who still have RET policy-assigned user accounts, but no longer receive a policy that grants them a user account in the domain. De-provisioning only occurs if the de-provision action on the Resource Entitlement policy is set to De-Provision.

    Business Role Settings

    Allow Business Role and Location Re-Evaluation

    Specifies whether Business Role and Location re-evaluation should occur for the account store

    Business Role and Location Re-Evaluation Order

    Specifies the order of the account store for re-evaluating Business Roles and locations

    Inventory Auto Provision OUs as IT System Locations

    Specifies whether EmpowerID should automatically provision external OUs as IT System locations

    Inventory Auto Provision External Roles as Business Roles

    Specifies whether EmpowerID should provision Business roles for external account store roles

    Default Person Business Role

    Specifies the default EmpowerID Business Role to be assigned to each EmpowerID Person provisioned from the user accounts in the account store.

    Default Person Location (leave blank to use account container)

    Specifies the default EmpowerID Location to be assigned to each EmpowerID Person provisioned from the user accounts in the account store.

    Group Settings

    Allow Account Creation on Membership Request

    Specifies whether EmpowerID creates user accounts in the account store when an EmpowerID Person without one requests membership within a group belonging to the account store.

    Recertify External Group Changes as Detected

    Specifies whether detected group changes should trigger recertification.

    SetGroup of Groups to Monitor for Real-Time Recertification

    Specifies the SetGroup to be used for monitoring group membership changes.

    Directory Clean Up Enabled

    Directory Clean Up Enabled

    Specifies whether the SubmitAccountTermination permanent workflow should claim the account store for processing account terminations. When enabled, accounts in the account store that meet the qualifications to be marked for deletion are moved into a special location within the external directory, disabled and finally deleted after going through an automated approval process. This process involves setting a number of system settings in EmpowerID and requires multiple approvals by designated personnel before an account is finally removed from the account store.

    Report Only Mode (No Changes)

    When enabled, a report of what the Directory Clean Up process would do is written to the log. The process itself is ignored and all accounts are set to Termination Pending,

    Special Use Settings

    Automatically Join Account to a Person on Inventory (Skip Account Inbox)

    Specifies whether EmpowerID should attempt to join user accounts in the account store to an existing EmpowerID Person during the inventory process. When enabled, the Account Inbox is bypassed.

    Automatically Create a Person on Inventory (Skip Account Inbox)

    Specifies whether EmpowerID should create new EmpowerID Persons from the user accounts discovered in the account store during the inventory process. When enabled, the Account Inbox is bypassed.

    Queue Password Changes on Failure

    Specifies whether EmpowerID should send password changes to the Account Password Reset Inbox only when the change fails.

    Inventory Settings

    Inventory Enabled

    Allows EmpowerID to inventory the user information in the account store.

    Inventory Schedule Interval

    Specifies the time span that occurs before EmpowerID performs a complete inventory of the account store. The default value is 10 minutes.

    Membership Settings

    Enable Group Membership Reconciliation

    Allows EmpowerID to manage the membership of the account store’s groups, adding and removing user to and from groups based on policy-based assignment rules.

    Membership Schedule Interval

    Specifies the time span that occurs before EmpowerID runs the Group Membership Reconciliation job. The default value is 10 minutes.


  2. Edit the account store as needed and then click Save to save your changes.

Step 4 – Verify Salesforce resource system parameters

  1. On the Account Store Details page for the Salesforce account store, select the Resource System tab and then expand the Configuration Parameters accordion at the bottom of the page.

  2. You should a number of parameters for the resource system. The values for these are generated based on the information you provide when creating the account store. If any of the values are incorrect, please update them to ensure successful inventory of your Salesforce tenant. The following parameters are of particular importance:

    • ApiEndPoint – Value should be /services/data/v36.0/

    • certificateThumbPrint – Value should be the thumbprint of the certificate you uploaded to Salesforce for the connected application you created in Salesforce for EmpowerID.

    • ClientSecret – Value should be the secret generated by Salesforce for the connected application you created in Salesforce for EmpowerID.

    • LoginUrl – Value should be the login URL for Salesforce.

    • ServiceUrl – Value should be your Salesforce domain.

    • Username – Value should be the username of the Salesforce service account used by EmpowerID.

Next, enable the Account Inbox permanent workflow to allow the Account Inbox to provision or join the user accounts in Box to EmpowerID Persons as demonstrated below.

EmpowerID recommends using the Account Inbox for provisioning and joining.

Step 4 – Enable the Account Inbox Permanent Workflow

  1. On the navbar, expand Infrastructure Admin > EmpowerID Server and Settings and select Permanent Workflows.

  2. On the Permanent Workflows page, click the Display Name link for Account Inbox.


  3. On the Permanent Workflow Details page that appears, click the pencil icon to put the workflow in edit mode.

  4. Check Enabled.


  5. Click Save to save your changes.

Step 5 – Monitor Inventory

  1. On the navbar, expand Identity Lifecycle and select Account Inbox.

    The Account Inbox page appears. This page provides tabbed views of all information related to processing new user accounts discovered in a connected account store during inventory. An explanation of these tabs follows.

    • All — This tab displays a grid view of all user accounts and the status of those accounts in relation to the Account Inbox.

    • Dashboard — This tab provides a quick summary of account inbox activity.

    • Orphans — This tab displays a grid view of all user accounts without an EmpowerID Person.


See Also

Salesforce Connector

Provisioning Policy for Salesforce Accounts

IN THIS ARTICLE

  • No labels