A hybrid (ESM and CJS) library to manage PingOne Advanced Identity Cloud environments, ForgeOps deployments, and classic deployments.
Frodo-lib powers frodo-cli, the command line tool to manage ForgeRock deployments.
@@ -374,4 +374,4 @@Please use the repository's issues to request new features/enhancements or report bugs/issues.
If you would like to contribute to frodo, please refer to the contributing instructions.
If you are a maintainer of this repository, please refer to the pipeline and release process instructions.
-Optional metaOptional metaOptional metaOptional metaOptional _idOptional _revOptional _typeOptional _idOptional _revOptional _typeExport format for applications
+Optional applicationOAuth2 clients
-Optional connectorconnectors
-Managed applications
-Optional mappingmappings
-Optional metaMetadata
-Optional samlSaml providers, circles of trust, and metadata
-Optional cot?: Record<string, CircleOfTrustSkeleton>Optional hosted?: Record<string, Saml2ProviderSkeleton>Optional metadata?: Record<string, string[]>Optional remote?: Record<string, Saml2ProviderSkeleton>Optional scriptScripts
-Optional connectorconnectors
+Managed applications
+Optional mappingmappings
+Optional metaMetadata
+Optional samlSaml providers, circles of trust, and metadata
+Optional cot?: Record<string, CircleOfTrustSkeleton>Optional hosted?: Record<string, Saml2ProviderSkeleton>Optional metadata?: Record<string, string[]>Optional remote?: Record<string, Saml2ProviderSkeleton>Optional scriptScripts
+Optional metaOptional metaOptional metaOptional metaOptional metaOptional metaIdm export options
-Idm export options
+Optional entitiesGives a list of entities to export. If undefined or empty, it will export all entities.
-Optional envGives the list of key-value pairs of env replacements. Replaces each occurrence of the value with '${key}', where key is the correspond key to the value.
-Optional envGives the list of key-value pairs of env replacements. Replaces each occurrence of the value with '${key}', where key is the correspond key to the value.
+Config entity import options
-Config entity import options
+Optional entitiesGives a list of entities to import. If undefined or empty, it will import all entities.
-Optional envGives the list of key-value pairs of env replacements. Replaces each occurrence of '${key}' with its value.
-validate script hooks
-Optional envGives the list of key-value pairs of env replacements. Replaces each occurrence of '${key}' with its value.
+validate script hooks
+Optional adminOptional adminOptional allowOptional authenticationOptional authenticationOptional deploymentOptional idmOptional logOptional logOptional passwordOptional svcacctOptional svcacctOptional svcacctOptional svcacctOptional usernameOptional adminOptional adminOptional allowOptional authenticationOptional authenticationOptional deploymentOptional idmOptional logOptional logOptional passwordOptional svcacctOptional svcacctOptional svcacctOptional svcacctOptional usernameOptional mappingOptional metaOptional mappingOptional metaConnector export options
-Use string arrays to store multi-line text in scripts.
+Connector import options
-Optional metaOptional metaOptional _idOptional _revOptional _idOptional _revOptional metaOptional metaFull export options
-Full export options
+Include x and y coordinate positions of the journey/tree nodes.
-Include active and loaded secret values
-Include default scripts in export if true
-Do not include decoded variable value in export
-Optional targetHost URL of target environment to encrypt secret values for
-Use string arrays to store multi-line text in scripts.
-Include active and loaded secret values
+Include default scripts in export if true
+Do not include decoded variable value in export
+Optional targetHost URL of target environment to encrypt secret values for
+Use string arrays to store multi-line text in scripts.
+Full import options
-Full import options
+Indicates whether to remove previously existing services of the same id before importing
-Include active secret values
-Include default scripts in import if true
-Generate new UUIDs for all journey nodes during import.
-Generate new UUIDs for all scripts during import.
-Optional sourceHost URL of source environment to decrypt secret values from
-Include active secret values
+Include default scripts in import if true
+Generate new UUIDs for all journey nodes during import.
+Generate new UUIDs for all scripts during import.
+Optional sourceHost URL of source environment to decrypt secret values from
+Optional _idOptional _revOptional _typeOptional nextOptional _idOptional _revOptional _typeOptional nextOptional _idOptional _revOptional _idOptional _revOptional key_Optional kidOptional useOptional x5cOptional x5tOptional x5t#Optional x5uOptional key_Optional kidOptional useOptional x5cOptional x5tOptional x5t#Optional x5uOptional fromOptional valueOptional fromOptional valueOptional metaOptional metaMapping export options
-Mapping export options
+Optional connectorlimit mappings to connector
-Include any dependencies.
-Optional molimit mappings to managed object type
-Use string arrays to store multi-line text in scripts.
-Include any dependencies.
+Optional molimit mappings to managed object type
+Use string arrays to store multi-line text in scripts.
+Mapping import options
-Optional metaOptional metaOptional _revOptional _revOptional metaOptional scriptOptional metaOptional scriptOAuth2 client export options
-Use string arrays to store multi-line text in scripts.
+OAuth2 client import options
-Optional metaOptional metaOAuth2 trusted jwt issuer export options
-Use string arrays to store multi-line text in scripts.
+OAuth2 trusted jwt issuer import options
-Optional bearerOptional bearerOptional metaOptional metaPolicy export options
-Policy export options
+Include any dependencies (scripts).
-Include any prerequisites (policy sets, resource types).
-Use string arrays to store multi-line text in scripts.
-Include any prerequisites (policy sets, resource types).
+Use string arrays to store multi-line text in scripts.
+Policy import options
-Policy import options
+Include any dependencies (scripts).
-Optional policyImport policies into different policy set
-Include any prerequisites (policy sets, resource types).
-Optional policyImport policies into different policy set
+Include any prerequisites (policy sets, resource types).
+Optional metaOptional metaApplication/policy set export options
-Application/policy set export options
+Include any dependencies (policies, scripts, resource types).
-Include any prerequisites (policy sets, resource types).
-Use string arrays to store multi-line text in scripts.
-Include any prerequisites (policy sets, resource types).
+Use string arrays to store multi-line text in scripts.
+Policy set import options
-Include any prerequisites (policy sets, resource types).
+Optional metaOptional metaOptional metaOptional metaOptional metaScript export options
-Script export options
+Include dependency (library) scripts in export
-Include default scripts in export if true
-Use string arrays to store script code
-Include default scripts in export if true
+Use string arrays to store script code
+Script import options
-Include default scripts in import if true
+Generate new UUIDs for all scripts during import.
+Optional metaOptional adminOptional adminOptional allowOptional authenticationOptional authenticationOptional deploymentOptional encodedOptional encodedOptional encodedOptional idmOptional logOptional svcacctOptional svcacctOptional svcacctOptional usernameOptional adminOptional adminOptional allowOptional authenticationOptional authenticationOptional deploymentOptional encodedOptional encodedOptional encodedOptional idmOptional logOptional svcacctOptional svcacctOptional svcacctOptional usernameOptional metaOptional metaService import options
-Service import options
+Indicates whether to remove previously existing services of the same id before importing
-Indicates whether to import service(s) as global services
-Indicates whether to import service(s) to the current realm
-Indicates whether to import service(s) as global services
+Indicates whether to import service(s) to the current realm
+Optional innerOptional innernodesOptional metaOptional innerOptional innernodesOptional metaSocial identity provider export options
-Use string arrays to store multi-line text in scripts.
+Social identity provider import options
-Optional metaOptional metaOptional adminOptional adminOptional allowOptional amOptional authenticationOptional authenticationOptional autoOptional bearerOptional connectionOptional cookieOptional createOptional total: numberOptional message: stringOptional curlirizeOptional curlirizeOptional debugOptional debugOptional deploymentOptional directoryOptional errorOptional featuresOptional frodoOptional hostOptional idmOptional logOptional logOptional masterOptional outputOptional passwordOptional printOptional type: stringOptional newline: booleanOptional realmOptional serviceOptional serviceOptional serviceOptional stopOptional status: stringOptional tokenOptional updateOptional useOptional useOptional userOptional usernameOptional verboseOptional verboseOptional adminOptional adminOptional allowOptional amOptional authenticationOptional authenticationOptional autoOptional bearerOptional connectionOptional cookieOptional createOptional total: numberOptional message: stringOptional curlirizeOptional curlirizeOptional debugOptional debugOptional deploymentOptional directoryOptional errorOptional featuresOptional frodoOptional hostOptional idmOptional logOptional logOptional masterOptional outputOptional passwordOptional printOptional type: stringOptional newline: booleanOptional realmOptional serviceOptional serviceOptional serviceOptional stopOptional status: stringOptional tokenOptional updateOptional useOptional useOptional userOptional usernameOptional verboseOptional verboseOptional fromOptional valueOptional fromOptional valueOptional metaTree export options
-Tree export options
+Include x and y coordinate positions of the journey/tree nodes.
-Include any dependencies (scripts, email templates, SAML entity providers and circles of trust, social identity providers, themes).
-Where applicable, use string arrays to store multi-line text (e.g. scripts).
-Include any dependencies (scripts, email templates, SAML entity providers and circles of trust, social identity providers, themes).
+Where applicable, use string arrays to store multi-line text (e.g. scripts).
+Tree import options
-Generate new UUIDs for all nodes during import.
+Updates that need to be applied.
-Optional variablesArray of variables that need applying
+Optional metaOptional metaOptional from_Optional from_Optional id_Optional id_Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.
-Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.
-Optional scope: string[]Optional jwk: JwkRsaOptional sub: stringOptional scope: string[]Optional options: { Optional aud: stringOptional jwk: JwkRsaOptional options: { Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.
-Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.
-Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.
-Optional customUsernames: string[]Optional customUserAgents: string[]Optional customIPs: string[]Optional loginsPerUser: numberOptional service: stringDeprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.
+Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.
+Optional scope: string[]Optional jwk: JwkRsaOptional sub: stringOptional scope: string[]Optional options: { Optional aud: stringOptional jwk: JwkRsaOptional options: { Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.
+Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.
+Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.
+Optional customUsernames: string[]Optional customUserAgents: string[]Optional customIPs: string[]Optional loginsPerUser: numberOptional service: stringCreate an empty idp export template
+Create an empty idp export template
an empty idp export template
-Create admin federation provider
+Create admin federation provider
social identity provider type
social identity provider data
Optional providerId: stringsocial identity provider id/name
a promise that resolves a social admin federation object
-Delete admin federation provider by id
+Delete admin federation provider by id
admin federation provider id/name
a promise that resolves to an admin federation provider object
-Export admin federation provider by id
+Export admin federation provider by id
provider id/name
a promise that resolves to a SocialProviderExportInterface object
-Export all providers
+Export all providers
a promise that resolves to a SocialProviderExportInterface object
-Get admin federation provider
+Get admin federation provider
social identity provider id/name
a promise that resolves a social admin federation object
since v2.0.0 use readAdminFederationProvider instead
readAdminFederationProvider(providerId: string): Promise<SocialIdpSkeleton>
Get all admin federation providers
+Get all admin federation providers
a promise that resolves to an object containing an array of admin federation providers
since v2.0.0 use readAdminFederationProviders instead
readAdminFederationProviders(): Promise<SocialIdpSkeleton[]>
Import admin federation provider by id/name
+Import admin federation provider by id/name
provider id/name
import data
-Import all providers
+Import all providers
import data
-Import first provider
+Import first provider
import data
-Update or create admin federation provider
+Update or create admin federation provider
social identity provider type
social identity provider id/name
social identity provider data
@@ -39,14 +39,14 @@since v2.0.0 use updateAdminFederationProvider instead
updateAdminFederationProvider(providerType: string, providerId: string, providerData: SocialIdpSkeleton): Promise<SocialIdpSkeleton>
Read admin federation provider
+Read admin federation provider
social identity provider id/name
a promise that resolves a social admin federation object
-Read all admin federation providers
+Read all admin federation providers
a promise that resolves to an object containing an array of admin federation providers
-Update or create admin federation provider
+Update or create admin federation provider
social identity provider type
social identity provider id/name
social identity provider data
a promise that resolves a social admin federation object
-Create an empty agent export template
+Create an empty agent export template
an empty agent export template
-Create identity gateway agent
+Create identity gateway agent
gateway id
IdentityGatewayAgent object
a promise that resolves to an object containing an IdentityGatewayAgent object
-Put java agent
+Put java agent
java agent id
java agent object
a promise that resolves to an object containing an java agent object
-Create web agent
+Create web agent
web agent id
WebAgent object
a promise that resolves to an object containing an WebAgent object
-Export agent. The response can be saved to file as is.
+Export agent. The response can be saved to file as is.
agent id/name
Promise resolving to an AgentExportInterface object.
-Export all agents. The response can be saved to file as is.
+Export all 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.
+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.
+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.
+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.
+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.
+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.
+Export all web agents. The response can be saved to file as is.
Promise resolving to an AgentExportInterface object.
-Get agent
+Get agent
agent id/name
a promise that resolves to an agent object
Get agent by type and id
+Get agent by type and id
agent type (IdentityGatewayAgent, J2EEAgent, WebAgent)
agent id/name
a promise that resolves to an agent object
since v2.0.0 use readAgentByTypeAndId instead
readAgentByTypeAndId(agentType: AgentType, agentId: string): Promise<AgentSkeleton>
Get all agents.
+Get all agents.
a promise that resolves to an array of agent objects
Get identity gateway agent
+Get identity gateway agent
gateway id
a promise that resolves to an object containing an IdentityGatewayAgent object
since v2.0.0 use readIdentityGatewayAgent instead
readIdentityGatewayAgent(gatewayId: string): Promise<AgentSkeleton>
Get identity gateway agents
+Get identity gateway agents
a promise that resolves to an array of IdentityGatewayAgent objects
since v2.0.0 use readIdentityGatewayAgents instead
readIdentityGatewayAgents(): Promise<AgentSkeleton[]>
Get java agent
+Get java agent
java agent id
a promise that resolves to an object containing an J2EEAgent object
since v2.0.0 use readJavaAgent instead
readJavaAgent(agentId: string): Promise<AgentSkeleton>
Get java agents
+Get java agents
a promise that resolves to an array of J2EEAgent objects
Get web agent
+Get web agent
web agent id
a promise that resolves to an object containing an WebAgent object
since v2.0.0 use readWebAgent instead
readWebAgent(agentId: string): Promise<AgentSkeleton>
Get web agents
+Get web agents
a promise that resolves to an array of WebAgent objects
Import agent. The import data is usually read from an agent export file.
+Import 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 agents. The import data is usually read from an agent export file.
+Import agents. The import data is usually read from an agent export file.
agent import data.
The agents that were imported.
-Import identity gateway agent. The import data is usually read from an agent export file.
+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.
+Import identity gateway agents. The import data is usually read from an agent export file.
agent import data.
-Import java agent. The import data is usually read from an agent export file.
+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.
+Import java agents. The import data is usually read from an agent export file.
agent import data.
-Import java agent. The import data is usually read from an agent export file.
+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 web agents. The import data is usually read from an agent export file.
+Import web agents. The import data is usually read from an agent export file.
agent import data.
-Update or create identity gateway agent
+Update or create identity gateway agent
gateway id
IdentityGatewayAgent object
a promise that resolves to an object containing an IdentityGatewayAgent object
since v2.0.0 use updateIdentityGatewayAgent or createIdentityGatewayAgent instead
updateIdentityGatewayAgent(gatewayId: string, gatewayData: AgentSkeleton): Promise<AgentSkeleton>
createIdentityGatewayAgent(gatewayId: string, gatewayData: AgentSkeleton): Promise<AgentSkeleton>
Update or create java agent
+Update or create java agent
java agent id
java agent object
a promise that resolves to an object containing an java agent object
since v2.0.0 use updateJavaAgent or createJavaAgent instead
updateJavaAgent(agentId: string, agentData: AgentSkeleton): Promise<AgentSkeleton>
createJavaAgent(agentId: string, agentData: AgentSkeleton): Promise<AgentSkeleton>
Update or create web agent
+Update or create web agent
web agent id
WebAgent object
a promise that resolves to an object containing an WebAgent object
since v2.0.0 use updateWebAgent or createWebAgent instead
updateWebAgent(agentId: string, agentData: AgentSkeleton): Promise<AgentSkeleton>
createWebAgent(agentId: string, agentData: AgentSkeleton): Promise<AgentSkeleton>
Read agent
+Read agent
agent id/name
a promise that resolves to an agent object
-Read agent by type and id
+Read agent by type and id
agent type (IdentityGatewayAgent, J2EEAgent, WebAgent)
agent id/name
a promise that resolves to an agent object
-Read all agents.
+Read all agents.
a promise that resolves to an array of agent objects
-Read identity gateway agent
+Read identity gateway agent
gateway id
a promise that resolves to an object containing an IdentityGatewayAgent object
-Read identity gateway agents
+Read identity gateway agents
a promise that resolves to an array of IdentityGatewayAgent objects
-Read java agent
+Read java agent
java agent id
a promise that resolves to an object containing an J2EEAgent object
-Read java agents
+Read java agents
a promise that resolves to an array of J2EEAgent objects
-Read web agent
+Read web agent
web agent id
a promise that resolves to an object containing an WebAgent object
-Read web agents
+Read web agents
a promise that resolves to an array of WebAgent objects
-Update or create identity gateway agent
+Update or create identity gateway agent
gateway id
IdentityGatewayAgent object
a promise that resolves to an object containing an IdentityGatewayAgent object
-Put java agent
+Put 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
+Update or create web agent
web agent id
WebAgent object
a promise that resolves to an object containing an WebAgent object
-Create application
+Create application
application id/name
application data
a promise that resolves to an application object
-Create an empty application export template
+Create an empty application export template
an empty application export template
-Delete application
+Delete application
application uuid
Optional deep: booleandeep delete (remove dependencies)
a promise that resolves to an application object
-Delete application by name
+Delete application by name
application name
Optional deep: booleandeep delete (remove dependencies)
a promise that resolves to an application object
-Delete all applications
+Delete all applications
Optional deep: booleandeep delete (remove dependencies)
a promise that resolves to an array of application objects
-Export application. The response can be saved to file as is.
+Export application. The response can be saved to file as is.
application uuid
export options
Promise resolving to an ApplicationExportInterface object.
-Export application by name. The response can be saved to file as is.
+Export application by name. The response can be saved to file as is.
application name
export options
Promise resolving to an ApplicationExportInterface object.
-Export all applications. The response can be saved to file as is.
+Export all applications. The response can be saved to file as is.
Optional options: ApplicationExportOptionsPromise resolving to an ApplicationExportInterface object.
-Get application managed object type
+Import application. The import data is usually read from an application export file.
+Import application. The import data is usually read from an application export file.
application uuid
application import data.
Promise resolving to an application object.
-Import application by name. The import data is usually read from an application export file.
+Import application by name. The import data is usually read from an application export file.
application name
application import data.
Promise resolving to an application object.
-Import applications. The import data is usually read from an application export file.
+Import applications. The import data is usually read from an application export file.
application import data.
-Import first application. The import data is usually read from an application export file.
+Import first application. The import data is usually read from an application export file.
application import data.
-Query applications
+Query applications
CREST search filter
Optional fields: string[]array of fields to return
-Read application
+Read application
application uuid
a promise that resolves to an application object
-Read application by name
+Read application by name
application name
a promise that resolves to an application object
-Read all applications. Results are sorted aphabetically.
+Read all applications. Results are sorted aphabetically.
a promise that resolves to an array of application objects
-Update application
+Update application
application uuid
application data
a promise that resolves to an application object
-Application export options
+Application export options
Include any dependencies (scripts, oauth2 clients, saml providers, circles of trust, etc).
Use string arrays to store multi-line text in scripts.
-Application export options
+Application export options
Import any dependencies (scripts).
-Get access token for service account
+Get tokens and store them in State
+Get tokens and store them in State
Optional forceLoginAsUser: booleantrue to force login as user even if a service account is available (default: false)
Optional autoRefresh: booleantrue to automatically refresh tokens before they expire (default: true)
Optional types: string[]Array of supported deployment types. The function will throw an error if an unsupported type is detected (default: ['classic', 'cloud', 'forgeops'])
Optional callbackHandler: CallbackHandlerfunction allowing the library to collect responses from the user through callbacks
object containing the tokens
-Export authentication settings
+Export authentication settings
a promise that resolves to an AuthenticationSettingsExportInterface object
-Import authentication settings
+Import authentication settings
import data
-Read authentication settings
+Read authentication settings
a promise that resolves an authentication settings object
-Update authentication settings
+Update authentication settings
authentication settings data
a promise that resolves an authentication settings object
-Optional status?: stringOptional trustedOptional status?: stringOptional trustedCreate circle of trust
+Create circle of trust
Optional cotId: stringcircle of trust id/name
Optional cotData: CircleOfTrustSkeletoncircle of trust data
-Create an empty agent export template
+Create an empty agent export template
an empty agent export template
-Delete circle of trust
+Delete circle of trust
circle of trust id/name
-Delete circles of trust
+Delete circles of trust
Optional entityProviders: string[]filter by entity providers
-Export circle of trust
+Export circle of trust
circle of trust id/name
-Export all circles of trust
+Export all circles of trust
Optional entityProviders: string[]filter by entity providers
-Get circle of trust
+Get circle of trust
circle of trust id/name
a promise resolving to a circle of trust object
since v2.0.0 use readCircleOfTrust instead
readCircleOfTrust(cotId: string): Promise<CircleOfTrustSkeleton>
Get all circles of trust
+Get all circles of trust
a promise resolving to an array of circle of trust objects
since v2.0.0 use readCirclesOfTrust instead
readCirclesOfTrust(): Promise<CircleOfTrustSkeleton[]>
Import a circle of trust by id/name from file
+Import a circle of trust by id/name from file
Circle of trust id/name
Import data
a promise resolving to the circle of trust object that was created or updated. Note: If the circle of trust already exists and does not need updating, null is returned.
-Import all circles of trust
+Import all circles of trust
Import data
Optional entityProviders: string[]filter by entity providers
a promise resolving to an array of circle of trust objects that were created or updated. Note: If a circle of trust already exists and does not need updating, it is omitted from the response array.
-Import first circle of trust
+Import first circle of trust
Import data
a promise resolving to the circle of trust object that was created or updated. Note: If the circle of trust already exists and does not need updating, null is returned.
-Read circle of trust
+Read circle of trust
circle of trust id/name
-Read all circles of trust
+Read all circles of trust
Optional entityProviders: string[]filter by entity providers
-Update circle of trust
+Update circle of trust
circle of trust id/name
circle of trust data
-Export full configuration
+Export full configuration
export options
Optional collectErrors: Error[]optional parameter to collect errors instead of having the function throw. Pass an empty array to collect errors and report on them but have the function perform all it can and return the export data even if it encounters errors.
a promise resolving to a full export object
-Import full configuration
+Import full configuration
import data
import options
Optional collectErrors: Error[]optional parameter to collect errors instead of having the function throw. Pass an empty array to collect errors and report on them but have the function perform all it can and return the export data even if it encounters errors.
-Create a new service account using auto-generated parameters
+Create a new service account using auto-generated parameters
A promise resolving to a service account object
-Delete connection profile
+Find connection profiles
+Find connection profiles
connection profile object
host url or unique substring
Array of connection profiles
-Get connection profile
+Get connection profile
connection profile or null
-Get connection profile by host
+Get connection profile by host
host tenant host url or unique substring
connection profile or null
-Get connection profiles file name
+Initialize connection profiles
+Connector type key used to build the IDM id: '
Connector type key used to build the IDM id: '
Create connector
id/name of the connector without the type prefix
connector object
a promise that resolves to an connector object
-Create an empty connector export template
+Create an empty connector export template
an empty connector export template
-Delete connector
+Delete connector
id/name of the connector without the type prefix
a promise that resolves an connector object
-Delete all connectors
+Delete all connectors
a promise that resolves to an array of connector objects
-Export connector
+Export connector
id/name of the connector without the type prefix
Optional options: ConnectorExportOptionsexport options
a promise that resolves to a ConnectorExportInterface object
-Export all connectors
+Export all connectors
a promise that resolves to a ConnectorExportInterface object
-Import connector
+Import connector
id/name of the connector without the type prefix
import data
Optional options: ConnectorImportOptionsimport options
a promise resolving to a ConnectorSkeleton object
-Import all connectors
+Import all connectors
import data
Optional options: ConnectorImportOptionsimport options
a promise resolving to an array of ConnectorSkeleton objects
-Import first connector
+Import first connector
import data
Optional options: ConnectorImportOptionsimport options
a promise resolving to a ConnectorSkeleton object
-Get connector
+Get connector
id/name of the connector without the type prefix
a promise that resolves an connector object
-Get all connectors
+Get all connectors
a promise that resolves to an array of connector objects
-Update or create connector
+Update or create connector
id/name of the connector without the type prefix
connector object
a promise that resolves to an connector object
-Optional status?: stringOptional status?: stringEmail template type key used to build the IDM id: 'emailTemplate/
Email template type key used to build the IDM id: 'emailTemplate/
Create email template
id/name of the email template without the type prefix
email template object
a promise that resolves to an email template object
-Create an empty email template export template
+Create an empty email template export template
an empty email template export template
-Delete email template
+Delete email template
id/name of the email template without the type prefix 'emailTemplate/'
a promise that resolves an email template object
-Delete all email templates
+Delete all email templates
a promise that resolves to an array of email template objects
-Export all email templates. The response can be saved to file as is.
+Export all email templates. The response can be saved to file as is.
Promise resolving to a EmailTemplateExportInterface object.
-Get email template
+Get email template
id/name of the email template without the type prefix
a promise that resolves an email template object
since v2.0.0 use readEmailTemplate instead
readEmailTemplate(templateId: string): Promise<EmailTemplateSkeleton>
Get all email templates
+Get all email templates
a promise that resolves to an array of email template objects
since v2.0.0 use readEmailTemplates instead
readEmailTemplates(): Promise<EmailTemplateSkeleton[]>
Import all email templates
+Import all email templates
import data
a promise resolving to an array of email template objects
-Put email template
+Put email template
id/name of the email template without the type prefix
email template object
a promise that resolves to an email template object
since v2.0.0 use updateEmailTemplate or createEmailTemplate instead
updateEmailTemplate(templateId: string, templateData: EmailTemplateSkeleton): Promise<EmailTemplateSkeleton>
createEmailTemplate(templateId: string, templateData: EmailTemplateSkeleton): Promise<EmailTemplateSkeleton>
Get email template
+Get email template
id/name of the email template without the type prefix
a promise that resolves an email template object
-Get all email templates
+Get all email templates
a promise that resolves to an array of email template objects
-Update or create email template
+Update or create email template
id/name of the email template without the type prefix
email template object
a promise that resolves to an email template object
-Optional defaultOptional displayOptional enabled?: booleanOptional html?: Record<string, string>Optional message?: Record<string, string>Optional defaultOptional displayOptional enabled?: booleanOptional html?: Record<string, string>Optional message?: Record<string, string>Append text data to file
+Find files by name
file name to search for
Optional fast: booleanreturn first result and stop search
Optional path: stringpath to directory where to start the search
array of found file paths relative to starting directory
-Check if a string is a valid URL
+find all (nested) files in a directory
+Save JSON object to file
+Save JSON object to file
data object
file name
Optional includeMeta: booleantrue to include metadata, false otherwise. Default: true
true if successful, false otherwise
-Get host URL without path and query params
+Get IDM base URL
+Helper that gets the normal realm name from the realm export format. +
Helper that gets the normal realm name from the realm export format. It reverses the format generated by getRealmsForExport. e.g. if the realm is 'root-first-second', then it will return '/first/second'.
realm in export format
-Get all features
+Get all features
a promise that resolves to an array of feature objects
-Frodo Library
+Frodo Library
Create a new frodo instance
Initial state configuration to use with the new instance
frodo instance
-Factory helper to create a frodo instance ready for logging in with an admin user account
+Factory helper to create a frodo instance ready for logging in with an admin user account
host base URL, e.g. 'https://openam-my-tenant.forgeblocks.com/am'
admin account username
admin account password
@@ -12,7 +12,7 @@Optional debug: boolean(optional) enable debug output
Optional curlirize: boolean(optional) enable output of all library REST calls as curl commands
frodo instance
-Factory helper to create a frodo instance ready for logging in with a service account
+Factory helper to create a frodo instance ready for logging in with a service account
host base URL, e.g. 'https://openam-my-tenant.forgeblocks.com/am'
service account uuid
service account JWK as stringified JSON
@@ -22,4 +22,4 @@Optional debug: boolean(optional) enable debug output
Optional curlirize: boolean(optional) enable output of all library REST calls as curl commands
frodo instance
-Create config entity
+Create config entity
config entity id/name
config entity data
Optional wait: booleandelay the response until an OSGi service event confirms the change has been consumed by the corresponding service or the request times out.
promise resolving to a config entity
-Delete all config entities
+Delete all config entities
promise reolving to an array of config entities
-Delete all config entities of a type
+Delete all config entities of a type
config entity type
promise resolving to an array of config entities of a type
-Delete config entity
+Delete config entity
config entity id/name
promise resolving to a config entity
-
Export format for applications
-