an empty agent export template
Create an empty agent group export template
an empty agent export template
Create AI agent
AI agent id
AIAgent object
OptionalincludeAgentIdentity: boolean
whether to create related AI agent identity objects
a promise that resolves to an object containing an AIAgent object
Create identity gateway agent
gateway id
IdentityGatewayAgent object
a promise that resolves to an object containing an IdentityGatewayAgent object
Create java agent
java agent id
java agent object
a promise that resolves to an object containing an java agent object
Create web agent
web agent id
WebAgent object
a promise that resolves to an object containing an WebAgent object
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.
agent id/name
Delete all agents. Agent types that have their own module (OAuth2 clients, trusted JWT issuers, CIMD profiles) are not deleted; see frodo.oauth2oidc.
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.
Delete AI agent and agent identity and privileges
agent id/name
Delete all AI agents and their agent identity and privileges
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.
Delete identity gateway agent
agent id/name
Delete all identity gateway agents
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.
Delete java agent
agent id/name
Delete all java agents
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.
Delete web agent
agent id/name
Delete all web agents
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.
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.
agent id/name
true if global agent is the target of the operation, false otherwise. Default: false.
Promise resolving to an AgentExportInterface object.
Export a single agent group by id. The response can be saved to file as is.
Group id
Promise resolving to a AgentGroupExportInterface object.
Export all agent groups. The response can be saved to file as is.
Promise resolving to a AgentGroupExportInterface 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.
true if global agent is the target of the operation, false otherwise. Default: false.
Promise resolving to an AgentExportInterface object.
Export AI agent. The response can be saved to file as is.
agent id/name
OptionalincludeAgentIdentity: boolean
whether to export related AI agent identity details
Promise resolving to an AgentExportInterface object.
Export all AI agents. The response can be saved to file as is.
Promise resolving to an AgentExportInterface object.
Export identity gateway agent. The response can be saved to file as is.
agent id/name
Promise resolving to an AgentExportInterface object.
Export all identity gateway agents. The response can be saved to file as is.
Promise resolving to an AgentExportInterface object.
Export java agent. The response can be saved to file as is.
agent id/name
Promise resolving to an AgentExportInterface object.
Export all java agents. The response can be saved to file as is.
Promise resolving to an AgentExportInterface object.
Export web agent. The response can be saved to file as is.
agent id/name
Promise resolving to an AgentExportInterface object.
Export all web agents. The response can be saved to file as is.
Promise resolving to an AgentExportInterface object.
Import agent. The import data is usually read from an agent export file.
agent id/name
agent import data.
true if global agent is the target of the operation, false otherwise. Default: false.
Promise resolving to an agent object.
Import agent group. The import data is usually read from an agent group export file.
agent group id/name
agent group import data.
Promise resolving to an agent group 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.
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.
The agent groups that were imported.
Import agents. The import data is usually read from an agent export file.
agent import data.
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.
The agents that were imported.
Import AI agent. The import data is usually read from an agent export file.
agent id/name
agent import data.
OptionalincludeAgentIdentity: boolean
whether to import related AI agent identity objects
Promise resolving to an agent object.
Import AI agents. The import data is usually read from an agent export file.
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.
Import identity gateway agent. The import data is usually read from an agent export file.
agent id/name
agent import data.
Promise resolving to an agent object.
Import identity gateway agents. The import data is usually read from an agent export file.
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.
Import java agent. The import data is usually read from an agent export file.
agent id/name
agent import data.
Promise resolving to an agent object.
Import java agents. The import data is usually read from an agent export file.
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.
Import web agent. The import data is usually read from an agent export file.
agent id/name
agent import data.
Promise resolving to an agent object.
Import web agents. The import data is usually read from an agent export file.
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.
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.
agent id/name
true if global agent is the target of the operation, false otherwise. Default: false.
a promise that resolves to an agent object
Read agent by type and id
agent type (IdentityGatewayAgent, J2EEAgent, WebAgent)
agent id/name
a promise that resolves to an agent object
Read agent group by id
Group id
a promise that resolves to a agent group object
Read all agent groups.
a promise that resolves to an array of agent group objects
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.
true if global agent is the target of the operation, false otherwise. Default: false.
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.
OptionalrefreshCache: boolean
true to ask the server again and replace the cached list of the realm. Default: false.
a promise that resolves to an array of agent type strings
Read AI agent
AI agent id
OptionalincludeAgentIdentity: boolean
whether to include related AI agent identity details
a promise that resolves to an object containing an AIAgent object
Read AI agents
OptionalincludeAgentIdentity: boolean
whether to include related AI agent identity details
a promise that resolves to an array of AIAgent objects
Read identity gateway agent
gateway id
a promise that resolves to an object containing an IdentityGatewayAgent object
Read identity gateway agents
a promise that resolves to an array of IdentityGatewayAgent objects
Read java agent
java agent id
a promise that resolves to an object containing an J2EEAgent object
Read java agents
a promise that resolves to an array of J2EEAgent objects
Read web agent
web agent id
a promise that resolves to an object containing an WebAgent object
Read web agents
a promise that resolves to an array of WebAgent objects
Update or create AI agent
AI agent id
AIAgent object
OptionalincludeAgentIdentity: boolean
whether to update related AI agent identity objects
a promise that resolves to an object containing an AIAgent object
Update or create identity gateway agent
gateway id
IdentityGatewayAgent object
a promise that resolves to an object containing an IdentityGatewayAgent object
Update or create java agent
java agent id
java agent object
a promise that resolves to an object containing an java agent object
Update or create web agent
web agent id
WebAgent object
a promise that resolves to an object containing an WebAgent object
Create an empty agent export template