Class: SdkManagementService
Defined in: src/airs/management.ts:31
Wraps the SDK's ManagementClient to implement our ManagementService interface. OAuth2 token management, caching, and retry are handled by the SDK.
Implements
Constructors
Constructor
new SdkManagementService(
opts?):SdkManagementService
Defined in: src/airs/management.ts:34
Parameters
opts?
ManagementClientOptions
Returns
SdkManagementService
Methods
assignTopicsToProfile()
assignTopicsToProfile(
profileName,topics,guardrailAction?):Promise<void>
Defined in: src/airs/management.ts:104
Sets one or more custom topics on a profile's topic-guardrails config. Replaces any existing topics — previous runs' stale topics are cleared. Groups topics by action; skips empty action groups (AIRS rejects them).
CRITICAL: Each topic entry MUST include the current revision number.
AIRS pins topic content to the revision specified in the profile — omitting
it defaults to revision 0 (original content), not the latest.
Parameters
profileName
string
topics
object[]
guardrailAction?
"allow" | "block"
Returns
Promise<void>
Implementation of
ManagementService.assignTopicsToProfile
assignTopicToProfile()
assignTopicToProfile(
profileName,topicId,topicName,action):Promise<void>
Defined in: src/airs/management.ts:86
Sets a single custom topic on a profile's topic-guardrails config. Delegates to assignTopicsToProfile for backward compatibility.
Parameters
profileName
string
topicId
string
topicName
string
action
"allow" | "block"
Returns
Promise<void>
Implementation of
ManagementService.assignTopicToProfile
createApiKey()
createApiKey(
request):Promise<ApiKeyInfo>
Defined in: src/airs/management.ts:339
Parameters
request
Record<string, unknown>
Returns
Promise<ApiKeyInfo>
Implementation of
ManagementService.createApiKey
createProfile()
createProfile(
request):Promise<SecurityProfileInfo>
Defined in: src/airs/management.ts:285
Create a security profile.
Parameters
request
CreateSecurityProfileRequest
Returns
Promise<SecurityProfileInfo>
Implementation of
ManagementService.createProfile
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/management.ts:38
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">>
Implementation of
deleteApiKey()
deleteApiKey(
apiKeyName,updatedBy):Promise<DeleteResponse>
Defined in: src/airs/management.ts:349
Parameters
apiKeyName
string
updatedBy
string
Returns
Promise<DeleteResponse>
Implementation of
ManagementService.deleteApiKey
deleteCustomerApp()
deleteCustomerApp(
appName,updatedBy):Promise<CustomerAppInfo>
Defined in: src/airs/management.ts:396
Parameters
appName
string
updatedBy
string
Returns
Promise<CustomerAppInfo>
Implementation of
ManagementService.deleteCustomerApp
deleteProfile()
deleteProfile(
profileId):Promise<DeleteResponse>
Defined in: src/airs/management.ts:298
Delete a security profile.
Parameters
profileId
string
Returns
Promise<DeleteResponse>
Implementation of
ManagementService.deleteProfile
deleteTopic()
deleteTopic(
topicId):Promise<void>
Defined in: src/airs/management.ts:46
Delete a custom topic by ID.
Parameters
topicId
string
Returns
Promise<void>
Implementation of
forceDeleteProfile()
forceDeleteProfile(
profileId,updatedBy):Promise<DeleteResponse>
Defined in: src/airs/management.ts:303
Force-delete a security profile (removes from referencing policies).
Parameters
profileId
string
updatedBy
string
Returns
Promise<DeleteResponse>
Implementation of
ManagementService.forceDeleteProfile
forceDeleteTopic()
forceDeleteTopic(
topicId,updatedBy?):Promise<DeleteResponse>
Defined in: src/airs/management.ts:50
Force-delete a custom topic (removes from all referencing profiles).
Parameters
topicId
string
updatedBy?
string
Returns
Promise<DeleteResponse>
Implementation of
ManagementService.forceDeleteTopic
getCustomerApp()
getCustomerApp(
appName):Promise<CustomerAppInfo>
Defined in: src/airs/management.ts:383
Parameters
appName
string
Returns
Promise<CustomerAppInfo>
Implementation of
ManagementService.getCustomerApp
getCustomerAppConsumption()
getCustomerAppConsumption(
appName,opts?):Promise<CustomerAppConsumption>
Defined in: src/airs/management.ts:435
Get per-app token consumption + violation breakdown from the SCM dashboard endpoints.
Parameters
appName
string
opts?
Returns
Promise<CustomerAppConsumption>
Implementation of
ManagementService.getCustomerAppConsumption
getProfile()
getProfile(
profileId):Promise<SecurityProfileInfo>
Defined in: src/airs/management.ts:256
Get a single security profile by UUID.
Parameters
profileId
string
Returns
Promise<SecurityProfileInfo>
Implementation of
getProfileByName()
getProfileByName(
profileName):Promise<SecurityProfileInfo>
Defined in: src/airs/management.ts:261
Get a single security profile by name (returns highest revision).
Parameters
profileName
string
Returns
Promise<SecurityProfileInfo>
Implementation of
ManagementService.getProfileByName
getProfileTopics()
getProfileTopics(
profileName):Promise<ProfileTopic[]>
Defined in: src/airs/management.ts:184
List all topics configured in a profile with full details.
Parameters
profileName
string
Returns
Promise<ProfileTopic[]>
Implementation of
ManagementService.getProfileTopics
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/management.ts:68
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">>
Implementation of
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/management.ts:75
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">>
Implementation of
ManagementService.getTopicByName
listAllApiKeys()
listAllApiKeys(
opts?):Promise<ApiKeyInfo[]>
Defined in: src/airs/management.ts:333
Parameters
opts?
limit?
number
max?
number
Returns
Promise<ApiKeyInfo[]>
Implementation of
ManagementService.listAllApiKeys
listAllCustomerApps()
listAllCustomerApps(
opts?):Promise<CustomerAppInfo[]>
Defined in: src/airs/management.ts:377
Parameters
opts?
limit?
number
max?
number
Returns
Promise<CustomerAppInfo[]>
Implementation of
ManagementService.listAllCustomerApps
listAllProfiles()
listAllProfiles(
opts?):Promise<SecurityProfileInfo[]>
Defined in: src/airs/management.ts:276
Walk all security-profile pages.
Parameters
opts?
Omit<PaginationOptions, "offset"> & object
Returns
Promise<SecurityProfileInfo[]>
Implementation of
ManagementService.listAllProfiles
listApiKeys()
listApiKeys(
opts?):Promise<ApiKeyListResult>
Defined in: src/airs/management.ts:323
Parameters
opts?
Returns
Promise<ApiKeyListResult>
Implementation of
listConsumptionApps()
listConsumptionApps(
opts?):Promise<ConsumptionAppListEntry[]>
Defined in: src/airs/management.ts:401
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[]>
Implementation of
ManagementService.listConsumptionApps
listCustomerApps()
listCustomerApps(
opts?):Promise<CustomerAppListResult>
Defined in: src/airs/management.ts:367
Parameters
opts?
Returns
Promise<CustomerAppListResult>
Implementation of
ManagementService.listCustomerApps
listDeploymentProfiles()
listDeploymentProfiles(
opts?):Promise<DeploymentProfileInfo[]>
Defined in: src/airs/management.ts:509
Parameters
opts?
unactivated?
boolean
Returns
Promise<DeploymentProfileInfo[]>
Implementation of
ManagementService.listDeploymentProfiles
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/management.ts:59
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">[]>
Implementation of
ManagementService.listLatestTopics
listProfiles()
listProfiles(
opts?):Promise<SecurityProfileListResult>
Defined in: src/airs/management.ts:266
List security profiles.
Parameters
opts?
Returns
Promise<SecurityProfileListResult>
Implementation of
ManagementService.listProfiles
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/management.ts:55
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">[]>
Implementation of
queryScanLogs()
queryScanLogs(
opts):Promise<ScanLogQueryResult>
Defined in: src/airs/management.ts:520
Parameters
opts
Returns
Promise<ScanLogQueryResult>
Implementation of
ManagementService.queryScanLogs
regenerateApiKey()
regenerateApiKey(
apiKeyId,request):Promise<ApiKeyInfo>
Defined in: src/airs/management.ts:344
Parameters
apiKeyId
string
request
Record<string, unknown>
Returns
Promise<ApiKeyInfo>
Implementation of
ManagementService.regenerateApiKey
updateCustomerApp()
updateCustomerApp(
appId,request):Promise<CustomerAppInfo>
Defined in: src/airs/management.ts:388
Parameters
appId
string
request
Record<string, unknown>
Returns
Promise<CustomerAppInfo>
Implementation of
ManagementService.updateCustomerApp
updateProfile()
updateProfile(
profileId,request):Promise<SecurityProfileInfo>
Defined in: src/airs/management.ts:290
Update a security profile.
Parameters
profileId
string
request
CreateSecurityProfileRequest
Returns
Promise<SecurityProfileInfo>
Implementation of
ManagementService.updateProfile
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/management.ts:42
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">>