Frodo Library - v5.0.0-47
    Preparing search index...

    Type Alias Agent

    type Agent = {
        createAgentExportTemplate(): AgentExportInterface;
        createAgentGroupExportTemplate(): AgentGroupExportInterface;
        createAIAgent(
            agentId: string,
            agentData: AmConfigEntityInterface,
            includeAgentIdentity?: boolean,
        ): Promise<AmConfigEntityInterface>;
        createIdentityGatewayAgent(
            gatewayId: string,
            gatewayData: AmConfigEntityInterface,
        ): Promise<AmConfigEntityInterface>;
        createJavaAgent(
            agentId: string,
            agentData: AmConfigEntityInterface,
        ): Promise<AmConfigEntityInterface>;
        createWebAgent(
            agentId: string,
            agentData: AmConfigEntityInterface,
        ): Promise<AmConfigEntityInterface>;
        deleteAgent(agentId: string): Promise<void>;
        deleteAgents(
            resultCallback?: ResultCallback<AmConfigEntityInterface>,
        ): Promise<void>;
        deleteAIAgent(agentId: string): Promise<void>;
        deleteAIAgents(
            resultCallback?: ResultCallback<AmConfigEntityInterface>,
        ): Promise<void>;
        deleteIdentityGatewayAgent(agentId: string): Promise<void>;
        deleteIdentityGatewayAgents(
            resultCallback?: ResultCallback<AmConfigEntityInterface>,
        ): Promise<void>;
        deleteJavaAgent(agentId: string): Promise<void>;
        deleteJavaAgents(
            resultCallback?: ResultCallback<AmConfigEntityInterface>,
        ): Promise<void>;
        deleteWebAgent(agentId: string): Promise<void>;
        deleteWebAgents(
            resultCallback?: ResultCallback<AmConfigEntityInterface>,
        ): Promise<void>;
        exportAgent(
            agentId: string,
            globalConfig: boolean,
        ): Promise<AgentExportInterface>;
        exportAgentGroup(groupId: string): Promise<AgentGroupExportInterface>;
        exportAgentGroups(): Promise<AgentGroupExportInterface>;
        exportAgents(globalConfig: boolean): Promise<AgentExportInterface>;
        exportAIAgent(
            agentId: string,
            includeAgentIdentity?: boolean,
        ): Promise<AgentExportInterface>;
        exportAIAgents(): Promise<AgentExportInterface>;
        exportIdentityGatewayAgent(agentId: string): Promise<AgentExportInterface>;
        exportIdentityGatewayAgents(): Promise<AgentExportInterface>;
        exportJavaAgent(agentId: string): Promise<AgentExportInterface>;
        exportJavaAgents(): Promise<AgentExportInterface>;
        exportWebAgent(agentId: string): Promise<AgentExportInterface>;
        exportWebAgents(): Promise<AgentExportInterface>;
        importAgent(
            agentId: string,
            importData: AgentExportInterface,
            globalConfig: boolean,
        ): Promise<AmConfigEntityInterface>;
        importAgentGroup(
            agentGroupId: string,
            importData: AgentGroupExportInterface,
        ): Promise<AmConfigEntityInterface>;
        importAgentGroups(
            importData: AgentGroupExportInterface,
            resultCallback?: ResultCallback<AmConfigEntityInterface>,
        ): Promise<AmConfigEntityInterface[]>;
        importAgents(
            importData: AgentExportInterface,
            globalConfig: boolean,
            resultCallback?: ResultCallback<AmConfigEntityInterface>,
        ): Promise<AmConfigEntityInterface[]>;
        importAIAgent(
            agentId: string,
            importData: AgentExportInterface,
            includeAgentIdentity?: boolean,
        ): Promise<AmConfigEntityInterface>;
        importAIAgents(
            importData: AgentExportInterface,
            includeAgentIdentity?: boolean,
            resultCallback?: ResultCallback<AmConfigEntityInterface>,
        ): Promise<void>;
        importIdentityGatewayAgent(
            agentId: string,
            importData: AgentExportInterface,
        ): Promise<AmConfigEntityInterface>;
        importIdentityGatewayAgents(
            importData: AgentExportInterface,
            resultCallback?: ResultCallback<AmConfigEntityInterface>,
        ): Promise<void>;
        importJavaAgent(
            agentId: string,
            importData: AgentExportInterface,
        ): Promise<AmConfigEntityInterface>;
        importJavaAgents(
            importData: AgentExportInterface,
            resultCallback?: ResultCallback<AmConfigEntityInterface>,
        ): Promise<void>;
        importWebAgent(
            agentId: string,
            importData: AgentExportInterface,
        ): Promise<AmConfigEntityInterface>;
        importWebAgents(
            importData: AgentExportInterface,
            resultCallback?: ResultCallback<AmConfigEntityInterface>,
        ): Promise<void>;
        readAgent(
            agentId: string,
            globalConfig: boolean,
        ): Promise<AmConfigEntityInterface>;
        readAgentByTypeAndId(
            agentType: AgentType,
            agentId: string,
        ): Promise<AmConfigEntityInterface>;
        readAgentGroup(groupId: string): Promise<AmConfigEntityInterface>;
        readAgentGroups(): Promise<AmConfigEntityInterface[]>;
        readAgents(globalConfig: boolean): Promise<AmConfigEntityInterface[]>;
        readAgentTypes(refreshCache?: boolean): Promise<AgentType[]>;
        readAIAgent(
            agentId: string,
            includeAgentIdentity?: boolean,
        ): Promise<AmConfigEntityInterface>;
        readAIAgents(
            includeAgentIdentity?: boolean,
        ): Promise<AmConfigEntityInterface[]>;
        readIdentityGatewayAgent(
            gatewayId: string,
        ): Promise<AmConfigEntityInterface>;
        readIdentityGatewayAgents(): Promise<AmConfigEntityInterface[]>;
        readJavaAgent(agentId: string): Promise<AmConfigEntityInterface>;
        readJavaAgents(): Promise<AmConfigEntityInterface[]>;
        readWebAgent(agentId: string): Promise<AmConfigEntityInterface>;
        readWebAgents(): Promise<AmConfigEntityInterface[]>;
        updateAIAgent(
            agentId: string,
            agentData: AmConfigEntityInterface,
            includeAgentIdentity?: boolean,
        ): Promise<AmConfigEntityInterface>;
        updateIdentityGatewayAgent(
            gatewayId: string,
            gatewayData: AmConfigEntityInterface,
        ): Promise<AmConfigEntityInterface>;
        updateJavaAgent(
            agentId: string,
            agentData: AmConfigEntityInterface,
        ): Promise<AmConfigEntityInterface>;
        updateWebAgent(
            agentId: string,
            agentData: AmConfigEntityInterface,
        ): Promise<AmConfigEntityInterface>;
    }
    Index
    • Delete agent. Agent types that have their own module (OAuth2 clients, trusted JWT issuers, CIMD profiles) are not searched: an agent of such a type is not found; see frodo.oauth2oidc.

      Parameters

      • agentId: string

        agent id/name

      Returns Promise<void>

    • Delete all agents. Agent types that have their own module (OAuth2 clients, trusted JWT issuers, CIMD profiles) are not deleted; see frodo.oauth2oidc.

      Parameters

      • OptionalresultCallback: ResultCallback<AmConfigEntityInterface>

        Optional callback to process individual results. When given, the outcome of every delete is passed to it as it happens (a failed delete as an error that names the agent) and a failed delete does not throw. Without it, the failures are collected and thrown as one error after every agent was tried. Failing to read the agents always throws.

      Returns Promise<void>

    • Delete AI agent and agent identity and privileges

      Parameters

      • agentId: string

        agent id/name

      Returns Promise<void>

    • Delete all AI agents and their agent identity and privileges

      Parameters

      • OptionalresultCallback: ResultCallback<AmConfigEntityInterface>

        Optional callback to process individual results. When given, the outcome of every delete is passed to it as it happens (a failed delete as an error that names the agent) and a failed delete does not throw. Without it, the failures are collected and thrown as one error after every agent was tried. Failing to read the agents always throws.

      Returns Promise<void>

    • Delete identity gateway agent

      Parameters

      • agentId: string

        agent id/name

      Returns Promise<void>

    • Delete all identity gateway agents

      Parameters

      • OptionalresultCallback: ResultCallback<AmConfigEntityInterface>

        Optional callback to process individual results. When given, the outcome of every delete is passed to it as it happens (a failed delete as an error that names the agent) and a failed delete does not throw. Without it, the failures are collected and thrown as one error after every agent was tried. Failing to read the agents always throws.

      Returns Promise<void>

    • Delete java agent

      Parameters

      • agentId: string

        agent id/name

      Returns Promise<void>

    • Delete all java agents

      Parameters

      • OptionalresultCallback: ResultCallback<AmConfigEntityInterface>

        Optional callback to process individual results. When given, the outcome of every delete is passed to it as it happens (a failed delete as an error that names the agent) and a failed delete does not throw. Without it, the failures are collected and thrown as one error after every agent was tried. Failing to read the agents always throws.

      Returns Promise<void>

    • Delete web agent

      Parameters

      • agentId: string

        agent id/name

      Returns Promise<void>

    • Delete all web agents

      Parameters

      • OptionalresultCallback: ResultCallback<AmConfigEntityInterface>

        Optional callback to process individual results. When given, the outcome of every delete is passed to it as it happens (a failed delete as an error that names the agent) and a failed delete does not throw. Without it, the failures are collected and thrown as one error after every agent was tried. Failing to read the agents always throws.

      Returns Promise<void>

    • Export agent. The response can be saved to file as is. At realm level, agent types that have their own module (OAuth2 clients, trusted JWT issuers, CIMD profiles) are not searched: an agent of such a type is not found; see frodo.oauth2oidc.

      Parameters

      • agentId: string

        agent id/name

      • globalConfig: boolean

        true if global agent is the target of the operation, false otherwise. Default: false.

      Returns Promise<AgentExportInterface>

      Promise resolving to an AgentExportInterface object.

    • Export all agents. The response can be saved to file as is. At realm level, agent types that have their own module (OAuth2 clients, trusted JWT issuers, CIMD profiles) are not included; see frodo.oauth2oidc.

      Parameters

      • globalConfig: boolean

        true if global agent is the target of the operation, false otherwise. Default: false.

      Returns Promise<AgentExportInterface>

      Promise resolving to an AgentExportInterface object.

    • Export AI agent. The response can be saved to file as is.

      Parameters

      • agentId: string

        agent id/name

      • OptionalincludeAgentIdentity: boolean

        whether to export related AI agent identity details

      Returns Promise<AgentExportInterface>

      Promise resolving to an AgentExportInterface object.

    • Export identity gateway agent. The response can be saved to file as is.

      Parameters

      • agentId: string

        agent id/name

      Returns Promise<AgentExportInterface>

      Promise resolving to an AgentExportInterface object.

    • Import agent. The import data is usually read from an agent export file.

      Parameters

      • agentId: string

        agent id/name

      • importData: AgentExportInterface

        agent import data.

      • globalConfig: boolean

        true if global agent is the target of the operation, false otherwise. Default: false.

      Returns Promise<AmConfigEntityInterface>

      Promise resolving to an agent object.

    • Import agents groups. The import data is usually read from an agent group export file. Every agent group is tried: an agent group that cannot be imported does not stop the others.

      Parameters

      • importData: AgentGroupExportInterface

        agent import data.

      • OptionalresultCallback: ResultCallback<AmConfigEntityInterface>

        Optional callback to process individual results. When given, the outcome of every agent group is passed to it as it happens (a failed agent group as an error that names the agent group and its type, with the cause nested) and a failed agent group does not throw: the agent groups that could be imported are returned. Without it, the failures are collected and thrown as one error after every agent group was tried. An agent group type that answers HTTP 501 is a failed agent group like any other.

      Returns Promise<AmConfigEntityInterface[]>

      The agent groups that were imported.

    • Import agents. The import data is usually read from an agent export file.

      Parameters

      • importData: AgentExportInterface

        agent import data.

      • globalConfig: boolean

        true if global agent is the target of the operation, false otherwise. Default: false.

      • OptionalresultCallback: ResultCallback<AmConfigEntityInterface>

        Optional callback to process individual results. When given, the outcome of every agent is passed to it as it happens (a failed agent as an error that names the agent and its type) and a failed agent does not throw. Without it, the failures are collected and thrown as one error after every agent was tried.

      Returns Promise<AmConfigEntityInterface[]>

      The agents that were imported.

    • Import AI agents. The import data is usually read from an agent export file.

      Parameters

      • importData: AgentExportInterface

        agent import data.

      • OptionalincludeAgentIdentity: boolean

        whether to import related AI agent identity objects

      • OptionalresultCallback: ResultCallback<AmConfigEntityInterface>

        Optional callback to process individual results. When given, the outcome of every agent is passed to it as it happens (a failed agent as an error that names the agent and its type) and a failed agent does not throw. Without it, the failures are collected and thrown as one error after every agent was tried.

      Returns Promise<void>

    • Import identity gateway agents. The import data is usually read from an agent export file.

      Parameters

      • importData: AgentExportInterface

        agent import data.

      • OptionalresultCallback: ResultCallback<AmConfigEntityInterface>

        Optional callback to process individual results. When given, the outcome of every agent is passed to it as it happens (a failed agent as an error that names the agent and its type) and a failed agent does not throw. Without it, the failures are collected and thrown as one error after every agent was tried.

      Returns Promise<void>

    • Import java agents. The import data is usually read from an agent export file.

      Parameters

      • importData: AgentExportInterface

        agent import data.

      • OptionalresultCallback: ResultCallback<AmConfigEntityInterface>

        Optional callback to process individual results. When given, the outcome of every agent is passed to it as it happens (a failed agent as an error that names the agent and its type) and a failed agent does not throw. Without it, the failures are collected and thrown as one error after every agent was tried.

      Returns Promise<void>

    • Import web agents. The import data is usually read from an agent export file.

      Parameters

      • importData: AgentExportInterface

        agent import data.

      • OptionalresultCallback: ResultCallback<AmConfigEntityInterface>

        Optional callback to process individual results. When given, the outcome of every agent is passed to it as it happens (a failed agent as an error that names the agent and its type) and a failed agent does not throw. Without it, the failures are collected and thrown as one error after every agent was tried.

      Returns Promise<void>

    • Read agent. At realm level, agent types that have their own module (OAuth2 clients, trusted JWT issuers, CIMD profiles) are not searched: an agent of such a type is not found; see frodo.oauth2oidc.

      Parameters

      • agentId: string

        agent id/name

      • globalConfig: boolean

        true if global agent is the target of the operation, false otherwise. Default: false.

      Returns Promise<AmConfigEntityInterface>

      a promise that resolves to an agent object

    • Read all agents. At realm level, agent types that have their own module (OAuth2 clients, trusted JWT issuers, CIMD profiles) are not included; see frodo.oauth2oidc.

      Parameters

      • globalConfig: boolean

        true if global agent is the target of the operation, false otherwise. Default: false.

      Returns Promise<AmConfigEntityInterface[]>

      a promise that resolves to an array of agent objects

    • Read all agent types. Agent types that have their own module (OAuth2 clients, trusted JWT issuers, CIMD profiles) are not part of the answer; see frodo.oauth2oidc.

      Parameters

      • OptionalrefreshCache: boolean

        true to ask the server again and replace the cached list of the realm. Default: false.

      Returns Promise<AgentType[]>

      a promise that resolves to an array of agent type strings

    • Read AI agent

      Parameters

      • agentId: string

        AI agent id

      • OptionalincludeAgentIdentity: boolean

        whether to include related AI agent identity details

      Returns Promise<AmConfigEntityInterface>

      a promise that resolves to an object containing an AIAgent object

    • Read AI agents

      Parameters

      • OptionalincludeAgentIdentity: boolean

        whether to include related AI agent identity details

      Returns Promise<AmConfigEntityInterface[]>

      a promise that resolves to an array of AIAgent objects