Check Point Identity Awareness
Add and delete user identities on a Check Point gateway through the Identity Awareness Web API with Airgate HTTP actions, using the built-in add-identity and delete-identity presets.
Airgate can tell a Check Point Security Gateway which user and roles are behind an IP address, through the Identity Awareness Web API. Access roles on the gateway then apply to Wi-Fi and wired users signed in through Airgate. This page sets up a Check Point context server and the Check Point add identity and Check Point delete identity actions.
Status: Available as an HTTP action target, with built-in presets
for add-identity and delete-identity. The calls run from an access rule
(after the authentication decision). Automatic deletion when a network
session stops is Planned.
How it works
Section titled “How it works”| Preset | Request |
|---|---|
| Check Point add identity | POST /_IA_API/v1.0/add-identity |
| Check Point delete identity | POST /_IA_API/v1.0/delete-identity with {"shared-secret":"%{shared-secret}","ip-address":"%{ip}"} |
The add-identity body sent by the preset:
{"shared-secret":"%{shared-secret}","ip-address":"%{ip}","user":"%{user}", "machine":"%{machine}","domain":"%{domain}","session-timeout":%{timeout}, "identity-source":"Airgate","roles":["%{Tips:Role}"]}The preset fills in its own identity-source text; set it to Airgate
(or any label you want to see on the gateway).
| Reference | Value |
|---|---|
%{shared-secret} |
Action parameter, marked sensitive: the Web API client’s shared secret. Sensitive parameters are only sent to the server’s base URL. |
%{timeout} |
Action parameter, default 43200 (12 hours), in seconds |
%{ip} |
Client IP: Connection:Client-IP-Address, else the last address Airgate knows for the device |
%{user} |
Authentication:Username, else the RADIUS User-Name |
%{machine} |
The device’s host name |
%{domain} |
CONTOSO from CONTOSO\alice, or contoso.com from alice@contoso.com |
%{Tips:Role} |
The roles of the decision |
The Check Point server type defaults to None authentication (the
Web API authenticates with the shared secret in the body). Test
connection sends GET to Test path (empty = the base URL); anything
but 401, 403 or 5xx is a success.
Before you begin
Section titled “Before you begin”- A Check Point Security Gateway with the Identity Awareness blade and the Web API identity source enabled.
- Airgate’s outbound addresses allowed as Web API clients.
- An Airgate administrator with
admin:write.
Step 1: Enable the Web API on the gateway
Section titled “Step 1: Enable the Web API on the gateway”- In SmartConsole, open the gateway object › Identity Awareness, and turn on Identity Web API.
- In the Web API settings, add a client with Airgate’s outbound IP address and generate its shared secret. Copy it.
- Install the policy.
Step 2: Add the Check Point context server
Section titled “Step 2: Add the Check Point context server”-
Open Settings › Webhooks, select Context servers and Add context server.
-
Choose Check Point and fill in:
Field Value Name cp-gw1Base URL https://gw1.contoso.comAuthentication None Verify the server certificate on; paste the gateway’s CA into Trusted CA certificate(s) when it is private -
Optional: under Server parameters, add
shared-secretwith the secret from Step 1 and mark it sensitive, so every action on this server uses it. -
Save, then select Test connection.
Step 3: Add the actions
Section titled “Step 3: Add the actions”- Select Context actions and Add action.
- Under Start from a preset, pick Check Point add identity and the
Context server
cp-gw1. - Under Parameters, enter the value of
shared-secret. If the server holds the secret instead, remove the action’sshared-secretrow: an action parameter, even an empty one, overrides the server parameter of the same name. Adjusttimeout. In Body, setidentity-sourcetoAirgate. - Save. Repeat with Check Point delete identity.
- Select Test on the add action, enter a Username, a Client IP
and, under Extra attributes,
Tips:Role=Employee, then Render only and Send request.
Step 4: Run the actions from policy
Section titled “Step 4: Run the actions from policy”Create an HTTP enforcement profile per action
({"context_action_id": "<id>"}): add the add-identity profile to the
rules that admit users, and the delete-identity profile to rules that
reject or quarantine them. HTTP profiles are attached through the API; see
Webhooks and HTTP actions, Step 3.
Verify
Section titled “Verify”- On the gateway:
pdp monitor ip <client IP>shows the user with the Web API as its source. - In Airgate: Settings › Webhooks › Execution log shows the run with
HTTP
200and the gateway’s answer.
Troubleshooting
Section titled “Troubleshooting”| Symptom | Cause | Fix |
|---|---|---|
HTTP 403 or “client not allowed” |
Airgate’s address is not a Web API client. | Add the outbound address in the Web API settings and install policy. |
| Answer says the shared secret is wrong | shared-secret is empty or wrong. |
Re-enter the sensitive parameter on the action or server. |
| Identity added without an IP | The request had no client IP (see the caution above). | Use the action for guest portal logins, or for networks that send Framed-IP-Address. |
| Identities stay after users leave | Delete runs only from a rule, not on session stop. | Lower timeout, or run delete-identity from a reject rule. |