Identity
Configure SCIM Connector for the Cloud Identity Engine
Table of Contents
Expand All
|
Collapse All
Identity Docs
Configure SCIM Connector for the Cloud Identity Engine
| Where Can I Use This? | What Do I Need? |
|---|---|
| The Cloud Identity Engine service is free; however, the enforcement points utilizing directory data may require specific licenses. Click here for more information. |
As part of the Cloud Identity Engine, Directory Sync connects to your directory to
obtain user and group information for user identification and enforcement for
group-based and user-based Security policy.
Configuring the System for Cross-Domain Identity Management (SCIM) protocol for Directory Sync in the
Cloud Identity Engine allows you to customize the attributes Directory Sync collects
from your directory. You can add or remove attributes in your directory portal to
customize which attributes you want to share with the Cloud Identity Engine for user
and group identification.
The SCIM gallery app does not support the userType
attribute.
Configuring your directory to use the SCIM Connector with the Cloud Identity Engine
requires completing all necessary steps in both the Cloud Identity Engine and in the
portal for your specific SCIM client. If you encounter any issues with the SCIM
Connector setup, learn how to Troubleshoot Cloud Identity Engine Issues.
- Complete any predeployment steps for your SCIM client:Set up SCIM Connector in the Cloud Identity Engine app.
- Log in to the Cloud Identity Engine.Select Directory SyncDirectories, and then click Add New Directory.On the Set Up Directory page, select Cloud DirectorySet UpSCIM.
Select a SCIM Client:- Entra ID
- PingFederate
- Okta
- CyberArk
- PingOne
- SASE 5G
- Others
(Specific SCIM clients) In the portals for the following SCIM clients, obtain the directory details required to configure the SCIM Connector:On the Configure Directory Sync for SCIM page, enter the directory details, obtain the Base URL, and specify the Authorization Method.- For Directory ID, enter the specified value from your directory portal or create a unique ID (maximum 40 alphanumeric characters, including hyphens):
- For Entra ID, use the Tenant ID.
- For Ping, use the System ID.
- For Okta, use the Directory Name. For Okta, Palo Alto Networks recommends using the Directory Name, but you can enter any name.
- For CyberArk, enter CyberArkSCIM or a similar ID.
- For SASE 5G, use the Directory ID.
For the Directory Name, enter the specified value from your directory portal or create a unique name (maximum 50 lowercase alphanumeric characters including periods, hyphens, and underscores):- For Entra ID, use the Primary Domain.
- For Ping, use the User.
- For Okta, use the Okta Domain.
- For CyberArk, enter cyberarkdirectoryscim or a similar name.
- For SASE 5G, use the Primary Domain Name.
Copy the Base URL and save it in a secure location.You need this URL to configure provisioning settings in your directory portal.
Click Generate Token, and then copy and save the Bearer Token in a secure location.You need to enter this token in the directory portal for your SCIM client.If you submit your changes in the Cloud Identity Engine before saving the token, you must generate a new token and enter the token in the directory portal.
Click Submit.You must Submit the configuration in the Cloud Identity Engine before continuing the configuration in the IdP. After you finish the IdP configuration, return to the Cloud Identity Engine and complete a full sync of the entire directory to complete the process.Acknowledge the postconfiguration requirements.Select the check box, click OK, and then return to the portal for your SCIM client to complete the postconfiguration steps:
After completing the steps in both the Cloud Identity Engine app and your directory portal, you can use the SCIM Connector to collect attributes from your directory.Next Steps:- Learn which Cloud Identity Engine Attributes the SCIM Collector collects.
- View directory data.
- To extend the capabilities of the Cloud Identity Engine, associate the Cloud Identity Engine with Palo Alto Networks apps you use in your network.
Configure Microsoft Entra ID for SCIM Connector
Complete the required steps in the Microsoft Entra admin center to complete the SCIM Connector configuration. For more information, refer to the Microsoft Entra ID SCIM Connector documentation.- Add the Palo Alto Networks SCIM Connector app to your Microsoft Entra tenant, and then obtain the necessary information to configure SCIM for Directory Sync.Microsoft Entra ID SCIM provisioning requires that the group attribute displayName is unique. If more than one group uses the displayName attribute, the initial sync isn't successful and the data for the duplicate group names might only be partially retrievable. If you don't use the duplicate groups in Security policy, then you can proceed. If you use the duplicate group names in Security policy, you must resolve the issue by modifying the displayName attribute in Microsoft Entra ID to ensure that it’s unique.
- Log in to the Microsoft Entra admin center.Select Overview (if not already selected), copy the Tenant ID, and save it in a secure location.
Copy the Primary domain and save it in a secure location.
Select ApplicationsEnterprise applications, and then click New application.In the Microsoft Entra gallery, Search for Palo Alto Networks SCIM Connector.
Select Palo Alto Networks SCIM Connector, enter a Name, and then Create the application.
If you encounter an error when creating the application, refer to Troubleshoot Cloud Identity Engine Issues.Return to the Cloud Identity Engine app to continue the SCIM Connector setup.You must complete the setup in the Cloud Identity Engine before you can successfully Test Connection in the Microsoft Entra admin center.After you submit the SCIM Connector configuration in the Cloud Identity Engine app, continue to the next step.Configure Microsoft Entra ID to use SCIM Connector to connect to the Cloud Identity Engine.- Log in to the Microsoft Entra admin center.Select ApplicationsEnterprise applications, and then select the Palo Alto Networks SCIM Connector application.Select Provisioning, and then click Get Started.
Set the Provisioning Mode to Automatic.
In the Admin Credentials section, enter the information from steps 4.c and 4.d in the fields as indicated in the following table:Copy from Cloud Identity Engine Enter in Microsoft Entra admin center Base URL Tenant URL Authorization Method Bearer token Secret Token
Save your changes.
(Optional but recommended) Click Test Connection to confirm that Microsoft Entra ID can communicate with the Cloud Identity Engine app.You must complete the setup in the Cloud Identity Engine before you can successfully Test Connection in the Microsoft Entra admin center.
Manage the users, groups, and attributes that Microsoft Entra ID provisions to the Cloud Identity Engine app.If you choose to sync only specific groups and those groups contain subgroups, add the parent group first, then add any child groups. If you do not manually add the child groups of any parent groups, the Cloud Identity Engine syncs only the parent group. You do not need to manually add users as the Cloud Identity Engine sync users in groups, just any child groups of parent groups where you want to sync both groups.- In the Microsoft Entra admin center, select ProvisioningEdit Provisioning.Select Mappings, and then select either Provision Microsoft Entra ID Groups or Provision Microsoft Entra ID Users.For optimal performance, Palo Alto Networks strongly recommends provisioning only the groups that you want to use the SCIM Connector. If you're using Prisma® Access with the Cloud Identity Engine, make sure that you provision any groups that you use in your Security policy to ensure it applies your Security policy correctly.
Delete any attributes you do not want to provide to the Cloud Identity Engine app.
(Optional) Click Add New Mapping to create a new attribute mapping.
(Optional) In the Settings section, set Scope to Sync all users and groups.By default, the Cloud Identity Engine only synchronizes the users and groups you assign to this app (Sync only assigned users and groups) in the Microsoft Entra admin center.
In the Settings section, set the Provisioning Status to On.This enables the Microsoft Entra provisioning service for Palo Alto Networks SCIM Connector.Save your changes.Allow Microsoft Entra ID to provide the information to the Cloud Identity Engine, and verify that the Cloud Identity Engine uses SCIM to obtain the Microsoft Entra ID information.- In the Microsoft Entra admin center, verify you’ve completed all the provisioning steps in the Microsoft Entra ID SCIM Connector documentation.Select the name of the app that you configured in the first step, and then select ManageProvisioningStart Provisioning to begin providing attributes to the Cloud Identity Engine.
Wait until the sync is complete (Initial cycle completed), and then View provisioning details.
Verify that the synchronization was successful by confirming the timestamps (Completed and Steady state achieved) and verifying that the number of Users and Groups displays.
If the number of users and groups does not display, refer to Troubleshoot Cloud Identity Engine Issues.In the Cloud Identity Engine app, verify that the SCIM Change Timestamp for your Entra ID SCIM directory populates on the Directories page.Select ActionsFull Sync to complete a full synchronization of Microsoft Entra ID users and groups with Directory Sync for the Cloud Identity Engine.You must successfully complete a full sync in the Cloud Identity Engine app to complete the SCIM Connector setup.Configure PingFederate for SCIM Connector
Complete the following steps to configure the Cloud Identity Engine to use the SCIM Connector to connect to your PingFederate server. Be sure to complete all the steps in the PingFederate SCIM Connector documentation as well.- Set up the directory for SCIM Connector.
- Log in to the PingFederate portal and select Data Stores then click Add New Data Store.Enter a Data Store Name and select Directory (LDAP) as the Type.Enter the Hostname(s) (including the port number).Enter a valid email address as the User DN.Click Test Connection to verify the connection is successful.If the connection test isn't successful, verify that the hostname and email address are valid. Some directories, such as PingDirectory, format the User DN as cn=administrator. In this case, select Use LDAPS and use a different port number, such as 1636, instead of the default port number of 389.
Copy and edit the System ID then paste the edited value in the Cloud Identity Engine app as the Directory ID.You must edit the System ID to remove the LDAP- that precedes the Directory ID value before entering the value as the Directory ID in the Cloud Identity Engine app.
Copy and edit the User value and edit the edited value in the Cloud Identity Engine app as the Directory Name.For the Directory Name, use the domain name that follows the username in the User column (for the example below, the Directory Name is the value after Administrator@).
Provision the SCIM connection.- Select SP ConnectionsCreate Connection.Select Do not use a template for this connection.Select Outbound provisioning.Select SCIM Connector.If the SCIM Connector option isn’t available, confirm that you completed all substeps in the previous step correctly.
Select General Info and enter a Partner’s Entity ID (Connection ID) and a Connection Name.(Optional but recommended) To decrease the amount of time necessary for the initial sync, select Outbound ProvisioningConfigure ProvisioningManage ChannelsChannel ConfigurationChannel Info and increase the value for Max Threads.The range is recommended range is 1–5; for optimal sync time, Palo Alto Networks recommends 5 as the value for Max Threads.
Specify the information from the Cloud Identity Engine for the SCIM connection provisioning.- Select Outbound ProvisioningConfigure Provisioning.Select the SP Connections Target tab and enter the Base URL that you copied from the Cloud Identity Engine.
Select ApplicationsSP ConnectionsSP ConnectionConfigure ChannelsManage Channels.Select OAuth 2 Bearer Token as the Authentication Method and enter the Bearer Token that you copied from the Cloud Identity Engine as the Access Token.
Select Common Name as the Group Name Source.
Select Use patch for group updates.
Configure the channels for the SCIM connection.- Select Configure Channels and Create a channel.Enter a Name for the channel and select the directory you want to configure in the Cloud Identity Engine as the Active Data Store.Select Source Location and enter the Base DN for your directory.Enter the Group DN for the source of the user and group mappings or create a filter that specifies which entries to use. For example, Group DN:CN=Chicago,OU=Illinois,DC=example,DC=com syncs all users and groups in the Chicago group.If you use a Group DN and your directory contains nested groups, select Nested Search.Retention of nested group hierarchies from PingFederate servers through the SCIM Connector isn’t available. If your directory contains nested groups and you want to sync all of the child users and groups, you must select the method you want to use to ensure the Cloud Identity Engine correctly collects all users and groups in the parent group.
- Add the parent group as a member of a different group and use that container group as the Group DN. For example, configure the parent group in a directory with the name root in an OU with the name location and use the value CN=root,OU=location,DC=paloaltonetworks,DC=com for the Group DN.
- Add a filter that includes all members of the parent group (for example, (objectClass=user),(objectClass=group) includes all users and groups in the Base DN DC=paloaltonetworks,DC=com).
Select Attribute Mapping and Edit the userName* to userPrincipalName.
Save the connection and continue the configuration in the Cloud Identity Engine.Complete the postdeployment steps to configure the PingFederate server for the SCIM Connector.- Verify that you’ve completed all of the provisioning steps.In the PingFederate Portal, either commit a directory change or enter the following command: pingfederate/bin/provmgr.sh --reset-all -c [channel number] command.To determine the channel number, use the ./provmgr.sh --show-channels command.In the Cloud Identity Engine, verify the app populates the SCIM Change Timestamp then complete a full sync (ActionsFull Sync).
Configure Okta Directory for SCIM Connector
You must also complete the required steps in the Okta Administrator Dashboard to complete the SCIM Connector configuration. For more information, refer to the documentation for the Okta Directory.The SCIM Connector for Okta directory supports the following capabilities:- Create users
- Update user attributes
- Deactivate users
- Import users
- Import groups
- Sync password
- Group push
- Log in to your Okta Administrator Dashboard and add the integration using the Okta Integration Network.
- Log in to the Okta Administrator Dashboard, select Applications, and click Browse App Catalog.
Enter Palo Alto Networks SCIM as the search query.
Select the app and click Add Integration.
Optionally change any settings, such as the Application Label, then click Done.
Copy your Okta domain name.Configure the Okta integration to communicate with the Cloud Identity Engine.- Select Provisioning.
Click Configure API Integration.
Select Enable API integration.
Enter the URL you copied in step 4.c as the Base URL.
Enter the token you copied in step 4.d as the API Token.
Click Test API Credentials to verify the Okta Directory can successfully communicate with the Palo Alto Networks SCIM integration then click Save.
If the test is not successful, verify that you successfully submitted your configuration in the Cloud Identity Engine app in step 4.e.Assign the Okta integration to the users you want to include in your Security policy.- Edit the settings to assign Provisioning to App.
Enable all the options and Save your changes.
Select the Push Groups tab then click the Find Groups button to Find groups by name.
Type the name of a group to Push groups by name.
Select the group and Save your changes.
Verify the configuration.- In the Cloud Identity Engine app, select Directories and verify that the timestamp displays in the SCIM Change Timestamp column for the Okta SCIM directory.
Select Actions Full Sync for the directory.The configuration isn’t complete until you’ve successfully completed a full sync for the entire directory.
Configure a Custom Okta App Integration for SCIM Connector
Palo Alto Networks strongly recommends using the Okta gallery app to Configure Okta Directory for SCIM Connector. If you want to use a custom Okta app integration, complete the following steps.- Log in to your Okta Administrator Dashboard and Create an app integration.
- Select SAML 2.0 as the Sign-in method and click Next.
Enter a unique App Name and optionally enter any other information (such as an App Logo or App Visibility) then click Next.
Enter the Single-sign on URL where you want to redirect users to sign in and the Audience URI (SP Entity ID) then click Next.
Select the option that best reflects your use of the SCIM Connector app integration and click Finish.
Configure the Okta SCIM Connector app integration.- Select General (if it is not already selected) and Edit the App Settings.