Frodo Library - v5.0.0-47
    Preparing search index...

    Class FrodoError

    Hierarchy

    • Error
      • FrodoError
    Index
    • Parameters

      • message: string
      • originalErrors: Error | Error[] = null
      • Optionalcode:
            | "PROXY_AUTHENTICATION_REQUIRED"
            | "PROXY_TUNNEL_REFUSED"
            | "PROXY_CONNECTION_REFUSED"
            | "PROXY_CONNECTION_CLOSED"
            | "PROXY_UNREACHABLE"
            | "BROWSER_LOGIN_NO_SESSION"
            | "LOGIN_NO_STORED_PASSWORD"
            | "BROWSER_LOGIN_DEPLOYMENT_TYPE_UNKNOWN"
            | "BROWSER_LOGIN_REDIRECT_URI_NOT_SUPPORTED"
            | "BROWSER_LOGIN_FORGEOPS_CLIENT_ID_REQUIRED"
            | "BROWSER_LOGIN_CLASSIC_CLIENT_ID_REQUIRED"
            | "BROWSER_LOGIN_CLASSIC_SESSION_CAPTURE_REQUIRED"
            | "LOG_API_CREDENTIAL_MISSING"
            | "INSUFFICIENT_SCOPE"
            | "NO_AM_SESSION"
            | "DEVICE_LOGIN_TOKEN_NOT_ISSUED"
            | "CIMD_PROFILES_NOT_AVAILABLE"
            | "LOG_API_RATE_LIMITED"
            | "AIR_GAPPED"

      Returns FrodoError

    code?:
        | "PROXY_AUTHENTICATION_REQUIRED"
        | "PROXY_TUNNEL_REFUSED"
        | "PROXY_CONNECTION_REFUSED"
        | "PROXY_CONNECTION_CLOSED"
        | "PROXY_UNREACHABLE"
        | "BROWSER_LOGIN_NO_SESSION"
        | "LOGIN_NO_STORED_PASSWORD"
        | "BROWSER_LOGIN_DEPLOYMENT_TYPE_UNKNOWN"
        | "BROWSER_LOGIN_REDIRECT_URI_NOT_SUPPORTED"
        | "BROWSER_LOGIN_FORGEOPS_CLIENT_ID_REQUIRED"
        | "BROWSER_LOGIN_CLASSIC_CLIENT_ID_REQUIRED"
        | "BROWSER_LOGIN_CLASSIC_SESSION_CAPTURE_REQUIRED"
        | "LOG_API_CREDENTIAL_MISSING"
        | "INSUFFICIENT_SCOPE"
        | "NO_AM_SESSION"
        | "DEVICE_LOGIN_TOKEN_NOT_ISSUED"
        | "CIMD_PROFILES_NOT_AVAILABLE"
        | "LOG_API_RATE_LIMITED"
        | "AIR_GAPPED"

    The stable identity of the condition this error reports, if it has one. It is stable across releases, unlike the message. An error that wraps another FrodoError does not copy its code: look through originalErrors for the condition underneath. The one exception is a request that failed because of its proxy: the error of the request carries proxyFailure, and the FrodoError that wraps it is given that failure's code.

    httpCode: string
    httpDescription: string
    httpDetail: string
    httpErrorReason: string
    httpErrorText: string
    httpMessage: string
    httpStatus: number
    httpTransactionId?: string

    The x-forgerock-transactionid header of the response of the request that failed, on the errors of operations that set it explicitly (for example enabling the AI agent feature), where the platform's own log is the only way to find the cause of a generic 500. Support asks for it. Declared, not initialised: an error that does not set it has no such property. Like code, it is not copied by an error that wraps this one.

    isHttpError: boolean = false
    originalErrors: Error[] = []
    rateLimit?: LogApiRateLimit

    The state of the rate limit of the Log API, on the error that reports a request the API rejected with 429 (code LOG_API_RATE_LIMITED), if the answer carried the X-RateLimit-* headers. Like code, it is not copied by an error that wraps this one.

    codes: readonly (
        | "PROXY_AUTHENTICATION_REQUIRED"
        | "PROXY_TUNNEL_REFUSED"
        | "PROXY_CONNECTION_REFUSED"
        | "PROXY_CONNECTION_CLOSED"
        | "PROXY_UNREACHABLE"
        | "BROWSER_LOGIN_NO_SESSION"
        | "LOGIN_NO_STORED_PASSWORD"
        | "BROWSER_LOGIN_DEPLOYMENT_TYPE_UNKNOWN"
        | "BROWSER_LOGIN_REDIRECT_URI_NOT_SUPPORTED"
        | "BROWSER_LOGIN_FORGEOPS_CLIENT_ID_REQUIRED"
        | "BROWSER_LOGIN_CLASSIC_CLIENT_ID_REQUIRED"
        | "BROWSER_LOGIN_CLASSIC_SESSION_CAPTURE_REQUIRED"
        | "LOG_API_CREDENTIAL_MISSING"
        | "INSUFFICIENT_SCOPE"
        | "NO_AM_SESSION"
        | "DEVICE_LOGIN_TOKEN_NOT_ISSUED"
        | "CIMD_PROFILES_NOT_AVAILABLE"
        | "LOG_API_RATE_LIMITED"
        | "AIR_GAPPED"
    )[] = FRODO_ERROR_CODES

    Every code that a FrodoError can carry, for a caller that keeps a table keyed by code and wants to be told when the library adds one.

    • Parameters

      • level: number = 1

      Returns string

    • Returns a string representation of an object.

      Returns string