Interface TokenSet

The tokens and decoded claims produced by a successful auth exchange.

Most integrations should use createUpbond instead.

interface TokenSet {
    accessToken: string;
    claims: IdTokenClaims;
    expiresAt: number;
    idToken: string;
    refreshToken?: string;
}

Properties

accessToken: string

OAuth access token for the issuer's userinfo/management surfaces.

Decoded (and boundary-validated) id_token claims.

expiresAt: number

Epoch seconds; the id_token exp when the token endpoint omits expires_in.

idToken: string

OIDC id_token. Single-use at the Web3Auth network — never resubmit a spent one.

refreshToken?: string

Present when the client requested offline_access (widget host).