Type Alias Frodo

admin

agent

am

app

authn

authz

cache

cloud

config

conn

email

factory

idm

info

login

mcp

oauth2oidc

rawConfig

realm

role

saml2

script

scriptType

secretStore

server

service

session

site

state

theme

user

utils

createInstance

• createInstance(config: StateInterface): Frodo

  Create a new frodo instance

  Parameters

  • config: StateInterface

    Initial state configuration to use with the new instance

  Returns Frodo

  frodo instance

createInstanceWithAccessToken

• createInstanceWithAccessToken(
      host: string,
      realm?: string,
      deploymentType?: string,
      allowInsecureConnection?: boolean,
      debug?: boolean,
      curlirize?: boolean,
  ): Frodo

  Factory helper to create a frodo instance ready to use an already-issued, externally-obtained OAuth2 access token (e.g. one an MCP server verified as an OAuth2 resource server). Like createInstanceWithBrowserLogin, this alone doesn't make the instance immediately usable — call .login.applyAccessToken(token) on the returned instance before using it. Never persists to the local token cache, regardless of the environment's default: this credential belongs to whoever presented the token, not to the operator running this process.

  Parameters

  • host: string

    host base URL, e.g. 'https://openam-my-tenant.forgeblocks.com/am'

  • Optionalrealm: string

    (optional) override default realm

  • OptionaldeploymentType: string

    deployment type ('cloud', 'forgeops', or 'classic') — required, since there is no existing session to auto-detect it from

  • OptionalallowInsecureConnection: boolean

    (optional) allow insecure connection

  • Optionaldebug: boolean

    (optional) enable debug output

  • Optionalcurlirize: boolean

    (optional) enable output of all library REST calls as curl commands

  Returns Frodo

  frodo instance, not yet ready to use

createInstanceWithAdminAccount

• createInstanceWithAdminAccount(
      host: string,
      username: string,
      password: string,
      realm?: string,
      deploymentType?: string,
      allowInsecureConnection?: boolean,
      debug?: boolean,
      curlirize?: boolean,
  ): Frodo

  Factory helper to create a frodo instance ready for logging in with an admin user account

  Parameters

  • host: string

    host base URL, e.g. 'https://openam-my-tenant.forgeblocks.com/am'

  • username: string

    admin account username

  • password: string

    admin account password

  • Optionalrealm: string

    (optional) override default realm

  • OptionaldeploymentType: string

    (optional) override deployment type ('cloud', 'forgeops', or 'classic')

  • OptionalallowInsecureConnection: boolean

    (optional) allow insecure connection

  • Optionaldebug: boolean

    (optional) enable debug output

  • Optionalcurlirize: boolean

    (optional) enable output of all library REST calls as curl commands

  Returns Frodo

  frodo instance

createInstanceWithAmsterAccount

• createInstanceWithAmsterAccount(
      host: string,
      amsterPrivateKey: string,
      authenticationService?: string,
      realm?: string,
      deploymentType?: string,
      allowInsecureConnection?: boolean,
      debug?: boolean,
      curlirize?: boolean,
  ): Frodo

  Factory helper to create a frodo instance ready for logging in with Amster credentials

  Parameters

  • host: string

    host base URL, e.g. 'https://am.example.com:8443/am'

  • amsterPrivateKey: string

    the pem encoded private key used to authenticate with Amster

  • OptionalauthenticationService: string

    (optional) the authentication service used to authenticate with Amster (default: 'amsterService')

  • Optionalrealm: string

    (optional) override default realm

  • OptionaldeploymentType: string

    (optional) override deployment type ('cloud', 'forgeops', or 'classic')

  • OptionalallowInsecureConnection: boolean

    (optional) allow insecure connection

  • Optionaldebug: boolean

    (optional) enable debug output

  • Optionalcurlirize: boolean

    (optional) enable output of all library REST calls as curl commands

  Returns Frodo

  frodo instance

createInstanceWithBrowserLogin

• createInstanceWithBrowserLogin(
      host: string,
      loginClientId?: string,
      loginScope?: string,
      loginRedirectUri?: string,
      realm?: string,
      deploymentType?: string,
      allowInsecureConnection?: boolean,
      debug?: boolean,
      curlirize?: boolean,
  ): Frodo

  Factory helper to create a frodo instance ready for a real interactive browser login. Unlike the other three factories, this one alone doesn't make the instance immediately usable — a real interactive round trip is required first (there is no unattended way to redo it, unlike every other auth mode's silent background re-login). Call .login.getTokensInteractive(...) on the returned instance before using it, supplying a promptHandler to present the login step.

  Parameters

  • host: string

    host base URL, e.g. 'https://openam-my-tenant.forgeblocks.com/am'

  • OptionalloginClientId: string

    (optional) OAuth2 client id — mandatory for forgeops/classic (no built-in default); cloud has one

  • OptionalloginScope: string

    (optional) override the default scope requested for the target deployment type

  • OptionalloginRedirectUri: string

    (optional) full, absolute redirect URI to use, for a client registered with an exact-match redirect URI (shared with the non-interactive synthetic flow's own redirect URI setting)

  • Optionalrealm: string

    (optional) override default realm

  • OptionaldeploymentType: string

    (optional) deployment type ('cloud', 'forgeops', or 'classic') — required for browser login, since there is no existing session to auto-detect it from

  • OptionalallowInsecureConnection: boolean

    (optional) allow insecure connection

  • Optionaldebug: boolean

    (optional) enable debug output

  • Optionalcurlirize: boolean

    (optional) enable output of all library REST calls as curl commands

  Returns Frodo

  frodo instance, not yet logged in

createInstanceWithServiceAccount

• createInstanceWithServiceAccount(
      host: string,
      serviceAccountId: string,
      serviceAccountJwkStr: string,
      realm?: string,
      deploymentType?: string,
      allowInsecureConnection?: boolean,
      debug?: boolean,
      curlirize?: boolean,
  ): Frodo

  Factory helper to create a frodo instance ready for logging in with a service account

  Parameters

  • host: string

    host base URL, e.g. 'https://openam-my-tenant.forgeblocks.com/am'

  • serviceAccountId: string

    service account uuid

  • serviceAccountJwkStr: string

    service account JWK as stringified JSON

  • Optionalrealm: string

    (optional) override default realm

  • OptionaldeploymentType: string

    (optional) override deployment type ('cloud', 'forgeops', or 'classic')

  • OptionalallowInsecureConnection: boolean

    (optional) allow insecure connection

  • Optionaldebug: boolean

    (optional) enable debug output

  • Optionalcurlirize: boolean

    (optional) enable output of all library REST calls as curl commands

  Returns Frodo

  frodo instance

createRemoteProxyView

• createRemoteProxyView(proxyId: string): RemoteProxyView

  Create a view of the IDM of another tenant, reached through a remote proxy of this tenant.

  Every IDM operation of the view (idm.managed, idm.config, ...) is made on the receiving tenant of the remote proxy, as the user the proxy maps to there. The view shares the login of this instance: it needs no login of its own, a token this instance refreshes is the token the view uses, and this instance keeps talking to its own tenant. Create one view per remote proxy.

  Only IDM operations are part of the view; everything else (AM, cloud administration) is not reachable through a remote proxy. Writes are not restricted by the view; what the proxy may do is decided by the mapping of its user on the receiving tenant.

  Parameters

  • proxyId: string

    id/name of the remote proxy (the name of the receiving tenant)

  Returns RemoteProxyView

  a view of the IDM of the receiving tenant