Member Junction
    Preparing search index...

    Interface RhythmConnectionConfig

    Rhythm connection configuration, parsed from the attached MJ Credential (preferred) or the CompanyIntegration.Configuration JSON. Field names are read case-insensitively. NONE of these values are read at build time — they are resolved from the bound credential at runtime.

    interface RhythmConnectionConfig {
        Audience?: string;
        Auth0Domain: string;
        BaseURL?: string;
        ClientId: string;
        ClientSecret: string;
        MaxRetries?: number;
        RequestTimeoutMs?: number;
        TenantId: string;
        TokenURL?: string;
    }
    Index

    Properties

    Audience? Auth0Domain BaseURL? ClientId ClientSecret MaxRetries? RequestTimeoutMs? TenantId TokenURL?

    Properties

    Audience?: string

    Auth0 API audience. Default https://api.rhythmsoftware.com.

    Auth0Domain: string

    Tenant-specific Auth0 domain (e.g. your-tenant.us.auth0.com) the token is minted from.

    BaseURL?: string

    Optional single base-URL override. Rhythm normally routes each object to its own module subdomain (Configuration.Subdomain); when this is set, EVERY request is routed through this one origin instead (path preserved). Real multi-subdomain tenants leave it unset — it exists for a proxying API gateway or the credential-free e2e mock that fronts all modules on one host.

    ClientId: string

    OAuth2 (Auth0 M2M) client identifier.

    ClientSecret: string

    OAuth2 (Auth0 M2M) client secret.

    MaxRetries?: number

    Maximum retries for rate-limited / transient failures. Default 3.

    RequestTimeoutMs?: number

    HTTP request timeout in ms. Default 30000.

    TenantId: string

    Rhythm tenant identifier — substituted into every endpoint's {tenantId} path param.

    TokenURL?: string

    Optional absolute token-endpoint override; defaults to https://{Auth0Domain}/oauth/token.

    Settings

    Member Visibility

    On This Page

    Properties