Manage the pairing API key
Learn to manage pairing access control and configure API key permissions and data scope in Cortex XSIAM.
When a main tenant and a child tenant are paired, a new pairing API key with a Pairing Key role is created on the child tenant. You can change the role and edit the scope of the API key.
Prerequisites
Verify that you are an Instance Administrator or Account Admin for the child tenant.
Verify that your tenant has an active pairing. Go to Settings > Configuration > Tenant Management and confirm that a parent tenant appears with a Paired status. Pairing access control only affects the pairing API key created when a parent tenant pairs with your tenant.
Edit the API key access scope
Go to Settings > Configuration > API Keys.
Locate the pairing key, identified by its system-generated comment and System security level.
Right click to Edit the key.
Update the key's Scope-Based Access Control (SBAC) scope to restrict which assets, cases and issues, and dataset rows the parent tenant can access.
Change the assigned role for the API key
You can change the role assigned to the API pairing key. The default Pairing Key role is a system role and cannot be edited. You can duplicate the Pairing Key role, edit the permissions for the duplicated role, and then update the role in the API key settings. You can also assign any existing role to the API key. To change the assigned role:
Go to Settings > Configuration > API Keys.
Locate the pairing key, identified by its system-generated comment and System security level.
Right click to Edit the key.
In the Roles field, select a different role.
Save your changes.
Troubleshooting
Problem
Likely Cause
What to Do
The pairing key still has the administrator role after pairing access control was enabled
Pairing access control doesn't change the role of an existing pairing key. Existing pairing keys, which were previously hidden, become visible in the API Keys table once the feature is enabled.
Edit the existing pairing key directly: go to Settings > Configuration > API Keys, locate the key, and change its role to Pairing Key or another role of your choice.
A new pairing attempt failed, and I don't see a pairing key at all
If an error occurs after the pairing key is generated (for example, a scope-seeding failure or an expired pairing request), Cortex automatically removes the orphaned key.
Retry the pairing request. If the issue persists, contact Palo Alto Networks Customer Support.
Last updated
Was this helpful?
