Skip to main content
The Deno 2 Release Candidate is here
Learn more
Module

x/oauth4webapi/mod.ts>Client

Low-Level OAuth 2 / OpenID Connect Client API for JavaScript Runtimes
Latest
interface Client
import { type Client } from "https://deno.land/x/oauth4webapi@v2.17.0/mod.ts";

Recognized Client Metadata that have an effect on the exposed functionality.

Index Signatures

[metadata: string]: JsonValue | undefined

Properties

client_id: string

Client identifier.

optional
client_secret: string

Client secret.

optional
token_endpoint_auth_method: ClientAuthenticationMethod

Client authentication method for the client's authenticated requests. Default is client_secret_basic.

optional
id_token_signed_response_alg: string

JWS alg algorithm required for signing the ID Token issued to this Client. When not configured the default is to allow only algorithms listed in AuthorizationServer.id_token_signing_alg_values_supported | as.id_token_signing_alg_values_supported and fall back to RS256 when the authorization server metadata is not set.

optional
authorization_signed_response_alg: JWSAlgorithm

JWS alg algorithm required for signing authorization responses. When not configured the default is to allow only supported algorithms listed in AuthorizationServer.authorization_signing_alg_values_supported | as.authorization_signing_alg_values_supported and fall back to RS256 when the authorization server metadata is not set.

optional
require_auth_time: boolean

Boolean value specifying whether the IDToken.auth_time | auth_time Claim in the ID Token is REQUIRED. Default is false.

optional
userinfo_signed_response_alg: string

JWS alg algorithm REQUIRED for signing UserInfo Responses. When not configured the default is to allow only algorithms listed in AuthorizationServer.userinfo_signing_alg_values_supported | as.userinfo_signing_alg_values_supported and fall back to RS256 when the authorization server metadata is not set.

optional
introspection_signed_response_alg: string

JWS alg algorithm REQUIRED for signed introspection responses. When not configured the default is to allow only algorithms listed in AuthorizationServer.introspection_signing_alg_values_supported | as.introspection_signing_alg_values_supported and fall back to RS256 when the authorization server metadata is not set.

optional
default_max_age: number

Default Maximum Authentication Age.

optional
use_mtls_endpoint_aliases: boolean

Indicates the requirement for a client to use mutual TLS endpoint aliases defined by the AS where present. Default is false.

When combined with customFetch (to use a Fetch API implementation that supports client certificates) this can be used to target FAPI 2.0 profiles that utilize Mutual-TLS for either client authentication or sender constraining. FAPI 1.0 Advanced profiles that use PAR and JARM can also be targetted.

optional
[clockSkew]: number

See clockSkew.

optional
[clockTolerance]: number
optional
[jweDecrypt]: JweDecryptFunction