Class: ApiKeysClient

Defined in: src/management/api-keys.ts:25

Client for AIRS API key management operations.

Constructors

Constructor

new ApiKeysClient(opts): ApiKeysClient;

Defined in: src/management/api-keys.ts:31

Parameters

Parameter	Type
`opts`	`ApiKeysClientOptions`

Returns

ApiKeysClient

Methods

create()

create(body): Promise<objectOutputType<{
  api_key_id: ZodString;
  api_key_last8: ZodString;
  api_key_name: ZodOptional<ZodString>;
  auth_code: ZodString;
  csp_id: ZodOptional<ZodString>;
  tsg_id: ZodOptional<ZodString>;
  expiration: ZodString;
  revoked: ZodBoolean;
  revoke_reason: ZodOptional<ZodString>;
  cust_app: ZodOptional<ZodString>;
  cust_env: ZodOptional<ZodString>;
  cust_ai_agent_framework: ZodOptional<ZodString>;
  cust_cloud_provider: ZodOptional<ZodString>;
  created_by: ZodOptional<ZodString>;
  updated_by: ZodOptional<ZodString>;
  last_modified_ts: ZodOptional<ZodString>;
  rotation_time_interval: ZodOptional<ZodNumber>;
  rotation_time_unit: ZodOptional<ZodString>;
  dp_name: ZodOptional<ZodString>;
  status: ZodOptional<ZodString>;
  api_key: ZodOptional<ZodString>;
  lic_expiration: ZodOptional<ZodString>;
  avg_text_records: ZodOptional<ZodNumber>;
  creation_ts: ZodOptional<ZodString>;
  customer_appId: ZodOptional<ZodString>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/management/api-keys.ts:61

Create a new API key.

Parameters

Parameter	Type	Description
`body`	`objectOutputType`	API key creation request.

Returns

Promise<objectOutputType<{ api_key_id: ZodString; api_key_last8: ZodString; api_key_name: ZodOptional<ZodString>; auth_code: ZodString; csp_id: ZodOptional<ZodString>; tsg_id: ZodOptional<ZodString>; expiration: ZodString; revoked: ZodBoolean; revoke_reason: ZodOptional<ZodString>; cust_app: ZodOptional<ZodString>; cust_env: ZodOptional<ZodString>; cust_ai_agent_framework: ZodOptional<ZodString>; cust_cloud_provider: ZodOptional<ZodString>; created_by: ZodOptional<ZodString>; updated_by: ZodOptional<ZodString>; last_modified_ts: ZodOptional<ZodString>; rotation_time_interval: ZodOptional<ZodNumber>; rotation_time_unit: ZodOptional<ZodString>; dp_name: ZodOptional<ZodString>; status: ZodOptional<ZodString>; api_key: ZodOptional<ZodString>; lic_expiration: ZodOptional<ZodString>; avg_text_records: ZodOptional<ZodNumber>; creation_ts: ZodOptional<ZodString>; customer_appId: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">>

The created API key.

Example

import { ManagementClient } from '@cdot65/prisma-airs-sdk';
const mgmt = new ManagementClient(); // reads PANW_MGMT_* env vars

const key = await mgmt.apiKeys.create({
  auth_code: 'ac',
  cust_app: 'app1',
  revoked: false,
  created_by: 'user@example.com',
  api_key_name: 'key1',
  rotation_time_interval: 90,
  rotation_time_unit: 'days',
});
// key =>
// { api_key_id: 'k1', api_key_last8: '12345678', auth_code: 'ac',
//   expiration: '2025-12-31', revoked: false }

list()

list(opts?): Promise<objectOutputType<{
  api_keys: ZodOptional<ZodArray<ZodObject<{
     api_key_id: ZodString;
     api_key_last8: ZodString;
     api_key_name: ZodOptional<ZodString>;
     auth_code: ZodString;
     csp_id: ZodOptional<ZodString>;
     tsg_id: ZodOptional<ZodString>;
     expiration: ZodString;
     revoked: ZodBoolean;
     revoke_reason: ZodOptional<ZodString>;
     cust_app: ZodOptional<ZodString>;
     cust_env: ZodOptional<ZodString>;
     cust_ai_agent_framework: ZodOptional<ZodString>;
     cust_cloud_provider: ZodOptional<ZodString>;
     created_by: ZodOptional<ZodString>;
     updated_by: ZodOptional<ZodString>;
     last_modified_ts: ZodOptional<ZodString>;
     rotation_time_interval: ZodOptional<ZodNumber>;
     rotation_time_unit: ZodOptional<ZodString>;
     dp_name: ZodOptional<ZodString>;
     status: ZodOptional<ZodString>;
     api_key: ZodOptional<ZodString>;
     lic_expiration: ZodOptional<ZodString>;
     avg_text_records: ZodOptional<ZodNumber>;
     creation_ts: ZodOptional<ZodString>;
     customer_appId: ZodOptional<ZodString>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     api_key_id: ZodString;
     api_key_last8: ZodString;
     api_key_name: ZodOptional<ZodString>;
     auth_code: ZodString;
     csp_id: ZodOptional<ZodString>;
     tsg_id: ZodOptional<ZodString>;
     expiration: ZodString;
     revoked: ZodBoolean;
     revoke_reason: ZodOptional<ZodString>;
     cust_app: ZodOptional<ZodString>;
     cust_env: ZodOptional<ZodString>;
     cust_ai_agent_framework: ZodOptional<ZodString>;
     cust_cloud_provider: ZodOptional<ZodString>;
     created_by: ZodOptional<ZodString>;
     updated_by: ZodOptional<ZodString>;
     last_modified_ts: ZodOptional<ZodString>;
     rotation_time_interval: ZodOptional<ZodNumber>;
     rotation_time_unit: ZodOptional<ZodString>;
     dp_name: ZodOptional<ZodString>;
     status: ZodOptional<ZodString>;
     api_key: ZodOptional<ZodString>;
     lic_expiration: ZodOptional<ZodString>;
     avg_text_records: ZodOptional<ZodNumber>;
     creation_ts: ZodOptional<ZodString>;
     customer_appId: ZodOptional<ZodString>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     api_key_id: ZodString;
     api_key_last8: ZodString;
     api_key_name: ZodOptional<ZodString>;
     auth_code: ZodString;
     csp_id: ZodOptional<ZodString>;
     tsg_id: ZodOptional<ZodString>;
     expiration: ZodString;
     revoked: ZodBoolean;
     revoke_reason: ZodOptional<ZodString>;
     cust_app: ZodOptional<ZodString>;
     cust_env: ZodOptional<ZodString>;
     cust_ai_agent_framework: ZodOptional<ZodString>;
     cust_cloud_provider: ZodOptional<ZodString>;
     created_by: ZodOptional<ZodString>;
     updated_by: ZodOptional<ZodString>;
     last_modified_ts: ZodOptional<ZodString>;
     rotation_time_interval: ZodOptional<ZodNumber>;
     rotation_time_unit: ZodOptional<ZodString>;
     dp_name: ZodOptional<ZodString>;
     status: ZodOptional<ZodString>;
     api_key: ZodOptional<ZodString>;
     lic_expiration: ZodOptional<ZodString>;
     avg_text_records: ZodOptional<ZodNumber>;
     creation_ts: ZodOptional<ZodString>;
     customer_appId: ZodOptional<ZodString>;
  }, ZodTypeAny, "passthrough">>, "many">>;
  next_offset: ZodOptional<ZodNumber>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/management/api-keys.ts:88

List API keys for the TSG.

Parameters

Parameter	Type	Description
`opts?`	`PaginationOptions`	Pagination options.

Returns

Promise<objectOutputType<{ api_keys: ZodOptional<ZodArray<ZodObject<{ api_key_id: ZodString; api_key_last8: ZodString; api_key_name: ZodOptional<ZodString>; auth_code: ZodString; csp_id: ZodOptional<ZodString>; tsg_id: ZodOptional<ZodString>; expiration: ZodString; revoked: ZodBoolean; revoke_reason: ZodOptional<ZodString>; cust_app: ZodOptional<ZodString>; cust_env: ZodOptional<ZodString>; cust_ai_agent_framework: ZodOptional<ZodString>; cust_cloud_provider: ZodOptional<ZodString>; created_by: ZodOptional<ZodString>; updated_by: ZodOptional<ZodString>; last_modified_ts: ZodOptional<ZodString>; rotation_time_interval: ZodOptional<ZodNumber>; rotation_time_unit: ZodOptional<ZodString>; dp_name: ZodOptional<ZodString>; status: ZodOptional<ZodString>; api_key: ZodOptional<ZodString>; lic_expiration: ZodOptional<ZodString>; avg_text_records: ZodOptional<ZodNumber>; creation_ts: ZodOptional<ZodString>; customer_appId: ZodOptional<ZodString>; }, "passthrough", ZodTypeAny, objectOutputType<{ api_key_id: ZodString; api_key_last8: ZodString; api_key_name: ZodOptional<ZodString>; auth_code: ZodString; csp_id: ZodOptional<ZodString>; tsg_id: ZodOptional<ZodString>; expiration: ZodString; revoked: ZodBoolean; revoke_reason: ZodOptional<ZodString>; cust_app: ZodOptional<ZodString>; cust_env: ZodOptional<ZodString>; cust_ai_agent_framework: ZodOptional<ZodString>; cust_cloud_provider: ZodOptional<ZodString>; created_by: ZodOptional<ZodString>; updated_by: ZodOptional<ZodString>; last_modified_ts: ZodOptional<ZodString>; rotation_time_interval: ZodOptional<ZodNumber>; rotation_time_unit: ZodOptional<ZodString>; dp_name: ZodOptional<ZodString>; status: ZodOptional<ZodString>; api_key: ZodOptional<ZodString>; lic_expiration: ZodOptional<ZodString>; avg_text_records: ZodOptional<ZodNumber>; creation_ts: ZodOptional<ZodString>; customer_appId: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">, objectInputType<{ api_key_id: ZodString; api_key_last8: ZodString; api_key_name: ZodOptional<ZodString>; auth_code: ZodString; csp_id: ZodOptional<ZodString>; tsg_id: ZodOptional<ZodString>; expiration: ZodString; revoked: ZodBoolean; revoke_reason: ZodOptional<ZodString>; cust_app: ZodOptional<ZodString>; cust_env: ZodOptional<ZodString>; cust_ai_agent_framework: ZodOptional<ZodString>; cust_cloud_provider: ZodOptional<ZodString>; created_by: ZodOptional<ZodString>; updated_by: ZodOptional<ZodString>; last_modified_ts: ZodOptional<ZodString>; rotation_time_interval: ZodOptional<ZodNumber>; rotation_time_unit: ZodOptional<ZodString>; dp_name: ZodOptional<ZodString>; status: ZodOptional<ZodString>; api_key: ZodOptional<ZodString>; lic_expiration: ZodOptional<ZodString>; avg_text_records: ZodOptional<ZodNumber>; creation_ts: ZodOptional<ZodString>; customer_appId: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">>, "many">>; next_offset: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">>

Paginated list of API keys.

Example

import { ManagementClient } from '@cdot65/prisma-airs-sdk';
const mgmt = new ManagementClient(); // reads PANW_MGMT_* env vars

const page = await mgmt.apiKeys.list({ offset: 0, limit: 5 });
// page =>
// { api_keys: [ { api_key_id: 'k1', api_key_last8: '12345678',
//     auth_code: 'ac', expiration: '2025-12-31', revoked: false } ], next_offset: 10 }

delete()

delete(apiKeyName, updatedBy): Promise<
  | {
  message: string;
}
  | objectOutputType<{
  message: ZodOptional<ZodString>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/management/api-keys.ts:119

Delete an API key by name.

Parameters

Parameter	Type	Description
`apiKeyName`	`string`	Name of the API key to delete.
`updatedBy`	`string`	Email of user performing the deletion.

Returns

Promise< | { message: string; } | objectOutputType<{ message: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">>

Deletion confirmation.

Example

import { ManagementClient } from '@cdot65/prisma-airs-sdk';
const mgmt = new ManagementClient(); // reads PANW_MGMT_* env vars

const result = await mgmt.apiKeys.delete('key1', 'user@example.com');
// result => { message: 'deleted' }

regenerate()

regenerate(apiKeyId, body): Promise<objectOutputType<{
  api_key_id: ZodString;
  api_key_last8: ZodString;
  api_key_name: ZodOptional<ZodString>;
  auth_code: ZodString;
  csp_id: ZodOptional<ZodString>;
  tsg_id: ZodOptional<ZodString>;
  expiration: ZodString;
  revoked: ZodBoolean;
  revoke_reason: ZodOptional<ZodString>;
  cust_app: ZodOptional<ZodString>;
  cust_env: ZodOptional<ZodString>;
  cust_ai_agent_framework: ZodOptional<ZodString>;
  cust_cloud_provider: ZodOptional<ZodString>;
  created_by: ZodOptional<ZodString>;
  updated_by: ZodOptional<ZodString>;
  last_modified_ts: ZodOptional<ZodString>;
  rotation_time_interval: ZodOptional<ZodNumber>;
  rotation_time_unit: ZodOptional<ZodString>;
  dp_name: ZodOptional<ZodString>;
  status: ZodOptional<ZodString>;
  api_key: ZodOptional<ZodString>;
  lic_expiration: ZodOptional<ZodString>;
  avg_text_records: ZodOptional<ZodNumber>;
  creation_ts: ZodOptional<ZodString>;
  customer_appId: ZodOptional<ZodString>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/management/api-keys.ts:150

Regenerate an API key.

Parameters

Parameter	Type	Description
`apiKeyId`	`string`	UUID of the API key to regenerate.
`body`	`objectOutputType`	Regeneration request with rotation config.

Returns

The regenerated API key.

Example

import { ManagementClient } from '@cdot65/prisma-airs-sdk';
const mgmt = new ManagementClient(); // reads PANW_MGMT_* env vars

const key = await mgmt.apiKeys.regenerate('k1', {
  rotation_time_interval: 30,
  rotation_time_unit: 'days',
});
// key =>
// { api_key_id: 'k1', api_key_last8: '87654321', auth_code: 'ac',
//   expiration: '2026-06-30', revoked: false }

Constructors​

Constructor​

Parameters​

Returns​

Methods​

create()​

Parameters​

Returns​

Example​

list()​

Parameters​

Returns​

Example​

delete()​

Parameters​

Returns​

Example​

regenerate()​

Parameters​

Returns​

Example​

Constructors

Constructor

Parameters

Returns

Methods

create()

Parameters

Returns

Example

list()

Parameters

Returns

Example

delete()

Parameters

Returns

Example

regenerate()

Parameters

Returns

Example