QuickBase JS SDK v2 - v2.2.2
    Preparing search index...

    Class TicketStrategy

    Ticket authentication strategy using XML API_Authenticate.

    const client = createClient({
      realm: 'mycompany',
      auth: {
        type: 'ticket',
        username: 'user@example.com',
        password: 'password',
      },
    });

    XML-API-TICKET: Remove this class if XML API is discontinued.

    Implements

    Index

    Constructors

    constructor

    Methods

    getAuthorizationHeader getToken getUserId handleAuthError invalidate

    Constructors

    • Parameters

      • username: string
      • password: string
      • options: TicketAuthOptions | undefined
      • context: AuthContext

      Returns TicketStrategy

    Methods

    • Get a valid token for the given database ID

      Parameters

      • Optional_dbid: string

      Returns Promise<string>

    • Get the authenticated user's ID (available after first API call)

      Returns string | null

    • Handle authentication errors (e.g., refresh token on 401)

      Parameters

      • Optional_dbid: string

      Returns Promise<boolean>

      true if token was refreshed and request should be retried

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods