Check Point - AI Security JS/TS SDK

Draft — This SDK is under active development and is not yet production-ready. APIs may change without notice.

This is the AI Security SDK for JavaScript/TypeScript ecosystem.

The SDK is based on the public AI Security OpenAPI specifications.

With the SDK, you do not have to manage log in, send keep alive requests, or worry about session expiration.

The AI Security SDK supports simultaneous instances with different tenants.

SDK installation

npm install @chkp/ai-security-sdk

Getting started

First, import the AISecurity object from the package.

import { AISecurity } from '@chkp/ai-security-sdk';

Then, create a new instance of AISecurity, which provides CloudInfra API credentials and a gateway to connect to.

Obtaining API credentials

1. Go to the Infinity Portal API Keys page.
2. Click New > New Account API Key.
3. In the Service dropdown select Workforce AI Security and create the key.
4. Copy the Client ID, Secret Key, and Authentication URL (gateway).

For more information, see Infinity Portal Administration Guide.

Available gateways

| Region | Gateway URL | |---|---| | Europe | https://cloudinfra-gw.portal.checkpoint.com | | United States | https://cloudinfra-gw-us.portal.checkpoint.com |

Once the Client ID, Secret Key, and Authentication URL are obtained, AI Security SDK can be used.

All API operations can be explored with the AISecurity instance, notice to the documentation on each API operation, what and where are the arguments it requires.

All APIs can be also explored in SwaggerHub

A complete example:

import { AISecurity } from '@chkp/ai-security-sdk';

// Create a new instance of AISecurity (we do support multiple instances in parallel)
const ai = new AISecurity();

// Connect to AI Security service using CloudInfra API credentials
await ai.connect({
    clientId: 'place here your CI client-id',     // The "Client ID"
    accessKey: 'place here your CI access-key',   // The "Secret Key"
    gateway: 'https://cloudinfra-gw-us.portal.checkpoint.com', // The "Authentication URL" (without /auth/external)
});

// Query the API operations
const rulebase = await ai.chatsPolicyApi.getChatsRulebaseExternalV1ChatsRulebaseGet();
console.log(rulebase.data);

// Once finish, disconnect to stop all background session management.
ai.disconnect();

Troubleshooting and logging

The full version and build info of the SDK is available by AISecurity.info() see example:

console.log(AISecurity.info());
// sdk_build:"9728283", sdk_version:"1.0.0", spec:"checkpoint-ai-security", spec_version:"1.0.0", released_on:"2024-01-01T00:00:00"

AI Security JS/TS SDK uses the debug package for logging.

There are 3 loggers, for general info, errors and to inspect network.

As default they will be disabled, in order to enable logging, set the DEBUG environment variable before running:

DEBUG="chkp_ai_security_sdk:*"

And for a specific/s logger set the logger name followed by a comma as following:

DEBUG="chkp_ai_security_sdk:info,chkp_ai_security_sdk:error,chkp_ai_security_sdk:network"

All Check Point AI Security API tools

| Tool | Package | |---|---| | Python SDK | chkp-ai-security-sdk | | JS/TS SDK | @chkp/ai-security-sdk | | OpenAPI Spec | SwaggerHub |

Report Bug

In case of an issue or a bug found in the SDK, please open an issue.

Contributors

• Haim Kastner - [email protected]