Types

Supporting types used by the client.

AuthCredential

An authentication credential for the Privatemode API.

type AuthCredential =
  { type: 'apiKey'; value: string } | { type: 'jwt'; value: string };

AuthProvider

A function that returns the credential to authenticate the next request with. It's invoked before every request, so credentials can be refreshed over time.

type AuthProvider = () => AuthCredential | Promise<AuthCredential>;

VerifyResult

Result of verifying the Privatemode deployment.

manifestManifestrequired

The manifest the verification has been performed against.

ExportedSecret

An exported secret that can be cached and restored.

idstringrequired

Secret identifier.

datastringrequired

Base64-encoded secret data.

expiresAtUnixnumberrequired

Expiration as a Unix timestamp (seconds).

NvidiaOCSPPolicy

Structured NVIDIA OCSP policy.

allowUnknownbooleandefault: false

Whether to accept unknown OCSP statuses for NVIDIA attestation certificates.

revokedGracePeriodHoursnumberdefault: 0

Grace period for revoked certificates, in hours. Fractional hours are allowed. Must be finite, nonnegative, and less than 2**63 / 3_600_000_000_000. Zero rejects revoked certificates immediately. A positive value accepts certificates revoked within this period, with the cutoff recalculated for every request.