import { type AgentSkeleton, type AgentType } from '../api/AgentApi'; import { State } from '../shared/State'; import { type ExportMetaData } from './OpsTypes'; export type Agent = { /** * Create an empty agent export template * @returns {AgentExportInterface} an empty agent export template */ createAgentExportTemplate(): AgentExportInterface; /** * Read all agents. * @returns {Promise} a promise that resolves to an array of agent objects */ readAgents(): Promise; /** * Read agent * @param {string} agentId agent id/name * @returns {Promise} a promise that resolves to an agent object */ readAgent(agentId: string): Promise; /** * Read agent by type and id * @param {string} agentType agent type (IdentityGatewayAgent, J2EEAgent, WebAgent) * @param {string} agentId agent id/name * @returns {Promise} a promise that resolves to an agent object */ readAgentByTypeAndId(agentType: AgentType, agentId: string): Promise; /** * Read identity gateway agents * @returns {Promise} a promise that resolves to an array of IdentityGatewayAgent objects */ readIdentityGatewayAgents(): Promise; /** * Read identity gateway agent * @param {string} gatewayId gateway id * @returns {Promise} a promise that resolves to an object containing an IdentityGatewayAgent object */ readIdentityGatewayAgent(gatewayId: string): Promise; /** * Create identity gateway agent * @param {string} gatewayId gateway id * @param {AgentSkeleton} gatewayData IdentityGatewayAgent object * @returns {Promise} a promise that resolves to an object containing an IdentityGatewayAgent object */ createIdentityGatewayAgent(gatewayId: string, gatewayData: AgentSkeleton): Promise; /** * Update or create identity gateway agent * @param {string} gatewayId gateway id * @param {AgentSkeleton} gatewayData IdentityGatewayAgent object * @returns {Promise} a promise that resolves to an object containing an IdentityGatewayAgent object */ updateIdentityGatewayAgent(gatewayId: string, gatewayData: AgentSkeleton): Promise; /** * Read java agents * @returns {Promise} a promise that resolves to an array of J2EEAgent objects */ readJavaAgents(): Promise; /** * Read java agent * @param {string} agentId java agent id * @returns {Promise} a promise that resolves to an object containing an J2EEAgent object */ readJavaAgent(agentId: string): Promise; /** * Put java agent * @param {string} agentId java agent id * @param {AgentSkeleton} agentData java agent object * @returns {Promise} a promise that resolves to an object containing an java agent object */ createJavaAgent(agentId: string, agentData: AgentSkeleton): Promise; /** * Put java agent * @param {string} agentId java agent id * @param {AgentSkeleton} agentData java agent object * @returns {Promise} a promise that resolves to an object containing an java agent object */ updateJavaAgent(agentId: string, agentData: AgentSkeleton): Promise; /** * Read web agents * @returns {Promise} a promise that resolves to an array of WebAgent objects */ readWebAgents(): Promise; /** * Read web agent * @param {string} agentId web agent id * @returns {Promise} a promise that resolves to an object containing an WebAgent object */ readWebAgent(agentId: string): Promise; /** * Create web agent * @param {string} agentId web agent id * @param {AgentSkeleton} agentData WebAgent object * @returns {Promise} a promise that resolves to an object containing an WebAgent object */ createWebAgent(agentId: string, agentData: AgentSkeleton): Promise; /** * Update or create web agent * @param {string} agentId web agent id * @param {AgentSkeleton} agentData WebAgent object * @returns {Promise} a promise that resolves to an object containing an WebAgent object */ updateWebAgent(agentId: string, agentData: AgentSkeleton): Promise; /** * Export all agents. The response can be saved to file as is. * @returns {Promise} Promise resolving to an AgentExportInterface object. */ exportAgents(): Promise; /** * Export all identity gateway agents. The response can be saved to file as is. * @returns {Promise} Promise resolving to an AgentExportInterface object. */ exportIdentityGatewayAgents(): Promise; /** * Export all java agents. The response can be saved to file as is. * @returns {Promise} Promise resolving to an AgentExportInterface object. */ exportJavaAgents(): Promise; /** * Export all web agents. The response can be saved to file as is. * @returns {Promise} Promise resolving to an AgentExportInterface object. */ exportWebAgents(): Promise; /** * Export agent. The response can be saved to file as is. * @param agentId agent id/name * @returns {Promise} Promise resolving to an AgentExportInterface object. */ exportAgent(agentId: string): Promise; /** * Export identity gateway agent. The response can be saved to file as is. * @param agentId agent id/name * @returns {Promise} Promise resolving to an AgentExportInterface object. */ exportIdentityGatewayAgent(agentId: string): Promise; /** * Export java agent. The response can be saved to file as is. * @param agentId agent id/name * @returns {Promise} Promise resolving to an AgentExportInterface object. */ exportJavaAgent(agentId: string): Promise; /** * Export web agent. The response can be saved to file as is. * @param agentId agent id/name * @returns {Promise} Promise resolving to an AgentExportInterface object. */ exportWebAgent(agentId: string): Promise; /** * Import agents. The import data is usually read from an agent export file. * @param {AgentExportInterface} importData agent import data. * @returns {Promise} The agents that were imported. */ importAgents(importData: AgentExportInterface): Promise; /** * Import identity gateway agents. The import data is usually read from an agent export file. * @param {AgentExportInterface} importData agent import data. */ importIdentityGatewayAgents(importData: AgentExportInterface): Promise; /** * Import java agents. The import data is usually read from an agent export file. * @param {AgentExportInterface} importData agent import data. */ importJavaAgents(importData: AgentExportInterface): Promise; /** * Import web agents. The import data is usually read from an agent export file. * @param {AgentExportInterface} importData agent import data. */ importWebAgents(importData: AgentExportInterface): Promise; /** * Import agent. The import data is usually read from an agent export file. * @param {string} agentId agent id/name * @param {AgentExportInterface} importData agent import data. * @returns {Promise} Promise resolving to an agent object. */ importAgent(agentId: string, importData: AgentExportInterface): Promise; /** * Import identity gateway agent. The import data is usually read from an agent export file. * @param {string} agentId agent id/name * @param {AgentExportInterface} importData agent import data. * @returns {Promise} Promise resolving to an agent object. */ importIdentityGatewayAgent(agentId: string, importData: AgentExportInterface): Promise; /** * Import java agent. The import data is usually read from an agent export file. * @param {string} agentId agent id/name * @param {AgentExportInterface} importData agent import data. * @returns {Promise} Promise resolving to an agent object. */ importJavaAgent(agentId: string, importData: AgentExportInterface): Promise; /** * Import java agent. The import data is usually read from an agent export file. * @param {string} agentId agent id/name * @param {AgentExportInterface} importData agent import data. * @returns {Promise} Promise resolving to an agent object. */ importWebAgent(agentId: string, importData: AgentExportInterface): Promise; /** * Delete all agents */ deleteAgents(): Promise; /** * Delete agent * @param agentId agent id/name */ deleteAgent(agentId: string): Promise; /** * Delete all identity gateway agents */ deleteIdentityGatewayAgents(): Promise; /** * Delete identity gateway agent * @param agentId agent id/name */ deleteIdentityGatewayAgent(agentId: string): Promise; /** * Delete all java agents */ deleteJavaAgents(): Promise; /** * Delete java agent * @param agentId agent id/name */ deleteJavaAgent(agentId: string): Promise; /** * Delete all web agents */ deleteWebAgents(): Promise; /** * Delete web agent * @param agentId agent id/name */ deleteWebAgent(agentId: string): Promise; /** * Get all agents. * @returns {Promise} a promise that resolves to an array of agent objects * @deprecated since v2.0.0 use {@link Agent.readAgents | readAgents} instead * ```javascript * readAgents(): Promise * ``` * @group Deprecated */ getAgents(): Promise; /** * Get agent * @param {string} agentId agent id/name * @returns {Promise} a promise that resolves to an agent object * @deprecated since v2.0.0 use {@link Agent.readAgent | readAgent} instead * ```javascript * readAgent(agentId: string): Promise * ``` * @group Deprecated */ getAgent(agentId: string): Promise; /** * Get agent by type and id * @param {string} agentType agent type (IdentityGatewayAgent, J2EEAgent, WebAgent) * @param {string} agentId agent id/name * @returns {Promise} a promise that resolves to an agent object * @deprecated since v2.0.0 use {@link Agent.readAgentByTypeAndId | readAgentByTypeAndId} instead * ```javascript * readAgentByTypeAndId(agentType: AgentType, agentId: string): Promise * ``` * @group Deprecated */ getAgentByTypeAndId(agentType: AgentType, agentId: string): Promise; /** * Get identity gateway agents * @returns {Promise} a promise that resolves to an array of IdentityGatewayAgent objects * @deprecated since v2.0.0 use {@link Agent.readIdentityGatewayAgents | readIdentityGatewayAgents} instead * ```javascript * readIdentityGatewayAgents(): Promise * ``` * @group Deprecated */ getIdentityGatewayAgents(): Promise; /** * Get identity gateway agent * @param {string} gatewayId gateway id * @returns {Promise} a promise that resolves to an object containing an IdentityGatewayAgent object * @deprecated since v2.0.0 use {@link Agent.readIdentityGatewayAgent | readIdentityGatewayAgent} instead * ```javascript * readIdentityGatewayAgent(gatewayId: string): Promise * ``` * @group Deprecated */ getIdentityGatewayAgent(gatewayId: string): Promise; /** * Update or create identity gateway agent * @param {string} gatewayId gateway id * @param {AgentSkeleton} gatewayData IdentityGatewayAgent object * @returns {Promise} a promise that resolves to an object containing an IdentityGatewayAgent object * @deprecated since v2.0.0 use {@link Agent.updateIdentityGatewayAgent | updateIdentityGatewayAgent} or {@link Agent.createIdentityGatewayAgent | createIdentityGatewayAgent} instead * ```javascript * updateIdentityGatewayAgent(gatewayId: string, gatewayData: AgentSkeleton): Promise * createIdentityGatewayAgent(gatewayId: string, gatewayData: AgentSkeleton): Promise * ``` * @group Deprecated */ putIdentityGatewayAgent(gatewayId: string, gatewayData: AgentSkeleton): Promise; /** * Get java agents * @returns {romise} a promise that resolves to an array of J2EEAgent objects * @deprecated since v2.0.0 use {@link Agent.readJavaAgents | readJavaAgents} instead * ```javascript * readJavaAgents(): Promise * ``` * @group Deprecated */ getJavaAgents(): Promise; /** * Get java agent * @param {string} agentId java agent id * @returns {Promise} a promise that resolves to an object containing an J2EEAgent object * @deprecated since v2.0.0 use {@link Agent.readJavaAgent | readJavaAgent} instead * ```javascript * readJavaAgent(agentId: string): Promise * ``` * @group Deprecated */ getJavaAgent(agentId: string): Promise; /** * Update or create java agent * @param {string} agentId java agent id * @param {AgentSkeleton} agentData java agent object * @returns {Promise} a promise that resolves to an object containing an java agent object * @deprecated since v2.0.0 use {@link Agent.updateJavaAgent | updateJavaAgent} or {@link Agent.createJavaAgent | createJavaAgent} instead * ```javascript * updateJavaAgent(agentId: string, agentData: AgentSkeleton): Promise * createJavaAgent(agentId: string, agentData: AgentSkeleton): Promise * ``` * @group Deprecated */ putJavaAgent(agentId: string, agentData: AgentSkeleton): Promise; /** * Get web agents * @returns {Promise} a promise that resolves to an array of WebAgent objects * @deprecated since v2.0.0 use {@link Agent.readWebAgents | readWebAgents} instead * ```javascript * readWebAgents(): Promise * ``` * @group Deprecated */ getWebAgents(): Promise; /** * Get web agent * @param {string} agentId web agent id * @returns {Promise} a promise that resolves to an object containing an WebAgent object * @deprecated since v2.0.0 use {@link Agent.readWebAgent | readWebAgent} instead * ```javascript * readWebAgent(agentId: string): Promise * ``` * @group Deprecated */ getWebAgent(agentId: string): Promise; /** * Update or create web agent * @param {string} agentId web agent id * @param {AgentSkeleton} agentData WebAgent object * @returns {Promise} a promise that resolves to an object containing an WebAgent object * @deprecated since v2.0.0 use {@link Agent.updateWebAgent | updateWebAgent} or {@link Agent.createWebAgent | createWebAgent} instead * ```javascript * updateWebAgent(agentId: string, agentData: AgentSkeleton): Promise * createWebAgent(agentId: string, agentData: AgentSkeleton): Promise * ``` * @group Deprecated */ putWebAgent(agentId: string, agentData: AgentSkeleton): Promise; }; declare const _default: (state: State) => Agent; export default _default; export interface AgentExportInterface { meta?: ExportMetaData; agent: Record; } /** * Create an empty agent export template * @returns {AgentExportInterface} an empty agent export template */ export declare function createAgentExportTemplate({ state, }: { state: State; }): AgentExportInterface; /** * Get all agents. Results are sorted alphabetically. * @returns {Promise} a promise that resolves to an array of agent objects */ export declare function readAgents({ state, }: { state: State; }): Promise; /** * Get agent * @param {string} agentId agent id/name * @returns {Promise} a promise that resolves to an agent object */ export declare function readAgent({ agentId, state, }: { agentId: string; state: State; }): Promise; /** * Get agent by type and id * @param {AgentType} agentType agent type (IdentityGatewayAgent, J2EEAgent, WebAgent) * @param {string} agentId agent id/name * @returns {Promise} a promise that resolves to an agent object */ export declare function readAgentByTypeAndId({ agentType, agentId, state, }: { agentType: AgentType; agentId: string; state: State; }): Promise; /** * Get identity gateway agents * @returns {: Promise} a promise that resolves to an array of IdentityGatewayAgent objects */ export declare function readIdentityGatewayAgents({ state, }: { state: State; }): Promise; /** * Get identity gateway agent * @param {string} gatewayId gateway id * @returns {Promise} a promise that resolves to an object containing an IdentityGatewayAgent object */ export declare function readIdentityGatewayAgent({ gatewayId, state, }: { gatewayId: string; state: State; }): Promise; /** * Create identity gateway agent * @param {string} gatewayId gateway id * @param {AgentSkeleton} gatewayData IdentityGatewayAgent object * @returns {Promise} a promise that resolves to an object containing an IdentityGatewayAgent object */ export declare function createIdentityGatewayAgent({ gatewayId, gatewayData, state, }: { gatewayId: string; gatewayData: AgentSkeleton; state: State; }): Promise; /** * Update or create identity gateway agent * @param {string} gatewayId gateway id * @param {AgentSkeleton} gatewayData IdentityGatewayAgent object * @returns {Promise} a promise that resolves to an object containing an IdentityGatewayAgent object */ export declare function updateIdentityGatewayAgent({ gatewayId, gatewayData, state, }: { gatewayId: string; gatewayData: AgentSkeleton; state: State; }): Promise; /** * Get java agents * @returns {Promise} a promise that resolves to an array of J2EEAgent objects */ export declare function readJavaAgents({ state, }: { state: State; }): Promise; /** * Get java agent * @param {string} agentId java agent id * @returns {Promise} a promise that resolves to an object containing an J2EEAgent object */ export declare function readJavaAgent({ agentId, state, }: { agentId: string; state: State; }): Promise; /** * Create java agent * @param {string} agentId java agent id * @param {Object} agentData java agent object * @returns {Promise} a promise that resolves to an object containing an java agent object */ export declare function createJavaAgent({ agentId, agentData, state, }: { agentId: string; agentData: AgentSkeleton; state: State; }): Promise; /** * Update or create java agent * @param {string} agentId java agent id * @param {Object} agentData java agent object * @returns {Promise} a promise that resolves to an object containing an java agent object */ export declare function updateJavaAgent({ agentId, agentData, state, }: { agentId: string; agentData: AgentSkeleton; state: State; }): Promise; /** * Get web agents * @returns {Promise} a promise that resolves to an array of WebAgent objects */ export declare function readWebAgents({ state }: { state: State; }): Promise; /** * Get web agent * @param {string} agentId web agent id * @returns {Promise} a promise that resolves to an object containing an WebAgent object */ export declare function readWebAgent({ agentId, state, }: { agentId: string; state: State; }): Promise; /** * Create web agent * @param {string} agentId java agent id * @param {Object} agentData java agent object * @returns {Promise} a promise that resolves to an object containing an java agent object */ export declare function createWebAgent({ agentId, agentData, state, }: { agentId: string; agentData: AgentSkeleton; state: State; }): Promise; /** * Update or create web agent * @param {string} agentId web agent id * @param {Object} agentData WebAgent object * @returns {Promise} a promise that resolves to an object containing an WebAgent object */ export declare function updateWebAgent({ agentId, agentData, state, }: { agentId: string; agentData: AgentSkeleton; state: State; }): Promise; /** * Export all agents. The response can be saved to file as is. * @returns {Promise} Promise resolving to an AgentExportInterface object. */ export declare function exportAgents({ state, }: { state: State; }): Promise; /** * Export all identity gateway agents. The response can be saved to file as is. * @returns {Promise} Promise resolving to an AgentExportInterface object. */ export declare function exportIdentityGatewayAgents({ state, }: { state: State; }): Promise; /** * Export all java agents. The response can be saved to file as is. * @returns {Promise} Promise resolving to an AgentExportInterface object. */ export declare function exportJavaAgents({ state, }: { state: State; }): Promise; /** * Export all web agents. The response can be saved to file as is. * @returns {Promise} Promise resolving to an AgentExportInterface object. */ export declare function exportWebAgents({ state, }: { state: State; }): Promise; /** * Export agent. The response can be saved to file as is. * @param agentId agent id/name * @returns {Promise} Promise resolving to an AgentExportInterface object. */ export declare function exportAgent({ agentId, state, }: { agentId: string; state: State; }): Promise; /** * Export identity gateway agent. The response can be saved to file as is. * @param agentId agent id/name * @returns {Promise} Promise resolving to an AgentExportInterface object. */ export declare function exportIdentityGatewayAgent({ agentId, state, }: { agentId: string; state: State; }): Promise; /** * Export java agent. The response can be saved to file as is. * @param agentId agent id/name * @returns {Promise} Promise resolving to an AgentExportInterface object. */ export declare function exportJavaAgent({ agentId, state, }: { agentId: string; state: State; }): Promise; /** * Export web agent. The response can be saved to file as is. * @param agentId agent id/name * @returns {Promise} Promise resolving to an AgentExportInterface object. */ export declare function exportWebAgent({ agentId, state, }: { agentId: string; state: State; }): Promise; /** * Import agents. The import data is usually read from an agent export file. * @param {AgentExportInterface} importData agent import data. * @returns {Promise} The agents that were imported. */ export declare function importAgents({ importData, state, }: { importData: AgentExportInterface; state: State; }): Promise; /** * Import identity gateway agents. The import data is usually read from an agent export file. * @param {AgentExportInterface} importData agent import data. */ export declare function importIdentityGatewayAgents({ importData, state, }: { importData: AgentExportInterface; state: State; }): Promise; /** * Import java agents. The import data is usually read from an agent export file. * @param {AgentExportInterface} importData agent import data. */ export declare function importJavaAgents({ importData, state, }: { importData: AgentExportInterface; state: State; }): Promise; /** * Import web agents. The import data is usually read from an agent export file. * @param {AgentExportInterface} importData agent import data. */ export declare function importWebAgents({ importData, state, }: { importData: AgentExportInterface; state: State; }): Promise; /** * Import agent. The import data is usually read from an agent export file. * @param {string} agentId agent id/name * @param {AgentExportInterface} importData agent import data. * @returns {Promise} Promise resolving to an agent object. */ export declare function importAgent({ agentId, importData, state, }: { agentId: string; importData: AgentExportInterface; state: State; }): Promise; /** * Import identity gateway agent. The import data is usually read from an agent export file. * @param {string} agentId agent id/name * @param {AgentExportInterface} importData agent import data. * @returns {Promise} Promise resolving to an agent object. */ export declare function importIdentityGatewayAgent({ agentId, importData, state, }: { agentId: string; importData: AgentExportInterface; state: State; }): Promise; /** * Import java agent. The import data is usually read from an agent export file. * @param {string} agentId agent id/name * @param {AgentExportInterface} importData agent import data. * @returns {Promise} Promise resolving to an agent object. */ export declare function importJavaAgent({ agentId, importData, state, }: { agentId: string; importData: AgentExportInterface; state: State; }): Promise; /** * Import java agent. The import data is usually read from an agent export file. * @param {string} agentId agent id/name * @param {AgentExportInterface} importData agent import data. * @returns {Promise} Promise resolving to an agent object. */ export declare function importWebAgent({ agentId, importData, state, }: { agentId: string; importData: AgentExportInterface; state: State; }): Promise; /** * Delete all agents */ export declare function deleteAgents({ state }: { state: State; }): Promise; /** * Delete all identity gateway agents */ export declare function deleteIdentityGatewayAgents({ state }: { state: State; }): Promise; /** * Delete all java agents */ export declare function deleteJavaAgents({ state }: { state: State; }): Promise; /** * Delete all web agents */ export declare function deleteWebAgents({ state }: { state: State; }): Promise; /** * Delete agent * @param agentId agent id/name */ export declare function deleteAgent({ agentId, state, }: { agentId: string; state: State; }): Promise; /** * Delete identity gateway agent * @param agentId agent id/name */ export declare function deleteIdentityGatewayAgent({ agentId, state, }: { agentId: string; state: State; }): Promise; /** * Delete java agent * @param agentId agent id/name */ export declare function deleteJavaAgent({ agentId, state, }: { agentId: string; state: State; }): Promise; /** * Delete web agent * @param agentId agent id/name */ export declare function deleteWebAgent({ agentId, state, }: { agentId: string; state: State; }): Promise; //# sourceMappingURL=AgentOps.d.ts.map