Tutorial: Configure Peakon for automatic user provisioning

The objective of this tutorial is to demonstrate the steps to be performed in Peakon and Azure Active Directory (Azure AD) to configure Azure AD to automatically provision and de-provision users and/or groups to Peakon.

Note

This tutorial describes a connector built on top of the Azure AD User 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.

This connector is currently in Preview. For more information on the general Microsoft Azure terms of use for Preview features, see Supplemental Terms of Use for Microsoft Azure Previews.

Prerequisites

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

  • An Azure AD tenant.
  • A Peakon tenant.
  • A user account in Peakon with Admin permissions.

Assigning users to Peakon

Azure Active Directory uses a concept called assignments to determine which users should receive access to selected apps. In the context of automatic user provisioning, only the users and/or groups that have been assigned to an application in Azure AD are synchronized.

Before configuring and enabling automatic user provisioning, you should decide which users and/or groups in Azure AD need access to Peakon. Once decided, you can assign these users and/or groups to Peakon by following the instructions here:

Important tips for assigning users to Peakon

  • It is recommended that a single Azure AD user is assigned to Peakon to test the automatic user provisioning configuration. Additional users and/or groups may be assigned later.

  • When assigning a user to Peakon , you must select any valid application-specific role (if available) in the assignment dialog. Users with the Default Access role are excluded from provisioning.

Set up Peakon for provisioning

  1. Sign in to your Peakon Admin Console. Click on Configuration.

    Peakon Admin Console

  2. Select Integrations.

    Peakon-employee-provision

  3. Enable Employee Provisioning.

    Peakon-employee-provision

  4. Copy the values for SCIM 2.0 URL and OAuth Bearer Token. These values will be entered in the Tenant URL and Secret Token field in the Provisioning tab of your Peakon application in the Azure portal.

    Peakon Create Token

To configuring Peakon for automatic user provisioning with Azure AD, you need to add Peakon from the Azure AD application gallery to your list of managed SaaS applications.

  1. In the Azure portal, in the left navigation panel, select Azure Active Directory.

    The Azure Active Directory button

  2. Go to Enterprise applications, and then select All applications.

    The Enterprise applications blade

  3. To add a new application, select the New application button at the top of the pane.

    The New application button

  4. In the search box, enter Peakon, select Peakon in the results panel, and then click the Add button to add the application.

    Peakon  in the results list

Configuring automatic user provisioning to Peakon

This section guides you through the steps to configure the Azure AD provisioning service to create, update, and disable users and/or groups in Peakon based on user and/or group assignments in Azure AD.

Tip

You may also choose to enable SAML-based single sign-on for Peakon, following the instructions provided in the Peakon Single sign-on tutorial. Single sign-on can be configured independently of automatic user provisioning, though these two features compliment each other.

To configure automatic user provisioning for Peakon 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 Peakon.

    The Peakon  link in the Applications list

  3. Select the Provisioning tab.

    Provisioning tab

  4. Set the Provisioning Mode to Automatic.

    Provisioning tab

  5. Under the Admin Credentials section, input the SCIM 2.0 URL and OAuth Bearer Token values retrieved earlier in Tenant URL and Secret Token respectively. Click Test Connection to ensure Azure AD can connect to Peakon. If the connection fails, ensure your Peakon 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 check the checkbox - Send an email notification when a failure occurs.

    Notification Email

  7. Click Save.

  8. Under the Mappings section, select Synchronize Azure Active Directory Users to Peakon.

    Peakon User Mappings

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

    Peakon User Attributes

  10. To configure scoping filters, refer to the following instructions provided in the Scoping filter tutorial.

    Provisioning Scope

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

    Saving Provisioning Configuration

This operation starts the initial synchronization of all users and/or groups defined in Scope in the Settings section. The initial sync takes longer to perform than subsequent syncs, which occur approximately every 40 minutes as long as the Azure AD provisioning service is running. You can use the Synchronization Details section to monitor progress and follow links to provisioning activity report, which describes all actions performed by the Azure AD provisioning service on Peakon.

For more information on how to read the Azure AD provisioning logs, see Reporting on automatic user account provisioning.

Connector limitations

  • All custom user attributes in Peakon have to be extended from Peakon's custom SCIM user extension of urn:ietf:params:scim:schemas:extension:peakon:2.0:User.

Additional resources

Next steps