Interface: ManagementService
Defined in: src/airs/types.ts:1247
Contract for AIRS topic CRUD, profile CRUD, and profile linking operations.
Methods
assignTopicsToProfile()
assignTopicsToProfile(
profileName,topics,guardrailAction?):Promise<void>
Defined in: src/airs/types.ts:1272
Assign multiple topics to a security profile's topic-guardrails.
Parameters
profileName
string
topics
object[]
guardrailAction?
"allow" | "block"
Returns
Promise<void>
assignTopicToProfile()
assignTopicToProfile(
profileName,topicId,topicName,action):Promise<void>
Defined in: src/airs/types.ts:1265
Assign a topic to a security profile's topic-guardrails.
Parameters
profileName
string
topicId
string
topicName
string
action
"allow" | "block"
Returns
Promise<void>
createApiKey()
createApiKey(
request):Promise<ApiKeyInfo>
Defined in: src/airs/types.ts:1305
Parameters
request
Record<string, unknown>
Returns
Promise<ApiKeyInfo>
createProfile()
createProfile(
request):Promise<SecurityProfileInfo>
Defined in: src/airs/types.ts:1291
Create a security profile.
Parameters
request
CreateSecurityProfileRequest
Returns
Promise<SecurityProfileInfo>
createTopic()
createTopic(
request):Promise<objectOutputType<{active:ZodOptional<ZodBoolean>;created_by:ZodOptional<ZodString>;created_ts:ZodOptional<ZodString>;description:ZodString;examples:ZodDefault<ZodArray<ZodString,"many">>;last_modified_ts:ZodOptional<ZodString>;revision:ZodNumber;topic_id:ZodOptional<ZodString>;topic_name:ZodString;updated_by:ZodOptional<ZodString>; },ZodTypeAny,"passthrough">>
Defined in: src/airs/types.ts:1249
Create a new custom topic.
Parameters
request
objectOutputType
Returns
Promise<objectOutputType<{ active: ZodOptional<ZodBoolean>; created_by: ZodOptional<ZodString>; created_ts: ZodOptional<ZodString>; description: ZodString; examples: ZodDefault<ZodArray<ZodString, "many">>; last_modified_ts: ZodOptional<ZodString>; revision: ZodNumber; topic_id: ZodOptional<ZodString>; topic_name: ZodString; updated_by: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">>
deleteApiKey()
deleteApiKey(
apiKeyName,updatedBy):Promise<DeleteResponse>
Defined in: src/airs/types.ts:1307
Parameters
apiKeyName
string
updatedBy
string
Returns
Promise<DeleteResponse>
deleteCustomerApp()
deleteCustomerApp(
appName,updatedBy):Promise<CustomerAppInfo>
Defined in: src/airs/types.ts:1314
Parameters
appName
string
updatedBy
string
Returns
Promise<CustomerAppInfo>
deleteProfile()
deleteProfile(
profileId):Promise<DeleteResponse>
Defined in: src/airs/types.ts:1298
Delete a security profile.
Parameters
profileId
string
Returns
Promise<DeleteResponse>
deleteTopic()
deleteTopic(
topicId):Promise<void>
Defined in: src/airs/types.ts:1253
Delete a custom topic by ID.
Parameters
topicId
string
Returns
Promise<void>
forceDeleteProfile()
forceDeleteProfile(
profileId,updatedBy):Promise<DeleteResponse>
Defined in: src/airs/types.ts:1300
Force-delete a security profile (removes from referencing policies).
Parameters
profileId
string
updatedBy
string
Returns
Promise<DeleteResponse>
forceDeleteTopic()
forceDeleteTopic(
topicId,updatedBy?):Promise<DeleteResponse>
Defined in: src/airs/types.ts:1255
Force-delete a custom topic (removes from all referencing profiles).
Parameters
topicId
string
updatedBy?
string
Returns
Promise<DeleteResponse>
getCustomerApp()
getCustomerApp(
appName):Promise<CustomerAppInfo>
Defined in: src/airs/types.ts:1312
Parameters
appName
string
Returns
Promise<CustomerAppInfo>
getCustomerAppConsumption()
getCustomerAppConsumption(
appName,opts?):Promise<CustomerAppConsumption>
Defined in: src/airs/types.ts:1316
Get per-app token consumption + violation breakdown from the SCM dashboard endpoints.
Parameters
appName
string
opts?
Returns
Promise<CustomerAppConsumption>
getProfile()
getProfile(
profileId):Promise<SecurityProfileInfo>
Defined in: src/airs/types.ts:1281
Get a single security profile by UUID.
Parameters
profileId
string
Returns
Promise<SecurityProfileInfo>
getProfileByName()
getProfileByName(
profileName):Promise<SecurityProfileInfo>
Defined in: src/airs/types.ts:1283
Get a single security profile by name (returns highest revision).
Parameters
profileName
string
Returns
Promise<SecurityProfileInfo>
getProfileTopics()
getProfileTopics(
profileName):Promise<ProfileTopic[]>
Defined in: src/airs/types.ts:1278
List all topics configured in a profile with full details.
Parameters
profileName
string
Returns
Promise<ProfileTopic[]>
getTopic()
getTopic(
topicId):Promise<objectOutputType<{active:ZodOptional<ZodBoolean>;created_by:ZodOptional<ZodString>;created_ts:ZodOptional<ZodString>;description:ZodString;examples:ZodDefault<ZodArray<ZodString,"many">>;last_modified_ts:ZodOptional<ZodString>;revision:ZodNumber;topic_id:ZodOptional<ZodString>;topic_name:ZodString;updated_by:ZodOptional<ZodString>; },ZodTypeAny,"passthrough">>
Defined in: src/airs/types.ts:1261
Get a single custom topic by ID.
Parameters
topicId
string
Returns
Promise<objectOutputType<{ active: ZodOptional<ZodBoolean>; created_by: ZodOptional<ZodString>; created_ts: ZodOptional<ZodString>; description: ZodString; examples: ZodDefault<ZodArray<ZodString, "many">>; last_modified_ts: ZodOptional<ZodString>; revision: ZodNumber; topic_id: ZodOptional<ZodString>; topic_name: ZodString; updated_by: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">>
getTopicByName()
getTopicByName(
topicName):Promise<objectOutputType<{active:ZodOptional<ZodBoolean>;created_by:ZodOptional<ZodString>;created_ts:ZodOptional<ZodString>;description:ZodString;examples:ZodDefault<ZodArray<ZodString,"many">>;last_modified_ts:ZodOptional<ZodString>;revision:ZodNumber;topic_id:ZodOptional<ZodString>;topic_name:ZodString;updated_by:ZodOptional<ZodString>; },ZodTypeAny,"passthrough">>
Defined in: src/airs/types.ts:1263
Get a single custom topic by name.
Parameters
topicName
string
Returns
Promise<objectOutputType<{ active: ZodOptional<ZodBoolean>; created_by: ZodOptional<ZodString>; created_ts: ZodOptional<ZodString>; description: ZodString; examples: ZodDefault<ZodArray<ZodString, "many">>; last_modified_ts: ZodOptional<ZodString>; revision: ZodNumber; topic_id: ZodOptional<ZodString>; topic_name: ZodString; updated_by: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">>
listAllApiKeys()
listAllApiKeys(
opts?):Promise<ApiKeyInfo[]>
Defined in: src/airs/types.ts:1304
Parameters
opts?
limit?
number
max?
number
Returns
Promise<ApiKeyInfo[]>
listAllCustomerApps()
listAllCustomerApps(
opts?):Promise<CustomerAppInfo[]>
Defined in: src/airs/types.ts:1311
Parameters
opts?
limit?
number
max?
number
Returns
Promise<CustomerAppInfo[]>
listAllProfiles()
listAllProfiles(
opts?):Promise<SecurityProfileInfo[]>
Defined in: src/airs/types.ts:1287
Walk all security-profile pages.
Parameters
opts?
Omit<PaginationOptions, "offset"> & object
Returns
Promise<SecurityProfileInfo[]>
listApiKeys()
listApiKeys(
opts?):Promise<ApiKeyListResult>
Defined in: src/airs/types.ts:1303
Parameters
opts?
Returns
Promise<ApiKeyListResult>
listConsumptionApps()
listConsumptionApps(
opts?):Promise<ConsumptionAppListEntry[]>
Defined in: src/airs/types.ts:1328
List dashboard application buckets - the canonical apps source for consumption reporting.
Drawn from dashboard.applicationsOverview. One entry per dashboard bucket, which is one
per distinct scan-payload metadata.app_name per registered customer-app. Distinct from
ManagementService.listCustomerApps, which enumerates registered customer-apps
(different granularity).
Parameters
opts?
limit?
number
offset?
number
Returns
Promise<ConsumptionAppListEntry[]>
listCustomerApps()
listCustomerApps(
opts?):Promise<CustomerAppListResult>
Defined in: src/airs/types.ts:1310
Parameters
opts?
Returns
Promise<CustomerAppListResult>
listDeploymentProfiles()
listDeploymentProfiles(
opts?):Promise<DeploymentProfileInfo[]>
Defined in: src/airs/types.ts:1334
Parameters
opts?
unactivated?
boolean
Returns
Promise<DeploymentProfileInfo[]>
listLatestTopics()
listLatestTopics(
opts?):Promise<objectOutputType<{active:ZodOptional<ZodBoolean>;created_by:ZodOptional<ZodString>;created_ts:ZodOptional<ZodString>;description:ZodString;examples:ZodDefault<ZodArray<ZodString,"many">>;last_modified_ts:ZodOptional<ZodString>;revision:ZodNumber;topic_id:ZodOptional<ZodString>;topic_name:ZodString;updated_by:ZodOptional<ZodString>; },ZodTypeAny,"passthrough">[]>
Defined in: src/airs/types.ts:1259
List latest topic revisions with client-side grouping in the SDK.
Parameters
opts?
Returns
Promise<objectOutputType<{ active: ZodOptional<ZodBoolean>; created_by: ZodOptional<ZodString>; created_ts: ZodOptional<ZodString>; description: ZodString; examples: ZodDefault<ZodArray<ZodString, "many">>; last_modified_ts: ZodOptional<ZodString>; revision: ZodNumber; topic_id: ZodOptional<ZodString>; topic_name: ZodString; updated_by: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">[]>
listProfiles()
listProfiles(
opts?):Promise<SecurityProfileListResult>
Defined in: src/airs/types.ts:1285
List security profiles.
Parameters
opts?
Returns
Promise<SecurityProfileListResult>
listTopics()
listTopics():
Promise<objectOutputType<{active:ZodOptional<ZodBoolean>;created_by:ZodOptional<ZodString>;created_ts:ZodOptional<ZodString>;description:ZodString;examples:ZodDefault<ZodArray<ZodString,"many">>;last_modified_ts:ZodOptional<ZodString>;revision:ZodNumber;topic_id:ZodOptional<ZodString>;topic_name:ZodString;updated_by:ZodOptional<ZodString>; },ZodTypeAny,"passthrough">[]>
Defined in: src/airs/types.ts:1257
List all custom topics.
Returns
Promise<objectOutputType<{ active: ZodOptional<ZodBoolean>; created_by: ZodOptional<ZodString>; created_ts: ZodOptional<ZodString>; description: ZodString; examples: ZodDefault<ZodArray<ZodString, "many">>; last_modified_ts: ZodOptional<ZodString>; revision: ZodNumber; topic_id: ZodOptional<ZodString>; topic_name: ZodString; updated_by: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">[]>
queryScanLogs()
queryScanLogs(
opts):Promise<ScanLogQueryResult>
Defined in: src/airs/types.ts:1337
Parameters
opts
Returns
Promise<ScanLogQueryResult>
regenerateApiKey()
regenerateApiKey(
apiKeyId,request):Promise<ApiKeyInfo>
Defined in: src/airs/types.ts:1306
Parameters
apiKeyId
string
request
Record<string, unknown>
Returns
Promise<ApiKeyInfo>
updateCustomerApp()
updateCustomerApp(
appId,request):Promise<CustomerAppInfo>
Defined in: src/airs/types.ts:1313
Parameters
appId
string
request
Record<string, unknown>
Returns
Promise<CustomerAppInfo>
updateProfile()
updateProfile(
profileId,request):Promise<SecurityProfileInfo>
Defined in: src/airs/types.ts:1293
Update a security profile.
Parameters
profileId
string
request
CreateSecurityProfileRequest
Returns
Promise<SecurityProfileInfo>
updateTopic()
updateTopic(
topicId,request):Promise<objectOutputType<{active:ZodOptional<ZodBoolean>;created_by:ZodOptional<ZodString>;created_ts:ZodOptional<ZodString>;description:ZodString;examples:ZodDefault<ZodArray<ZodString,"many">>;last_modified_ts:ZodOptional<ZodString>;revision:ZodNumber;topic_id:ZodOptional<ZodString>;topic_name:ZodString;updated_by:ZodOptional<ZodString>; },ZodTypeAny,"passthrough">>
Defined in: src/airs/types.ts:1251
Update an existing custom topic by ID.
Parameters
topicId
string
request
objectOutputType
Returns
Promise<objectOutputType<{ active: ZodOptional<ZodBoolean>; created_by: ZodOptional<ZodString>; created_ts: ZodOptional<ZodString>; description: ZodString; examples: ZodDefault<ZodArray<ZodString, "many">>; last_modified_ts: ZodOptional<ZodString>; revision: ZodNumber; topic_id: ZodOptional<ZodString>; topic_name: ZodString; updated_by: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">>