Class: SdkModelSecurityService¶

Defined in: src/airs/modelsecurity.ts:143

Wraps the SDK's ModelSecurityClient to implement ModelSecurityService. Provides security group CRUD, rule browsing, scan operations, and label management.

Implements¶

ModelSecurityService

Constructors¶

Constructor¶

new SdkModelSecurityService(opts?): SdkModelSecurityService

Defined in: src/airs/modelsecurity.ts:146

Parameters¶

opts?¶

ModelSecurityClientOptions

Returns¶

SdkModelSecurityService

Methods¶

addLabels()¶

addLabels(scanUuid, labels): Promise\<void>

Defined in: src/airs/modelsecurity.ts:397

Parameters¶

scanUuid¶

string

labels¶

ModelSecurityLabel[]

Returns¶

Promise\<void>

Implementation of¶

ModelSecurityService.addLabels

createGroup()¶

createGroup(request): Promise\<ModelSecurityGroup>

Defined in: src/airs/modelsecurity.ts:182

Parameters¶

createScan()¶

createScan(request): Promise\<ModelSecurityScan>

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

Parameters¶

request¶

Record\<string, unknown>

Returns¶

Promise\<ModelSecurityScan>

Implementation of¶

ModelSecurityService.createScan

deleteGroup()¶

deleteGroup(uuid): Promise\<void>

Defined in: src/airs/modelsecurity.ts:202

Parameters¶

uuid¶

string

Returns¶

Promise\<void>

Implementation of¶

ModelSecurityService.deleteGroup

deleteLabels()¶

deleteLabels(scanUuid, keys): Promise\<void>

Defined in: src/airs/modelsecurity.ts:405

Parameters¶

scanUuid¶

string

keys¶

string[]

Returns¶

Promise\<void>

Implementation of¶

ModelSecurityService.deleteLabels

getEvaluation()¶

getEvaluation(uuid): Promise\<ModelSecurityEvaluation>

Defined in: src/airs/modelsecurity.ts:345

Parameters¶

uuid¶

string

Returns¶

Promise\<ModelSecurityEvaluation>

Implementation of¶

ModelSecurityService.getEvaluation

getEvaluations()¶

getEvaluations(scanUuid, opts?): Promise\<{ evaluations: ModelSecurityEvaluation[]; totalItems: number; }>

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

Parameters¶

scanUuid¶

string

opts?¶

limit?¶

number

skip?¶

number

Returns¶

Promise\<{ evaluations: ModelSecurityEvaluation[]; totalItems: number; }>

Implementation of¶

ModelSecurityService.getEvaluations

getFiles()¶

getFiles(scanUuid, opts?): Promise\<{ files: ModelSecurityFile[]; totalItems: number; }>

Defined in: src/airs/modelsecurity.ts:378

Parameters¶

scanUuid¶

string

opts?¶

ModelSecurityFileListOptions

Returns¶

Promise\<{ files: ModelSecurityFile[]; totalItems: number; }>

Implementation of¶

ModelSecurityService.getFiles

getGroup()¶

getGroup(uuid): Promise\<ModelSecurityGroup>

Defined in: src/airs/modelsecurity.ts:177

Parameters¶

uuid¶

string

Returns¶

Promise\<ModelSecurityGroup>

Implementation of¶

ModelSecurityService.getGroup

getLabelKeys()¶

getLabelKeys(opts?): Promise\<{ keys: string[]; totalItems: number; }>

Defined in: src/airs/modelsecurity.ts:409

Parameters¶

opts?¶

limit?¶

number

skip?¶

number

Returns¶

Promise\<{ keys: string[]; totalItems: number; }>

Implementation of¶

ModelSecurityService.getLabelKeys

getLabelValues()¶

getLabelValues(key, opts?): Promise\<{ totalItems: number; values: string[]; }>

Defined in: src/airs/modelsecurity.ts:424

Parameters¶

key¶

string

opts?¶

limit?¶

number

skip?¶

number

Returns¶

Promise\<{ totalItems: number; values: string[]; }>

Implementation of¶

ModelSecurityService.getLabelValues

getPyPIAuth()¶

getPyPIAuth(): Promise\<ModelSecurityPyPIAuth>

Defined in: src/airs/modelsecurity.ts:443

Returns¶

Promise\<ModelSecurityPyPIAuth>

Implementation of¶

ModelSecurityService.getPyPIAuth

getRule()¶

