@synonymdev/pubky
    Preparing search index...

    Interface GrantAuthFlowOptions

    Options for starting a grant-backed pubkyauth flow.

    interface GrantAuthFlowOptions {
        approvalFormat?: GrantApprovalFormat;
        clientId: string;
        relay?: string | null;
        xCallback?: XCallbackParams | null;
    }
    Index
    approvalFormat? clientId relay? xCallback?
    approvalFormat?: GrantApprovalFormat

    Relay approval format. signedApprovalV1 delivers keys for approved e scopes and rejects bare-grant downgrades. Omitted or bareGrant selects a grant without an approval envelope. signedApprovalV1 sets af=v1 in the authorization link.

    clientId: string

    App identifier shown in the user's grant/session list, typically a domain.

    relay?: string | null

    Optional HTTP relay base, e.g. "https://demo.httprelay.io/inbox/". Defaults to the default Synonym-hosted relay when omitted.

    xCallback?: XCallbackParams | null

    Optional return destinations for success, error, and cancellation.

    Settings

    On This Page
    Properties