openid-client API Reference
May 6, 2025 ยท View on GitHub
Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by becoming a sponsor.
You are probably looking for this
Configuration
Grants
- authorizationCodeGrant
- clientCredentialsGrant
- genericGrantRequest
- initiateBackchannelAuthentication
- initiateDeviceAuthorization
- pollBackchannelAuthenticationGrant
- pollDeviceAuthorizationGrant
- refreshTokenGrant
Advanced Configuration
allowInsecureRequests- dynamicClientRegistration
- enableDecryptingResponses
- enableDetachedSignatureResponseChecks
- enableNonRepudiationChecks
- getJwksCache
- setJwksCache
- useCodeIdTokenResponseType
- useIdTokenResponseType
- useJwtResponseMode
Client Authentication Methods
Errors
Authorization Request
- buildAuthorizationUrl
- buildAuthorizationUrlWithJAR
- buildAuthorizationUrlWithPAR
- calculatePKCECodeChallenge
- randomNonce
- randomState
DPoP
Dynamic Client Registration (DCR)
OpenID Connect 1.0
PKCE
Protected Resource Requests
Token Management
Interfaces
- AuthorizationCodeGrantChecks
- AuthorizationCodeGrantOptions
- AuthorizationDetails
- BackchannelAuthenticationGrantPollOptions
- BackchannelAuthenticationResponse
- ConfigurationMethods
- ConfigurationProperties
- ConfirmationClaims
- CryptoKeyPair
- CustomFetchOptions
- DecryptionKey
- DeviceAuthorizationGrantPollOptions
- DeviceAuthorizationResponse
- DiscoveryRequestOptions
- DPoPHandle
- DPoPOptions
- DynamicClientRegistrationRequestOptions
- ExportedJWKSCache
- GenerateKeyPairOptions
- IDToken
- ImplicitAuthenticationResponseChecks
- IntrospectionResponse
- JWK
- JWKS
- ModifyAssertionFunction
- ModifyAssertionOptions
- MTLSEndpointAliases
- PrivateKey
- ServerMetadataHelpers
- TokenEndpointResponse
- TokenEndpointResponseHelpers
- UserInfoAddress
- UserInfoResponse
- WWWAuthenticateChallenge
- WWWAuthenticateChallengeParameters
Type Aliases
- ClientAuth
- CustomFetch
- FetchBody
- JsonArray
- JsonObject
- JsonPrimitive
- JsonValue
- JWSAlgorithm
- OmitSymbolProperties