Member Junction
    Preparing search index...

    Interface APIKeyValidationOptions

    Options for validating an API key

    interface APIKeyValidationOptions {
        ApplicationId?: string;
        ApplicationName?: string;
        Endpoint?: string;
        IPAddress?: string;
        Method?: string;
        Operation?: string;
        RawKey: string;
        ResponseTimeMs?: number;
        StatusCode?: number;
        UserAgent?: string;
    }
    Index

    Properties

    ApplicationId? ApplicationName? Endpoint? IPAddress? Method? Operation? RawKey ResponseTimeMs? StatusCode? UserAgent?

    Properties

    ApplicationId?: string

    Optional application ID to check binding. If provided, validation will check if the key is authorized for this specific application. Keys bound to specific apps will fail validation if used with a different app. Keys with no app bindings (global keys) will pass validation for any app.

    ApplicationName?: string

    Optional application name (alternative to ApplicationId). Will be looked up to get the ApplicationId.

    Endpoint?: string

    Optional endpoint for logging

    IPAddress?: string

    Optional client IP address for logging

    Method?: string

    Optional HTTP method for logging

    Operation?: string

    Optional operation name for logging

    RawKey: string

    The raw API key to validate

    ResponseTimeMs?: number

    Optional response time in ms for logging

    StatusCode?: number

    Optional status code for logging

    UserAgent?: string

    Optional client user agent for logging

    Settings

    Member Visibility

    On This Page

    Properties