getRule(uuid): Promise\<ModelSecurityRule>

Defined in: src/airs/modelsecurity.ts:285

Parameters¶

uuid¶

string

Returns¶

Promise\<ModelSecurityRule>

Implementation of¶

ModelSecurityService.getRule

getRuleInstance()¶

getRuleInstance(groupUuid, instanceUuid): Promise\<ModelSecurityRuleInstance>

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

Parameters¶

groupUuid¶

string

instanceUuid¶

string

Returns¶

Promise\<ModelSecurityRuleInstance>

Implementation of¶

ModelSecurityService.getRuleInstance

getScan()¶

getScan(uuid): Promise\<ModelSecurityScan>

Defined in: src/airs/modelsecurity.ts:321

Parameters¶

uuid¶

string

Returns¶

Promise\<ModelSecurityScan>

Implementation of¶

ModelSecurityService.getScan

getViolation()¶

getViolation(uuid): Promise\<ModelSecurityViolation>

Defined in: src/airs/modelsecurity.ts:369

Parameters¶

uuid¶

string

Returns¶

Promise\<ModelSecurityViolation>

Implementation of¶

ModelSecurityService.getViolation

getViolations()¶

getViolations(scanUuid, opts?): Promise\<{ totalItems: number; violations: ModelSecurityViolation[]; }>

Defined in: src/airs/modelsecurity.ts:354

Parameters¶

scanUuid¶

string

opts?¶

limit?¶

number

skip?¶

number

Returns¶

Promise\<{ totalItems: number; violations: ModelSecurityViolation[]; }>

Implementation of¶

ModelSecurityService.getViolations

listGroups()¶

listGroups(opts?): Promise\<{ groups: ModelSecurityGroup[]; totalItems: number; }>

Defined in: src/airs/modelsecurity.ts:154

Parameters¶

opts?¶

ModelSecurityGroupListOptions

Returns¶

Promise\<{ groups: ModelSecurityGroup[]; totalItems: number; }>

Implementation of¶

ModelSecurityService.listGroups

listRuleInstances()¶

listRuleInstances(groupUuid, opts?): Promise\<{ ruleInstances: ModelSecurityRuleInstance[]; totalItems: number; }>

Defined in: src/airs/modelsecurity.ts:210

Parameters¶

groupUuid¶

string

opts?¶

ModelSecurityRuleInstanceListOptions

Returns¶

Promise\<{ ruleInstances: ModelSecurityRuleInstance[]; totalItems: number; }>

Implementation of¶

ModelSecurityService.listRuleInstances

listRules()¶

listRules(opts?): Promise\<{ rules: ModelSecurityRule[]; totalItems: number; }>

Defined in: src/airs/modelsecurity.ts:265

Parameters¶

opts?¶

ModelSecurityRuleListOptions

Returns¶

Promise\<{ rules: ModelSecurityRule[]; totalItems: number; }>

Implementation of¶

ModelSecurityService.listRules

listScans()¶

listScans(opts?): Promise\<{ scans: ModelSecurityScan[]; totalItems: number; }>

Defined in: src/airs/modelsecurity.ts:299

Parameters¶

opts?¶

ModelSecurityScanListOptions

Returns¶

Promise\<{ scans: ModelSecurityScan[]; totalItems: number; }>

Implementation of¶

ModelSecurityService.listScans

setLabels()¶

setLabels(scanUuid, labels): Promise\<void>

Defined in: src/airs/modelsecurity.ts:401

Parameters¶

scanUuid¶

string

labels¶

ModelSecurityLabel[]

Returns¶

Promise\<void>

Implementation of¶

ModelSecurityService.setLabels

updateGroup()¶

updateGroup(uuid, request): Promise\<ModelSecurityGroup>

Defined in: src/airs/modelsecurity.ts:194

Parameters¶

uuid¶

string

request¶

ModelSecurityGroupUpdateRequest

Returns¶

Promise\<ModelSecurityGroup>

Implementation of¶

ModelSecurityService.updateGroup

updateRuleInstance()¶

updateRuleInstance(groupUuid, instanceUuid, request): Promise\<ModelSecurityRuleInstance>

Defined in: src/airs/modelsecurity.ts:242

Parameters¶

groupUuid¶

string

instanceUuid¶

string

request¶

ModelSecurityRuleInstanceUpdateRequest

Returns¶

Promise\<ModelSecurityRuleInstance>

Implementation of¶

ModelSecurityService.updateRuleInstance