Interface: ModelSecurityService¶

Defined in: src/airs/types.ts:705

Contract for Model Security operations.

Methods¶

addLabels()¶

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

Defined in: src/airs/types.ts:753

Parameters¶

scanUuid¶

string

labels¶

ModelSecurityLabel[]

Returns¶

Promise\<void>

createGroup()¶

createGroup(request): Promise\<ModelSecurityGroup>

Defined in: src/airs/types.ts:710

Parameters¶

request¶

ModelSecurityGroupCreateRequest

Returns¶

Promise\<ModelSecurityGroup>

createScan()¶

createScan(request): Promise\<ModelSecurityScan>

Defined in: src/airs/types.ts:730

Parameters¶

request¶

Record\<string, unknown>

Returns¶

Promise\<ModelSecurityScan>

deleteGroup()¶

deleteGroup(uuid): Promise\<void>

Defined in: src/airs/types.ts:712

Parameters¶

uuid¶

string

Returns¶

Promise\<void>

deleteLabels()¶

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

Defined in: src/airs/types.ts:755

Parameters¶

scanUuid¶

string

keys¶

string[]

Returns¶

Promise\<void>

getEvaluation()¶

getEvaluation(uuid): Promise\<ModelSecurityEvaluation>

Defined in: src/airs/types.ts:740

Parameters¶

uuid¶

string

Returns¶

Promise\<ModelSecurityEvaluation>

getEvaluations()¶

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

Defined in: src/airs/types.ts:736

Parameters¶

scanUuid¶

string

opts?¶

limit?¶

number

skip?¶

number

Returns¶

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

getFiles()¶

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

Defined in: src/airs/types.ts:748

Parameters¶

scanUuid¶

string

opts?¶

ModelSecurityFileListOptions

Returns¶

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

getGroup()¶

getGroup(uuid): Promise\<ModelSecurityGroup>

Defined in: src/airs/types.ts:709

Parameters¶

uuid¶

string

Returns¶

Promise\<ModelSecurityGroup>

getLabelKeys()¶

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

Defined in: src/airs/types.ts:756

Parameters¶

opts?¶

limit?¶

number

skip?¶

number

Returns¶

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

getLabelValues()¶

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

Defined in: src/airs/types.ts:760

Parameters¶

key¶

string

opts?¶

limit?¶

number

skip?¶

number

Returns¶

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

getPyPIAuth()¶

getPyPIAuth(): Promise\<ModelSecurityPyPIAuth>

Defined in: src/airs/types.ts:765

Returns¶

Promise\<ModelSecurityPyPIAuth>

getRule()¶

getRule(uuid): Promise\<ModelSecurityRule>

Defined in: src/airs/types.ts:728

Parameters¶

uuid¶

string

Returns¶

Promise\<ModelSecurityRule>

getRuleInstance()¶

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

Defined in: src/airs/types.ts:718

Parameters¶

groupUuid¶

string

instanceUuid¶

string

Returns¶

Promise\<ModelSecurityRuleInstance>

getScan()¶

getScan(uuid): Promise\<ModelSecurityScan>

Defined in: src/airs/types.ts:734

Parameters¶

uuid¶

string

Returns¶

Promise\<ModelSecurityScan>

getViolation()¶

getViolation(uuid): Promise\<ModelSecurityViolation>

Defined in: src/airs/types.ts:746

Parameters¶

uuid¶

string

Returns¶

Promise\<ModelSecurityViolation>

getViolations()¶

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

Defined in: src/airs/types.ts:742

Parameters¶

scanUuid¶

string

opts?¶

limit?¶

number

skip?¶

number

Returns¶

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

listGroups()¶

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

Defined in: src/airs/types.ts:706

Parameters¶

opts?¶

ModelSecurityGroupListOptions

Returns¶

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

listRuleInstances()¶

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

Defined in: src/airs/types.ts:714

Parameters¶

groupUuid¶

string

opts?¶

ModelSecurityRuleInstanceListOptions

Returns¶

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

listRules()¶

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

Defined in: src/airs/types.ts:725

Parameters¶

opts?¶

ModelSecurityRuleListOptions

Returns¶

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

listScans()¶

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

Defined in: src/airs/types.ts:731

Parameters¶

opts?¶

ModelSecurityScanListOptions

Returns¶

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

setLabels()¶

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

Defined in: src/airs/types.ts:754

Parameters¶

scanUuid¶

string

labels¶

ModelSecurityLabel[]

Returns¶

Promise\<void>

updateGroup()¶

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

Defined in: src/airs/types.ts:711

Parameters¶

uuid¶

string

request¶

ModelSecurityGroupUpdateRequest

Returns¶

Promise\<ModelSecurityGroup>

updateRuleInstance()¶

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

Defined in: src/airs/types.ts:719

Parameters¶

groupUuid¶

string

instanceUuid¶

string

request¶

ModelSecurityRuleInstanceUpdateRequest

Returns¶

Promise\<ModelSecurityRuleInstance>