@clerk/backend/dist/api/endpoints/M2MTokenApi.d.ts

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

import type { M2MToken } from '../resources/M2MToken';
import { AbstractAPI } from './AbstractApi';
type CreateM2MTokenParams = {
    /**
     * Custom machine secret key for authentication.
     */
    machineSecretKey?: string;
    /**
     * Number of seconds until the token expires.
     *
     * @default null - Token does not expire
     */
    secondsUntilExpiration?: number | null;
    claims?: Record<string, unknown> | null;
};
type RevokeM2MTokenParams = {
    /**
     * Custom machine secret key for authentication.
     */
    machineSecretKey?: string;
    /**
     * Machine-to-machine token ID to revoke.
     */
    m2mTokenId: string;
    revocationReason?: string | null;
};
type VerifyM2MTokenParams = {
    /**
     * Custom machine secret key for authentication.
     */
    machineSecretKey?: string;
    /**
     * Machine-to-machine token to verify.
     */
    token: string;
};
export declare class M2MTokenApi extends AbstractAPI {
    #private;
    createToken(params?: CreateM2MTokenParams): Promise<M2MToken>;
    revokeToken(params: RevokeM2MTokenParams): Promise<M2MToken>;
    verify(params: VerifyM2MTokenParams): Promise<M2MToken>;
    /**
     * @deprecated Use `verify()` instead. This method will be removed in the next major release.
     */
    verifyToken(params: VerifyM2MTokenParams): Promise<M2MToken>;
}
export {};
//# sourceMappingURL=M2MTokenApi.d.ts.map