Class: SdkRedTeamService¶

Defined in: src/airs/redteam.ts:116

Wraps the SDK's RedTeamClient to implement RedTeamService. Provides scan creation, status polling, report retrieval, and target/category listing.

Implements¶

RedTeamService

Constructors¶

Constructor¶

new SdkRedTeamService(opts?): SdkRedTeamService

Defined in: src/airs/redteam.ts:119

Parameters¶

opts?¶

RedTeamClientOptions

Returns¶

SdkRedTeamService

Methods¶

abortScan()¶

abortScan(jobId): Promise\<void>

Defined in: src/airs/redteam.ts:395

Abort a running scan.

Parameters¶

jobId¶

string

Returns¶

Promise\<void>

Implementation of¶

RedTeamService.abortScan

acceptEula()¶

acceptEula(eulaContent): Promise\<EulaStatus>

Defined in: src/airs/redteam.ts:137

Accept the EULA.

Parameters¶

eulaContent¶

string

Returns¶

Promise\<EulaStatus>

Implementation of¶

RedTeamService.acceptEula

createDevices()¶

createDevices(tenantId, request): Promise\<Record\<string, unknown>>

Defined in: src/airs/redteam.ts:199

Create devices for an instance.

Parameters¶

tenantId¶

string

request¶

Record\<string, unknown>

Returns¶

Promise\<Record\<string, unknown>>

Implementation of¶

RedTeamService.createDevices

createInstance()¶

createInstance(request): Promise\<InstanceResponse>

Defined in: src/airs/redteam.ts:149

Create an instance.

Parameters¶

request¶

InstanceRequest

Returns¶

Promise\<InstanceResponse>

Implementation of¶

RedTeamService.createInstance

createScan()¶

createScan(request): Promise\<RedTeamJob>

Defined in: src/airs/redteam.ts:338

Create a red team scan job.

Parameters¶

request¶

attackGoals?¶

string[]

categories?¶

Record\<string, unknown>

customPromptSets?¶

string[]

jobType¶

string

name¶

string

streamBreadth?¶

number

streamDepth?¶

number

targetUuid¶

string

Returns¶

Promise\<RedTeamJob>

Implementation of¶

RedTeamService.createScan

createTarget()¶

createTarget(request, opts?): Promise\<RedTeamTargetDetail>

Defined in: src/airs/redteam.ts:294

Create a red team target.

Parameters¶

deleteDevices()¶

deleteDevices(tenantId, serialNumbers): Promise\<Record\<string, unknown>>

Defined in: src/airs/redteam.ts:219

Delete devices by serial numbers.

Parameters¶

tenantId¶

string

serialNumbers¶

string

Returns¶

Promise\<Record\<string, unknown>>

Implementation of¶

RedTeamService.deleteDevices

deleteInstance()¶

deleteInstance(tenantId): Promise\<InstanceResponse>

Defined in: src/airs/redteam.ts:189

Delete an instance.

Parameters¶

tenantId¶

string

Returns¶

Promise\<InstanceResponse>

Implementation of¶

RedTeamService.deleteInstance

deleteTarget()¶

deleteTarget(uuid): Promise\<void>

Defined in: src/airs/redteam.ts:311

Delete a red team target.

Parameters¶

uuid¶

string

Returns¶

Promise\<void>

Implementation of¶

RedTeamService.deleteTarget

getCategories()¶

getCategories(): Promise\<RedTeamCategory[]>

Defined in: src/airs/redteam.ts:495

List available attack categories.

Returns¶

Promise\<RedTeamCategory[]>

Implementation of¶

RedTeamService.getCategories

getCustomReport()¶

getCustomReport(jobId): Promise\<RedTeamCustomReport>

Defined in: src/airs/redteam.ts:432

Get custom attack report.

Parameters¶

jobId¶

string

Returns¶

Promise\<RedTeamCustomReport>

Implementation of¶

RedTeamService.getCustomReport

getEulaContent()¶

getEulaContent(): Promise\<EulaContent>

Defined in: src/airs/redteam.ts:123

Get EULA content.

Returns¶

Promise\<EulaContent>

Implementation of¶

RedTeamService.getEulaContent

getEulaStatus()¶

getEulaStatus(): Promise\<EulaStatus>

Defined in: src/airs/redteam.ts:128

Get EULA acceptance status.

Returns¶

Promise\<EulaStatus>

Implementation of¶

RedTeamService.getEulaStatus

getInstance()¶

getInstance(tenantId): Promise\<InstanceDetail>

Defined in: src/airs/redteam.ts:164

Get instance details.

Parameters¶

tenantId¶

string

Returns¶

Promise\<InstanceDetail>

Implementation of¶

RedTeamService.getInstance

getRegistryCredentials()¶

getRegistryCredentials(): Promise\<RegistryCredentials>

Defined in: src/airs/redteam.ts:226

Get or create registry credentials.

Returns¶

Promise\<RegistryCredentials>

Implementation of¶

RedTeamService.getRegistryCredentials

getScan()¶

getScan(jobId): Promise\<RedTeamJob>

Defined in: src/airs/redteam.ts:372

Get scan status by job ID.

Parameters¶

jobId¶

string

Returns¶

Promise\<RedTeamJob>

Implementation of¶

RedTeamService.getScan

getStaticReport()¶

getStaticReport(jobId): Promise\<RedTeamStaticReport>

Defined in: src/airs/redteam.ts:399

Get static scan report.

Parameters¶

