Skip to main content
Version: v4.9

SCIM with Azure AD

Cyral supports the use of the SCIM protocol to retrieve group information from your Azure AD directory. While Cyral also supports other ways to retrieve group information from Azure AD, the SCIM approach is the only way to get group information for login workflows in which the user does not visit the Cyral Access Portal. For example, a Snowflake login with Cyral SSO relies on Cyral's SCIM integration to retrieve the user's group information.

Prerequisites

Before you set up the SCIM integration, make sure you have:

  • A working Azure AD SSO integration in Cyral.

    tip

    Cyral recommends that you create a new Azure AD SSO integration that is not being used in any other Cyral integration in your environment.

  • Users who will log in with Cyral must have the following identity attributes stored in their Azure AD user record:

    • first name

    • last name

    • username

    • email

    tip

    If your Azure AD application uses email addresses as the username values, it is possible to populate the email field with the value of username in your mappings. See mapping email address as username below.

Get configuration values from the Cyral UI

  1. In the Cyral CP, navigate to Integrations ➡️ SAML ➡️ Configure ➡️ find your SAML SSO integration and click the pencil icon to edit.

  2. Select Enable service account resolution. The Configure Your SCIM Integration panel appears.

  3. Note the value shown in the field, SCIM connector base URL. In the next procedure, you or your SAML administrator will copy this value into SAML. Keep this tab open, or store this value securely until you need it. This value contains the OAuth bearer token, which must be kept secure.

    note

    The information shown here includes:

    • SCIM connector base URL: The base URL for the SCIM integration endpoints.
    • Supported provisioning actions: The provisioning actions your SAML app will take for this integration. In our case, we want the SAML app to:
      • Push New Users to Cyral
      • Push Profile Updates to Cyral
      • Push Groups to Cyral
    • Authentication Mode: The method used by SAML to authenticate with Cyral. This will be an OAuth HTTP bearer token.
    • Bearer Token: An OAuth access token needed for authentication and authorization with the Cyral SCIM endpoints associated with the given integration instance.
  4. Click Save.

Configure Azure AD

  1. Sign in to your Azure AD portal. Navigate to the Enterprise Application that you have configured for Cyral SSO.

  2. In the app management screen, select Provisioning in the left panel.

  3. Click on Get started.

  4. In the Provisioning Mode menu, select Automatic.

  5. In the Tenant URL field, enter the SCIM connector base URL you copied from the Cyral UI earlier. This is the SCIM base URL of your Cyral SCIM integration. For example: https://example.app.cyral.com/v1/scim/aad.9ba88b7e-0a2c-4d93-9d62-44deca32109

  6. In the Secret Token field, enter the token copied from the Cyral UI's Bearer token field.

  7. Click Test Connection. This should result in a green checkmark (✔️) in the upper right of the Azure AP portal page.

  8. Select Save to save the admin credentials.

  9. Clicking Save activates two more settings sections, Mappings and Settings:

    • Mappings: Make sure both the mappings for groups and users are Enabled. The default mappings are compatible with the Cyral SCIM service.

      tip

      If your Azure AD application uses email addresses as the username values, it is possible to populate the email field with the value of username in your mappings. See mapping email address as username below.

    • Settings: This setting is optional. Add an Email Address where failure notifications can be sent.

    • Click Save to save your configuration changes.

  10. Refresh the current page and click Edit provisioning. A new configuration field, Scope, appears in the Settings section.

  11. Select Sync only assigned users and groups from the dropdown menu

  12. Set the Provisioning Status to ON and click Save.

  13. To force the sync now:

    • Go to the SCIM app page (by refreshing the current screen or by clicking on SCIM app at the top left corner of the page)
    • Click on the Refresh icon in the upper right.

Mapping email address as username

If your Azure AD application uses email addresses as the username values, it is possible to populate the email field with the value of username while defining the attribute mapping from Azure to the Cyral SCIM application. In order to do so, please do the following during step 9a of the ‘Azure Configuration Process’:

  1. Under the Mappings Option, select Provision Azure Active Directory Users

  2. Click on the mapping entry that maps Source attribute mail to Target attribute emails[type eq "work"].value

  3. In this entry, change the Source attribute from mail to userPrincipalName

  4. Click OK then Save.

Next step

With SCIM configured, your Cyral installation can provide service account resolution for Looker and Tableau, ensuring you know the SSO user identity of users who connect to a repository through a service account. See set-up instructions: