Type Alias Frodo

Frodo Library

type Frodo = {
    admin: Admin;
    agent: Agent;
    am: { config: AmConfig };
    app: Application;
    authn: { journey: Journey; node: Node; settings: AuthenticationSettings };
    authz: { policy: Policy; policySet: PolicySet; resourceType: ResourceType };
    cache: TokenCache;
    cloud: EsvCount & {
        adminFed: AdminFederation;
        env: EnvAIAgent & EnvContentSecurityPolicy & EnvCookieDomains & EnvCustomDomains & EnvDirectConfigurationSession & EnvFederationEnforcement & EnvRelease & EnvServiceAccountScopes & EnvSSOCookieConfig & {
            cert: EnvCertificate;
            csr: EnvCSR;
            promotion: EnvPromotion;
        };
        esvCount: EsvCount;
        feature: Feature;
        idmFeature: IdmFeature;
        iga: {
            certificationTemplate: CertificationTemplate;
            event: IgaEvent;
            glossary: Glossary;
            requestForm: RequestForm;
            requestType: RequestType;
            workflow: Workflow;
        };
        log: Log;
        secret: Secret;
        serviceAccount: ServiceAccount;
        startup: Startup;
        telemetry: Telemetry;
        variable: Variable;
        wsfed: WSFed;
    };
    config: Config;
    conn: ConnectionProfile;
    email: { template: EmailTemplate };
    factory: ApiFactory;
    idm: {
        config: IdmConfig;
        connector: Connector;
        crypto: IdmCrypto;
        managed: ManagedObject & { schema: ManagedObjectSchemaOps };
        managedSystem: ManagedSystemObject & {
            schema: ManagedSystemObjectSchemaOps;
        };
        mapping: Mapping;
        organization: Organization;
        recon: Recon;
        script: IdmScript;
        system: IdmSystem;
    };
    info: Info;
    login: Authenticate;
    oauth2oidc: {
        client: OAuth2Client;
        endpoint: OAuth2Oidc;
        external: Idp;
        issuer: OAuth2TrustedJwtIssuer;
        provider: OAuth2Provider;
    };
    rawConfig: RawConfig;
    realm: Realm;
    role: InternalRole;
    saml2: { circlesOfTrust: CirclesOfTrust; entityProvider: Saml2 };
    script: Script;
    scriptType: ScriptType;
    secretStore: SecretStore;
    server: Server;
    service: Service;
    session: Session;
    site: Site;
    state: State;
    theme: Theme;
    user: User;
    utils: FRUtils & FrodoUtils & HelpUtils & ScriptValidation & ExportImport & Base64 & {
        constants: Constants;
        crypto: FrodoCrypto;
        jose: Jose;
        json: Json;
        version: Version;
    };
    createInstance(config: StateInterface): Frodo;
    createInstanceWithAccessToken(
        host: string,
        realm?: string,
        deploymentType?: string,
        allowInsecureConnection?: boolean,
        debug?: boolean,
        curlirize?: boolean,
    ): Frodo;
    createInstanceWithAdminAccount(
        host: string,
        username: string,
        password: string,
        realm?: string,
        deploymentType?: string,
        allowInsecureConnection?: boolean,
        debug?: boolean,
        curlirize?: boolean,
    ): Frodo;
    createInstanceWithAmsterAccount(
        host: string,
        amsterPrivateKey: string,
        authenticationService?: string,
        realm?: string,
        deploymentType?: string,
        allowInsecureConnection?: boolean,
        debug?: boolean,
        curlirize?: boolean,
    ): Frodo;
    createInstanceWithBrowserLogin(
        host: string,
        loginClientId?: string,
        loginScope?: string,
        loginRedirectUri?: string,
        realm?: string,
        deploymentType?: string,
        allowInsecureConnection?: boolean,
        debug?: boolean,
        curlirize?: boolean,
    ): Frodo;
    createInstanceWithServiceAccount(
        host: string,
        serviceAccountId: string,
        serviceAccountJwkStr: string,
        realm?: string,
        deploymentType?: string,
        allowInsecureConnection?: boolean,
        debug?: boolean,
        curlirize?: boolean,
    ): Frodo;
}

Properties

admin

admin: Admin

agent

agent: Agent

am

am: { config: AmConfig }

app

app: Application

authn

authn: { journey: Journey; node: Node; settings: AuthenticationSettings }

authz

authz: { policy: Policy; policySet: PolicySet; resourceType: ResourceType }

cache

cache: TokenCache

cloud

cloud: EsvCount & {
    adminFed: AdminFederation;
    env: EnvAIAgent & EnvContentSecurityPolicy & EnvCookieDomains & EnvCustomDomains & EnvDirectConfigurationSession & EnvFederationEnforcement & EnvRelease & EnvServiceAccountScopes & EnvSSOCookieConfig & {
        cert: EnvCertificate;
        csr: EnvCSR;
        promotion: EnvPromotion;
    };
    esvCount: EsvCount;
    feature: Feature;
    idmFeature: IdmFeature;
    iga: {
        certificationTemplate: CertificationTemplate;
        event: IgaEvent;
        glossary: Glossary;
        requestForm: RequestForm;
        requestType: RequestType;
        workflow: Workflow;
    };
    log: Log;
    secret: Secret;
    serviceAccount: ServiceAccount;
    startup: Startup;
    telemetry: Telemetry;
    variable: Variable;
    wsfed: WSFed;
}

