Maximo API Client - v0.9.01
    Preparing search index...

    Interface MaximoClientConfig

    Configuration options for the Maximo client

    interface MaximoClientConfig {
        baseUrl: string;
        port?: number;
        userName?: string;
        password?: string;
        apiKey?: string;
        authType?: AuthType;
        ssl?: boolean;
        contextRoot?: string;
        apiHome?: ApiHome;
        logLevel?: LogLevel;
        leanMode?: boolean;
        maxConcurrentRequests?: number;
        timeout?: number;
        logger?: ILogger;
        proxy?: {
            host: string;
            port: number;
            protocol?: string;
            auth?: { username: string; password: string };
        };
        rejectUnauthorized?: boolean;
        autoAuthenticate?: boolean;
        autoscriptObjectStructure?: string;
        maxAppObjectStructure?: string;
        conditionExpressionObjectStructure?: string;
        objectStructServiceOS?: string;
        ca?: string;
        caFilePath?: string;
        cert?: string;
        certFilePath?: string;
        key?: string;
        keyFilePath?: string;
        autoExtractCert?: boolean;
        skipHostnameValidation?: boolean;
        oidcLoginEndpoint?: string;
        oidcUsernameField?: string;
        oidcPasswordField?: string;
        oidcRequestType?: "json"
        | "form";
    }
    Index

    Properties

    baseUrl port? userName? password? apiKey? authType? ssl? contextRoot? apiHome? logLevel? leanMode? maxConcurrentRequests? timeout? logger? proxy? rejectUnauthorized? autoAuthenticate? autoscriptObjectStructure? maxAppObjectStructure? conditionExpressionObjectStructure? objectStructServiceOS? ca? caFilePath? cert? certFilePath? key? keyFilePath? autoExtractCert? skipHostnameValidation? oidcLoginEndpoint? oidcUsernameField? oidcPasswordField? oidcRequestType?

    Properties

    baseUrl: string

    Base URL of the Maximo server

    port?: number

    Port number for the Maximo server connection Example: 9080 for HTTP or 443 for HTTPS

    userName?: string

    Username for authentication

    password?: string

    Password for authentication

    apiKey?: string

    API key for authentication (alternative to username/password)

    authType?: AuthType

    Authentication type (MAXIMO_NATIVE, LDAP_BASIC, LDAP_FORM, APIKEY, MAS_USER_PASS)

    ssl?: boolean

    SSL flag for secure connections

    contextRoot?: string

    Context root for Maximo (usually "maximo")

    apiHome?: ApiHome

    API home path (API, OSLC, or REST)

    logLevel?: LogLevel

    Log level for the client

    leanMode?: boolean

    Whether to use lean mode for responses (reduced payload size)

    true
    maxConcurrentRequests?: number

    Maximum number of concurrent requests

    timeout?: number

    Request timeout in milliseconds

    logger?: ILogger

    Logger configuration

    proxy?: {
        host: string;
        port: number;
        protocol?: string;
        auth?: { username: string; password: string };
    }

    Proxy configuration

    rejectUnauthorized?: boolean

    Whether to ignore SSL certificate errors (not recommended for production) This setting is useful for development or testing with self-signed certificates

    true
    autoAuthenticate?: boolean

    Whether to automatically re-authenticate on receiving a 401 response

    false
    autoscriptObjectStructure?: string

    Optional default object structure name for the AutoscriptService.

    maxAppObjectStructure?: string

    Optional default object structure name for the MaxAppService.

    conditionExpressionObjectStructure?: string

    Optional default object structure name for the ConditionExpressionService.

    objectStructServiceOS?: string

    Optional default object structure name for the ObjectStructService.

    ca?: string

    cert auth in pem format

    caFilePath?: string

    ca auth path

    cert?: string

    ca certificate

    certFilePath?: string

    ca certificate path

    key?: string

    ca key

    keyFilePath?: string

    ca key path

    autoExtractCert?: boolean

    auto extract certificate

    skipHostnameValidation?: boolean

    Whether to skip hostname validation when using autoExtractCert. If true, only certificate fingerprint is validated (useful for IP-based connections).

    oidcLoginEndpoint?: string

    Optional for OIDC: The endpoint to post credentials to if different from j_security_check

    oidcUsernameField?: string

    Optional for OIDC: Field name for username in login form

    'j_username'
    oidcPasswordField?: string

    Optional for OIDC: Field name for password in login form

    'j_password'
    oidcRequestType?: "json" | "form"

    Optional for OIDC: Type of request to send (form or json)

    'form'

    Settings

    Member Visibility

    On This Page

    Properties