@clerk/backend/dist/api/resources/Client.d.ts

Clerk Backend SDK - REST Client for Backend API & JWT verification utilities

import type { ClientJSON } from './JSON';
import { Session } from './Session';
/**
 * The Backend `Client` object is similar to the [`Client`](https://clerk.com/docs/references/javascript/client) object as it holds information about the authenticated sessions in the current device. However, the Backend `Client` object is different from the `Client` object in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Clients#operation/GetClient) and is not directly accessible from the Frontend API.
 */
export declare class Client {
    /**
     * The unique identifier for the `Client`.
     */
    readonly id: string;
    /**
     * An array of [Session](https://clerk.com/docs/references/backend/types/backend-session){{ target: '_blank' }} IDs associated with the `Client`.
     */
    readonly sessionIds: string[];
    /**
     * An array of [Session](https://clerk.com/docs/references/backend/types/backend-session){{ target: '_blank' }} objects associated with the `Client`.
     */
    readonly sessions: Session[];
    /**
     * The ID of the [`SignIn`](https://clerk.com/docs/references/javascript/sign-in){{ target: '_blank' }}.
     */
    readonly signInId: string | null;
    /**
     * The ID of the [`SignUp`](https://clerk.com/docs/references/javascript/sign-up){{ target: '_blank' }}.
     */
    readonly signUpId: string | null;
    /**
     * The ID of the last active [Session](https://clerk.com/docs/references/backend/types/backend-session).
     */
    readonly lastActiveSessionId: string | null;
    /**
     * The date when the `Client` was first created.
     */
    readonly createdAt: number;
    /**
     * The date when the `Client` was last updated.
     */
    readonly updatedAt: number;
    constructor(
    /**
     * The unique identifier for the `Client`.
     */
    id: string, 
    /**
     * An array of [Session](https://clerk.com/docs/references/backend/types/backend-session){{ target: '_blank' }} IDs associated with the `Client`.
     */
    sessionIds: string[], 
    /**
     * An array of [Session](https://clerk.com/docs/references/backend/types/backend-session){{ target: '_blank' }} objects associated with the `Client`.
     */
    sessions: Session[], 
    /**
     * The ID of the [`SignIn`](https://clerk.com/docs/references/javascript/sign-in){{ target: '_blank' }}.
     */
    signInId: string | null, 
    /**
     * The ID of the [`SignUp`](https://clerk.com/docs/references/javascript/sign-up){{ target: '_blank' }}.
     */
    signUpId: string | null, 
    /**
     * The ID of the last active [Session](https://clerk.com/docs/references/backend/types/backend-session).
     */
    lastActiveSessionId: string | null, 
    /**
     * The date when the `Client` was first created.
     */
    createdAt: number, 
    /**
     * The date when the `Client` was last updated.
     */
    updatedAt: number);
    static fromJSON(data: ClientJSON): Client;
}
//# sourceMappingURL=Client.d.ts.map