Type alias Frodo

Type declaration

• admin: Admin

• agent: Agent

• am: {
      config: AmConfig;
  }

  • config: AmConfig

• app: Application

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

  • journey: Journey

  • node: Node

  • settings: AuthenticationSettings

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

  • policy: Policy

  • policySet: PolicySet

  • resourceType: ResourceType

• cache: TokenCache

• cloud: EsvCount & {
      adminFed: AdminFederation;
      env: EnvContentSecurityPolicy & EnvCookieDomains & EnvCustomDomains & EnvFederationEnforcement & EnvRelease & EnvSSOCookieConfig & {
          cert: EnvCertificate;
          csr: EnvCSR;
          promotion: EnvPromotion;
      };
      esvCount: EsvCount;
      feature: Feature;
      log: Log;
      secret: Secret;
      serviceAccount: ServiceAccount;
      startup: Startup;
      variable: Variable;
  }

• config: Config

• conn: ConnectionProfile

• email: {
      template: EmailTemplate;
  }

  • template: EmailTemplate

• factory: ApiFactory

• idm: {
      config: IdmConfig;
      connector: Connector;
      crypto: IdmCrypto;
      managed: ManagedObject;
      mapping: Mapping;
      organization: Organization;
      recon: Recon;
      script: IdmScript;
      system: IdmSystem;
  }

  • config: IdmConfig

  • connector: Connector

  • crypto: IdmCrypto

  • managed: ManagedObject

  • 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;
  }

  • client: OAuth2Client

  • endpoint: OAuth2Oidc

  • external: Idp

  • issuer: OAuth2TrustedJwtIssuer

  • provider: OAuth2Provider

• realm: Realm

• role: InternalRole

• saml2: {
      circlesOfTrust: CirclesOfTrust;
      entityProvider: 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 & ScriptValidation & ExportImport & Base64 & {
      constants: Constants;
      jose: Jose;
      json: Json;
      version: Version;
  }

• createInstance:function

  • 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

• createInstanceWithAdminAccount:function

  • 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
    • Optional realm: string

      (optional) override default realm
    • Optional deploymentType: string

      (optional) override deployment type ('cloud', 'forgeops', or 'classic')
    • Optional allowInsecureConnection: boolean

      (optional) allow insecure connection
    • Optional debug: boolean

      (optional) enable debug output
    • Optional curlirize: boolean

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

    Returns Frodo

    frodo instance

• createInstanceWithServiceAccount:function

  • 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
    • Optional realm: string

      (optional) override default realm
    • Optional deploymentType: string

      (optional) override deployment type ('cloud', 'forgeops', or 'classic')
    • Optional allowInsecureConnection: boolean

      (optional) allow insecure connection
    • Optional debug: boolean

      (optional) enable debug output
    • Optional curlirize: boolean

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

    Returns Frodo

    frodo instance