Type Declaration

adminFed: AdminFederation
env: EnvAIAgent & EnvContentSecurityPolicy & EnvCookieDomains & EnvCustomDomains & EnvDirectConfigurationSession & EnvFederationEnforcement & EnvRelease & EnvServiceAccountScopes & EnvSSOCookieConfig & {
    cert: EnvCertificate;
    csr: EnvCSR;
    promotion: EnvPromotion;
}
esvCount: EsvCount
Deprecated
since v2.0.4 use frodo.cloud.getEsvCount instead
feature: Feature
idmFeature: IdmFeature
iga: {
    certificationTemplate: CertificationTemplate;
    event: IgaEvent;
    glossary: Glossary;
    requestForm: RequestForm;
    requestType: RequestType;
    workflow: Workflow;
}
log: Log
secret: Secret
serviceAccount: ServiceAccount
startup: Startup
telemetry: Telemetry
variable: Variable
wsfed: WSFed

config

config: Config

conn

conn: ConnectionProfile

email

email: { template: EmailTemplate }

factory

factory: ApiFactory

idm

idm: {
    config: IdmConfig;
    connector: Connector;
    crypto: IdmCrypto;
    managed: ManagedObject & { schema: ManagedObjectSchemaOps };
    managedSystem: ManagedSystemObject & {
        schema: ManagedSystemObjectSchemaOps;
    };
    mapping: Mapping;
    organization: Organization;
    recon: Recon;
    script: IdmScript;
    system: IdmSystem;
}

info

info: Info

oauth2oidc

oauth2oidc: {
    client: OAuth2Client;
    endpoint: OAuth2Oidc;
    external: Idp;
    issuer: OAuth2TrustedJwtIssuer;
    provider: OAuth2Provider;
}

rawConfig

rawConfig: RawConfig

realm

realm: Realm

role

role: InternalRole

saml2

saml2: { circlesOfTrust: CirclesOfTrust; entityProvider: Saml2 }

script

script: Script

scriptType

scriptType: ScriptType

secretStore

secretStore: SecretStore

server

server: Server

service

service: Service

session

session: Session

site

site: Site

state

state: State

theme

theme: Theme

user

user: User

utils

utils: FRUtils & FrodoUtils & HelpUtils & ScriptValidation & ExportImport & Base64 & {
    constants: Constants;
    crypto: FrodoCrypto;
    jose: Jose;
    json: Json;
    version: Version;
}

Methods

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
- Defined in lib/FrodoLib.ts:274

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
- Defined in lib/FrodoLib.ts:393

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
- Defined in lib/FrodoLib.ts:288

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
- Defined in lib/FrodoLib.ts:334

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
- Defined in lib/FrodoLib.ts:364

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
- Defined in lib/FrodoLib.ts:311

Type Alias Frodo

Index

Properties

Methods

Properties

admin

agent

am

app

authn

authz

cache

cloud

Type Declaration

adminFed: AdminFederation

env: EnvAIAgent & EnvContentSecurityPolicy & EnvCookieDomains & EnvCustomDomains & EnvDirectConfigurationSession & EnvFederationEnforcement & EnvRelease & EnvServiceAccountScopes & EnvSSOCookieConfig & { cert: EnvCertificate; csr: EnvCSR; promotion: EnvPromotion;}

esvCount: EsvCount

Deprecated

feature: Feature

idmFeature: IdmFeature

iga: { certificationTemplate: CertificationTemplate; event: IgaEvent; glossary: Glossary; requestForm: RequestForm; requestType: RequestType; workflow: Workflow;}

log: Log

secret: Secret

serviceAccount: ServiceAccount

startup: Startup

telemetry: Telemetry

variable: Variable

wsfed: WSFed

config

conn

email

factory

idm

info

login

oauth2oidc

rawConfig

realm

role

saml2

script

scriptType

secretStore

server

service

session

site

state

theme

user

utils

Methods

createInstance

Parameters

Returns Frodo

createInstanceWithAccessToken

Parameters

Returns Frodo

createInstanceWithAdminAccount

Parameters

Returns Frodo

createInstanceWithAmsterAccount

Parameters

Returns Frodo

createInstanceWithBrowserLogin

Parameters

Returns Frodo

createInstanceWithServiceAccount

Parameters

Returns Frodo

Settings

On This Page

env: EnvAIAgent & EnvContentSecurityPolicy & EnvCookieDomains & EnvCustomDomains & EnvDirectConfigurationSession & EnvFederationEnforcement & EnvRelease & EnvServiceAccountScopes & EnvSSOCookieConfig & {
cert: EnvCertificate;
csr: EnvCSR;
promotion: EnvPromotion;
}

iga: {
certificationTemplate: CertificationTemplate;
event: IgaEvent;
glossary: Glossary;
requestForm: RequestForm;
requestType: RequestType;
workflow: Workflow;
}