Iskra API Reference
    Preparing search index...

    Interface ApiKeyGateOptions<A>

    interface ApiKeyGateOptions<A extends Actor> {
        bearer?: boolean;
        header?: string | false;
        query?: string;
        toActor?: (record: ApiKeyRecord, c: Context) => A;
    }

    Type Parameters

    Index
    bearer? header? query? toActor?
    bearer?: boolean

    Also take the key from Authorization: Bearer. Default false.

    header?: string | false

    The header that carries the key. Default X-API-Key; false for none.

    query?: string

    Also take the key from this query parameter (it ends up in access logs).

    toActor?: (record: ApiKeyRecord, c: Context) => A

    The actor from the record. Default: { kind: 'apiKey', id, name, scopes, metadata }.

    Settings
    Member Visibility

    On This Page
    Properties