Class: RedTeamInstancesClient

Defined in: src/red-team/instances-client.ts:25

Client for Red Team instance/licensing and registry credential operations.

Constructors

Constructor

new RedTeamInstancesClient(opts): RedTeamInstancesClient;

Defined in: src/red-team/instances-client.ts:30

Parameters

Parameter	Type
`opts`	`RedTeamInstancesClientOptions`

Returns

RedTeamInstancesClient

Methods

createInstance()

createInstance(body): Promise<objectOutputType<{
  tsg_id: ZodString;
  tenant_id: ZodOptional<ZodString>;
  app_id: ZodOptional<ZodString>;
  is_success: ZodOptional<ZodBoolean>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/instances-client.ts:55

Create a new tenant instance.

Parameters

Parameter	Type	Description
`body`	`objectOutputType`	The instance creation request.

Returns

Promise<objectOutputType<{ tsg_id: ZodString; tenant_id: ZodOptional<ZodString>; app_id: ZodOptional<ZodString>; is_success: ZodOptional<ZodBoolean>; }, ZodTypeAny, "passthrough">>

The instance response.

Example

import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();

const instance = await rt.instances.createInstance({
  tsg_id: 'tsg-1',
  tenant_id: 'tenant-1',
  app_id: 'airs-redteam',
  region: 'us-east-1',
});
// instance =>
// { tsg_id: 'tsg-1', tenant_id: 'tenant-1', app_id: 'airs-redteam', is_success: true }

getInstance()

getInstance(tenantId): Promise<objectOutputType<{
  tsg_id: ZodString;
  tenant_id: ZodString;
  app_id: ZodString;
  region: ZodString;
  support_account_id: ZodOptional<ZodString>;
  support_account_name: ZodOptional<ZodString>;
  created_by: ZodOptional<ZodString>;
  internal: ZodOptional<ZodBoolean>;
  tenant_instance_name: ZodOptional<ZodString>;
  deployment_profiles: ZodOptional<ZodArray<ZodObject<{
     dAuthCode: ZodOptional<ZodString>;
     deploymentProfileId: ZodOptional<ZodString>;
     license_expiration: ZodOptional<ZodString>;
     profileName: ZodOptional<ZodString>;
     subType: ZodOptional<ZodString>;
     subscriptions: ZodOptional<ZodString>;
     type: ZodOptional<ZodString>;
     aveTextRecord: ZodDefault<ZodNumber>;
     attributes: ZodOptional<ZodArray<ZodObject<{
        quantity: ...;
        unit_of_measure: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     dAuthCode: ZodOptional<ZodString>;
     deploymentProfileId: ZodOptional<ZodString>;
     license_expiration: ZodOptional<ZodString>;
     profileName: ZodOptional<ZodString>;
     subType: ZodOptional<ZodString>;
     subscriptions: ZodOptional<ZodString>;
     type: ZodOptional<ZodString>;
     aveTextRecord: ZodDefault<ZodNumber>;
     attributes: ZodOptional<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     dAuthCode: ZodOptional<ZodString>;
     deploymentProfileId: ZodOptional<ZodString>;
     license_expiration: ZodOptional<ZodString>;
     profileName: ZodOptional<ZodString>;
     subType: ZodOptional<ZodString>;
     subscriptions: ZodOptional<ZodString>;
     type: ZodOptional<ZodString>;
     aveTextRecord: ZodDefault<ZodNumber>;
     attributes: ZodOptional<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>;
  }, ZodTypeAny, "passthrough">>, "many">>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/instances-client.ts:81

Get an existing tenant instance.

Parameters

Parameter	Type	Description
`tenantId`	`string`	The tenant ID.

Returns

Promise<objectOutputType<{ tsg_id: ZodString; tenant_id: ZodString; app_id: ZodString; region: ZodString; support_account_id: ZodOptional<ZodString>; support_account_name: ZodOptional<ZodString>; created_by: ZodOptional<ZodString>; internal: ZodOptional<ZodBoolean>; tenant_instance_name: ZodOptional<ZodString>; deployment_profiles: ZodOptional<ZodArray<ZodObject<{ dAuthCode: ZodOptional<ZodString>; deploymentProfileId: ZodOptional<ZodString>; license_expiration: ZodOptional<ZodString>; profileName: ZodOptional<ZodString>; subType: ZodOptional<ZodString>; subscriptions: ZodOptional<ZodString>; type: ZodOptional<ZodString>; aveTextRecord: ZodDefault<ZodNumber>; attributes: ZodOptional<ZodArray<ZodObject<{ quantity: ...; unit_of_measure: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>; }, "passthrough", ZodTypeAny, objectOutputType<{ dAuthCode: ZodOptional<ZodString>; deploymentProfileId: ZodOptional<ZodString>; license_expiration: ZodOptional<ZodString>; profileName: ZodOptional<ZodString>; subType: ZodOptional<ZodString>; subscriptions: ZodOptional<ZodString>; type: ZodOptional<ZodString>; aveTextRecord: ZodDefault<ZodNumber>; attributes: ZodOptional<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>; }, ZodTypeAny, "passthrough">, objectInputType<{ dAuthCode: ZodOptional<ZodString>; deploymentProfileId: ZodOptional<ZodString>; license_expiration: ZodOptional<ZodString>; profileName: ZodOptional<ZodString>; subType: ZodOptional<ZodString>; subscriptions: ZodOptional<ZodString>; type: ZodOptional<ZodString>; aveTextRecord: ZodDefault<ZodNumber>; attributes: ZodOptional<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>; }, ZodTypeAny, "passthrough">>, "many">>; }, ZodTypeAny, "passthrough">>

The instance details.

Example

import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();

const instance = await rt.instances.getInstance('tenant-1');
// instance =>
// { tsg_id: 'tsg-1', tenant_id: 'tenant-1', app_id: 'airs-redteam', region: 'us-east-1' }

updateInstance()

updateInstance(tenantId, body): Promise<objectOutputType<{
  tsg_id: ZodString;
  tenant_id: ZodOptional<ZodString>;
  app_id: ZodOptional<ZodString>;
  is_success: ZodOptional<ZodBoolean>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/instances-client.ts:112

Update an existing tenant instance.

Parameters

Parameter	Type	Description
`tenantId`	`string`	The tenant ID.
`body`	`objectOutputType`	The instance update request.

Returns

The instance response.

Example

import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();

const instance = await rt.instances.updateInstance('tenant-1', {
  tsg_id: 'tsg-1',
  tenant_id: 'tenant-1',
  app_id: 'airs-redteam',
  region: 'us-west-2',
});
// instance =>
// { tsg_id: 'tsg-1', tenant_id: 'tenant-1', is_success: true }

deleteInstance()

deleteInstance(tenantId): Promise<objectOutputType<{
  tsg_id: ZodString;
  tenant_id: ZodOptional<ZodString>;
  app_id: ZodOptional<ZodString>;
  is_success: ZodOptional<ZodBoolean>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/instances-client.ts:138

Delete a tenant instance.

Parameters

Parameter	Type	Description
`tenantId`	`string`	The tenant ID.

Returns

The instance response.

Example

import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();

const result = await rt.instances.deleteInstance('tenant-1');
// result =>
// { tsg_id: 'tsg-1', tenant_id: 'tenant-1', is_success: true }

createDevices()

createDevices(tenantId, body): Promise<objectOutputType<{
  devices: ZodOptional<ZodArray<ZodObject<{
     status: ZodString;
     error: ZodOptional<ZodString>;
     serial_number: ZodOptional<ZodString>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     status: ZodString;
     error: ZodOptional<ZodString>;
     serial_number: ZodOptional<ZodString>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     status: ZodString;
     error: ZodOptional<ZodString>;
     serial_number: ZodOptional<ZodString>;
  }, ZodTypeAny, "passthrough">>, "many">>;
  status: ZodOptional<ZodString>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/instances-client.ts:167

Create devices for a tenant instance.

Parameters

Parameter	Type	Description
`tenantId`	`string`	The tenant ID.
`body`	`objectOutputType`	The device creation request.

Returns

Promise<objectOutputType<{ devices: ZodOptional<ZodArray<ZodObject<{ status: ZodString; error: ZodOptional<ZodString>; serial_number: ZodOptional<ZodString>; }, "passthrough", ZodTypeAny, objectOutputType<{ status: ZodString; error: ZodOptional<ZodString>; serial_number: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">, objectInputType<{ status: ZodString; error: ZodOptional<ZodString>; serial_number: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">>, "many">>; status: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">>

The device response with statuses.

Example

import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();

const result = await rt.instances.createDevices('tenant-1', {
  instance: { app_id: 'airs-redteam', region: 'us-east-1', tenant_id: 'tenant-1', tsg_id: 'tsg-1' },
  devices: [{ serial_number: 'SN-0001' }],
});
// result =>
// { devices: [{ serial_number: 'SN-0001', status: 'CREATED' }] }

updateDevices()

updateDevices(tenantId, body): Promise<objectOutputType<{
  devices: ZodOptional<ZodArray<ZodObject<{
     status: ZodString;
     error: ZodOptional<ZodString>;
     serial_number: ZodOptional<ZodString>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     status: ZodString;
     error: ZodOptional<ZodString>;
     serial_number: ZodOptional<ZodString>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     status: ZodString;
     error: ZodOptional<ZodString>;
     serial_number: ZodOptional<ZodString>;
  }, ZodTypeAny, "passthrough">>, "many">>;
  status: ZodOptional<ZodString>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/instances-client.ts:197

Update devices for a tenant instance.

Parameters

Parameter	Type	Description
`tenantId`	`string`	The tenant ID.
`body`	`objectOutputType`	The device update request.

Returns

The device response with statuses.

Example

import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();

const result = await rt.instances.updateDevices('tenant-1', {
  instance: { app_id: 'airs-redteam', region: 'us-east-1', tenant_id: 'tenant-1', tsg_id: 'tsg-1' },
  devices: [{ serial_number: 'SN-0001', device_name: 'renamed' }],
});
// result =>
// { devices: [{ serial_number: 'SN-0001', status: 'UPDATED' }] }

deleteDevices()

deleteDevices(tenantId, serialNumbers): Promise<objectOutputType<{
  devices: ZodOptional<ZodArray<ZodObject<{
     status: ZodString;
     error: ZodOptional<ZodString>;
     serial_number: ZodOptional<ZodString>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     status: ZodString;
     error: ZodOptional<ZodString>;
     serial_number: ZodOptional<ZodString>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     status: ZodString;
     error: ZodOptional<ZodString>;
     serial_number: ZodOptional<ZodString>;
  }, ZodTypeAny, "passthrough">>, "many">>;
  status: ZodOptional<ZodString>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/instances-client.ts:224

Delete devices from a tenant instance.

Parameters

Parameter	Type	Description
`tenantId`	`string`	The tenant ID.
`serialNumbers`	`string`	Comma-separated serial numbers to delete.

Returns

The device response with statuses.

Example

import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();

const result = await rt.instances.deleteDevices('tenant-1', 'SN-0001,SN-0002');
// result =>
// { devices: [{ serial_number: 'SN-0001', status: 'DELETED' }] }

getRegistryCredentials()

getRegistryCredentials(): Promise<objectOutputType<{
  token: ZodString;
  expiry: ZodString;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/instances-client.ts:249

Get or create registry credentials.

Returns

Promise<objectOutputType<{ token: ZodString; expiry: ZodString; }, ZodTypeAny, "passthrough">>

The registry credentials with token and expiry.

Example

import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();

const creds = await rt.instances.getRegistryCredentials();
// creds =>
// { token: 'eyJ...', expiry: '2025-01-01T00:00:00Z' }

Constructors​

Constructor​

Parameters​

Returns​

Methods​

createInstance()​

Parameters​

Returns​

Example​

getInstance()​

Parameters​

Returns​

Example​

updateInstance()​

Parameters​

Returns​

Example​

deleteInstance()​

Parameters​

Returns​

Example​

createDevices()​

Parameters​

Returns​

Example​

updateDevices()​

Parameters​

Returns​

Example​

deleteDevices()​

Parameters​

Returns​

Example​

getRegistryCredentials()​

Returns​

Example​

Constructors

Constructor

Parameters

Returns

Methods

createInstance()

Parameters

Returns

Example

getInstance()

Parameters

Returns

Example

updateInstance()

Parameters

Returns

Example

deleteInstance()

Parameters

Returns

Example

createDevices()

Parameters

Returns

Example

updateDevices()

Parameters

Returns

Example

deleteDevices()

Parameters

Returns

Example

getRegistryCredentials()

Returns

Example