jobId¶

string

Returns¶

Promise\<RedTeamStaticReport>

Implementation of¶

RedTeamService.getStaticReport

getTarget()¶

getTarget(uuid): Promise\<RedTeamTargetDetail>

Defined in: src/airs/redteam.ts:289

Get target details.

Parameters¶

uuid¶

string

Returns¶

Promise\<RedTeamTargetDetail>

Implementation of¶

RedTeamService.getTarget

getTargetMetadata()¶

getTargetMetadata(): Promise\<Record\<string, unknown>>

Defined in: src/airs/redteam.ts:253

Get target field metadata.

Returns¶

Promise\<Record\<string, unknown>>

Implementation of¶

RedTeamService.getTargetMetadata

getTargetProfile()¶

getTargetProfile(uuid): Promise\<Record\<string, unknown>>

Defined in: src/airs/redteam.ts:325

Get target profile.

Parameters¶

uuid¶

string

Returns¶

Promise\<Record\<string, unknown>>

Implementation of¶

RedTeamService.getTargetProfile

getTargetTemplates()¶

getTargetTemplates(): Promise\<Record\<string, unknown>>

Defined in: src/airs/redteam.ts:257

Get provider-specific target templates.

Returns¶

Promise\<Record\<string, unknown>>

Implementation of¶

RedTeamService.getTargetTemplates

listAttacks()¶

listAttacks(jobId, opts?): Promise\<{ attacks: RedTeamAttack[]; totalItems?: number; }>

Defined in: src/airs/redteam.ts:454

List attacks from a static/dynamic scan.

Parameters¶

jobId¶

string

opts?¶

limit?¶

number

severity?¶

string

Returns¶

Promise\<{ attacks: RedTeamAttack[]; totalItems?: number; }>

Implementation of¶

RedTeamService.listAttacks

listCustomAttacks()¶

listCustomAttacks(jobId, opts?): Promise\<RedTeamCustomAttack[]>

Defined in: src/airs/redteam.ts:478

List attacks from a custom prompt set scan.

Parameters¶

jobId¶

string

opts?¶

limit?¶

number

Returns¶

Promise\<RedTeamCustomAttack[]>

Implementation of¶

RedTeamService.listCustomAttacks

listScans()¶

listScans(opts?): Promise\<RedTeamJob[]>

Defined in: src/airs/redteam.ts:377

List recent scans with optional filters.

Parameters¶

opts?¶

jobType?¶

string

limit?¶

number

status?¶

string

targetId?¶

string

Returns¶

Promise\<RedTeamJob[]>

Implementation of¶

RedTeamService.listScans

listTargets()¶

listTargets(): Promise\<RedTeamTarget[]>

Defined in: src/airs/redteam.ts:261

List configured red team targets.

Returns¶

Promise\<RedTeamTarget[]>

Implementation of¶

RedTeamService.listTargets

probeTarget()¶

probeTarget(request): Promise\<Record\<string, unknown>>

Defined in: src/airs/redteam.ts:315

Probe a target connection.

Parameters¶

request¶

Record\<string, unknown>

Returns¶

Promise\<Record\<string, unknown>>

Implementation of¶

RedTeamService.probeTarget

updateDevices()¶

updateDevices(tenantId, request): Promise\<Record\<string, unknown>>

Defined in: src/airs/redteam.ts:209

Update devices (PATCH).

Parameters¶

tenantId¶

string

request¶

Record\<string, unknown>

Returns¶

Promise\<Record\<string, unknown>>

Implementation of¶

RedTeamService.updateDevices

updateInstance()¶

updateInstance(tenantId, request): Promise\<InstanceResponse>

Defined in: src/airs/redteam.ts:174

Update an instance.

Parameters¶

tenantId¶

string

request¶

InstanceRequest

Returns¶

Promise\<InstanceResponse>

Implementation of¶

RedTeamService.updateInstance

updateTarget()¶

updateTarget(uuid, request, opts?): Promise\<RedTeamTargetDetail>

Defined in: src/airs/redteam.ts:302

Update a red team target.

Parameters¶

uuid¶

string

request¶

RedTeamTargetUpdateRequest

opts?¶

TargetOperationOptions

Returns¶

Promise\<RedTeamTargetDetail>

Implementation of¶

RedTeamService.updateTarget

updateTargetProfile()¶

updateTargetProfile(uuid, request): Promise\<Record\<string, unknown>>

Defined in: src/airs/redteam.ts:330

Update target profile.

Parameters¶

uuid¶

string

request¶

Record\<string, unknown>

Returns¶

Promise\<Record\<string, unknown>>

Implementation of¶

RedTeamService.updateTargetProfile

validateTargetAuth()¶

validateTargetAuth(request): Promise\<TargetAuthValidationResult>

Defined in: src/airs/redteam.ts:234

Validate target auth credentials.

Parameters¶

request¶

TargetAuthValidationRequest

Returns¶

Promise\<TargetAuthValidationResult>

Implementation of¶

RedTeamService.validateTargetAuth

waitForCompletion()¶

waitForCompletion(jobId, onProgress?, intervalMs?): Promise\<RedTeamJob>

Defined in: src/airs/redteam.ts:509

Poll until scan completes. Calls onProgress for status updates.

Parameters¶

jobId¶

string

onProgress?¶

(job) => void

intervalMs?¶

number = 5000

Returns¶

Promise\<RedTeamJob>

Implementation of¶

RedTeamService.waitForCompletion