Tutorial: Configure Cofense Recipient Sync for automatic user provisioning

This tutorial describes the steps you need to perform in both Cofense Recipient Sync and Azure Active Directory (Azure AD) to configure automatic user provisioning. When configured, Azure AD automatically provisions and de-provisions users to Cofense Recipient Sync using the Azure AD Provisioning service. For important details on what this service does, how it works, and frequently asked questions, see Automate user provisioning and deprovisioning to SaaS applications with Azure Active Directory.

Capabilities Supported

  • Create users in Cofense Recipient Sync
  • Remove users in Cofense Recipient Sync when they do not require access anymore
  • Keep user attributes synchronized between Azure AD and Cofense Recipient Sync


The scenario outlined in this tutorial assumes that you already have the following prerequisites:

  • An Azure AD tenant
  • A user account in Azure AD with permission to configure provisioning (for example, Application Administrator, Cloud Application administrator, Application Owner, or Global Administrator).
  • A standard operator account in Cofense PhishMe.

Step 1. Plan your provisioning deployment

  1. Learn about how the provisioning service works.
  2. Determine who will be in scope for provisioning.
  3. Determine what data to map between Azure AD and Cofense Recipient Sync.

Step 2. Configure Cofense Recipient Sync to support provisioning with Azure AD

  1. Login to Cofense PhishMe. Navigate to Recipients > Recipient Sync.

  2. Accept the terms and conditions and then click Get Started.

    Recepient Sync tnc

  3. Copy the values from the URL and Token fields.

    Recepient Sync

Add Cofense Recipient Sync from the Azure AD application gallery to start managing provisioning to Cofense Recipient Sync. If you have previously setup Cofense Recipient Sync for SSO, you can use the same application. However it is recommended that you create a separate app when testing out the integration initially. Learn more about adding an application from the gallery here.

Step 4. Define who will be in scope for provisioning

The Azure AD provisioning service allows you to scope who will be provisioned based on assignment to the application and or based on attributes of the user / group. If you choose to scope who will be provisioned to your app based on assignment, you can use the following steps to assign users and groups to the application. If you choose to scope who will be provisioned based solely on attributes of the user or group, you can use a scoping filter as described here.

  • When assigning users and groups to Cofense Recipient Sync, you must select a role other than Default Access. Users with the Default Access role are excluded from provisioning and will be marked as not effectively entitled in the provisioning logs. If the only role available on the application is the default access role, you can update the application manifest to add additional roles.

  • Start small. Test with a small set of users and groups before rolling out to everyone. When scope for provisioning is set to assigned users and groups, you can control this by assigning one or two users or groups to the app. When scope is set to all users and groups, you can specify an attribute based scoping filter.

Step 5. Configure automatic user provisioning to Cofense Recipient Sync

This section guides you through the steps to configure the Azure AD provisioning service to create, update, and disable users in Cofense Recipient Sync based on user in Azure AD.

To configure automatic user provisioning for Cofense Recipient Sync in Azure AD:

  1. Sign in to the Azure portal. Select Enterprise Applications, then select All applications.

    Enterprise applications blade

  2. In the applications list, select Cofense Recipient Sync.

    The Cofense link in the Applications list

  3. Select the Provisioning tab.

    Provisioning tab

  4. Set the Provisioning Mode to Automatic.

    Provisioning tab automatic

  5. Under the Admin Credentials section, input the SCIM 2.0 base url and SCIM Authentication Token value retrieved earlier from Step 2. Click Test Connection to ensure Azure AD can connect to Cofense Recipient Sync. If the connection fails, ensure your Cofense Recipient Sync account has Admin permissions and try again.

    Tenant URL Token

  6. In the Notification Email field, enter the email address of a person or group who should receive the provisioning error notifications and select the Send an email notification when a failure occurs check box.

    Notification Email

  7. Select Save.

  8. Under the Mappings section, select Synchronize Azure Active Directory Users to Cofense Recipient Sync.

  9. Review the user attributes that are synchronized from Azure AD to Cofense Recipient Sync in the Attribute-Mapping section. The attributes selected as Matching properties are used to match the user accounts in Cofense Recipient Sync for update operations. Select the Save button to commit any changes.

    Attribute Type
    userName String
    externalId String
    active Boolean
    displayName String
    name.formatted String
    name.givenName String
    name.familyName String
    name.honorificSuffix String
    phoneNumbers[type eq"work"].value String
    phoneNumbers[type eq"home"].value String
    phoneNumbers[type eq"other"].value String
    phoneNumbers[type eq"pager"].value String
    phoneNumbers[type eq"mobile"].value String
    phoneNumbers[type eq"fax"].value String
    addresses[type eq"other"].formatted String
    addresses[type eq"work"].formatted String
    addresses[type eq"work"].streetAddress String
    addresses[type eq"work"].locality String
    addresses[type eq"work"].region String
    addresses[type eq"work"].postalCode String
    addresses[type eq"work"].country String
    title String
    emails[type eq "work"].value String
    emails[type eq "home"].value String
    emails[type eq "other"].value String
    preferredLanguage String
    nickName String
    userType String
    locale String
    timezone String
    urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber String
    urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department String
    urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager Reference
    urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:costCenter String
    urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division String
    urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:organization String
  10. To configure scoping filters, refer to the following instructions provided in the Scoping filter tutorial.

  11. To enable the Azure AD provisioning service for Cofense Recipient Sync, change the Provisioning Status to On in the Settings section.

    Provisioning Status Toggled On

  12. Define the users and/or groups that you would like to provision to Cofense Recipient Sync by choosing the desired values in Scope in the Settings section.

    Provisioning Scope

  13. When you are ready to provision, click Save.

    Saving Provisioning Configuration

This operation starts the initial synchronization cycle of all users and groups defined in Scope in the Settings section. The initial cycle takes longer to perform than subsequent cycles, which occur approximately every 40 minutes as long as the Azure AD provisioning service is running.

Step 6. Monitor your deployment

Once you've configured provisioning, use the following resources to monitor your deployment:

  1. Use the provisioning logs to determine which users have been provisioned successfully or unsuccessfully
  2. Check the progress bar to see the status of the provisioning cycle and how close it is to completion
  3. If the provisioning configuration seems to be in an unhealthy state, the application will go into quarantine. Learn more about quarantine states here.

Additional resources

Next steps