Member Junction
    Preparing search index...

    Interface ORCIDConnectionConfig

    Per-connection configuration for the ORCID connector.

    The ORCID Public API has NO list-all-records endpoint — the iD universe is not enumerable. Instead the universe is SCOPED PER CONNECTION via CompanyIntegration.Configuration. At least one of searchQuery / orcidIds must be provided.

    interface ORCIDConnectionConfig {
        ApiBaseUrl?: string;
        ClientID?: string;
        ClientSecret?: string;
        MaxRetries?: number;
        MaxSearchResults?: number;
        MinRequestIntervalMs?: number;
        OrcidIds?: string[];
        RequestTimeoutMs?: number;
        Scope?: string;
        SearchQuery?: string;
        TokenURL?: string;
        UseExpandedSearch?: boolean;
        UseSandbox?: boolean;
    }
    Index

    Properties

    ApiBaseUrl? ClientID? ClientSecret? MaxRetries? MaxSearchResults? MinRequestIntervalMs? OrcidIds? RequestTimeoutMs? Scope? SearchQuery? TokenURL? UseExpandedSearch? UseSandbox?

    Properties

    ApiBaseUrl?: string

    Non-secret API host override (e.g. a local mock for replay testing). When unset, the production/sandbox host is selected by UseSandbox. Same pattern as Path LMS / GrowthZone — required for mock-floor e2e testability.

    ClientID?: string

    OAuth2 client_credentials grant — client identifier. From the credential store.

    ClientSecret?: string

    OAuth2 client_credentials grant — client secret. From the credential store.

    MaxRetries?: number

    Maximum retries for rate-limited / transient failures. Default: 4.

    MaxSearchResults?: number

    Upper bound on the number of iDs resolved from a search per sync ("Goldilocks" — do NOT drain the ~10k ORCID cap). Default: 1000. Explicit OrcidIds are always synced and are not bounded.

    MinRequestIntervalMs?: number

    Minimum interval between outbound requests (ms). Default: 100 (~10 req/s, well under the 40/s burst cap).

    OrcidIds?: string[]

    Explicit list of ORCID iDs to sync directly (in addition to / instead of searchQuery).

    RequestTimeoutMs?: number

    HTTP request timeout in milliseconds. Default: 30000.

    Scope?: string

    OAuth2 scope. Defaults to '/read-public'.

    SearchQuery?: string

    Lucene query string for GET /search or /expanded-search resolving the iD universe at runtime. Examples: 'affiliation-org-name:"Harvard University"', 'given-names:Albert family-name:Einstein'.

    TokenURL?: string

    OAuth2 token endpoint. Defaults to the production/sandbox host based on UseSandbox.

    UseExpandedSearch?: boolean

    Whether to use /expanded-search instead of /search. Default: false (plain /search).

    UseSandbox?: boolean

    When true, use the ORCID sandbox hosts (sandbox.orcid.org / pub.sandbox.orcid.org).

    Settings

    Member Visibility

    On This Page

    Properties