README.md

openid-client API Reference

💗 Help the project

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

• authorizationCodeGrant
• buildAuthorizationUrl
• ClientMetadata
• discovery
• ServerMetadata

Configuration

• Configuration
• discovery

Grants

• authorizationCodeGrant
• clientCredentialsGrant
• genericGrantRequest
• initiateDeviceAuthorization
• pollDeviceAuthorizationGrant
• refreshTokenGrant

Advanced Configuration

• allowInsecureRequests
• enableDecryptingResponses
• enableDetachedSignatureResponseChecks
• enableNonRepudiationChecks
• getJwksCache
• setJwksCache
• useCodeIdTokenResponseType
• useJwtResponseMode

Client Authentication Methods

• ClientSecretBasic
• ClientSecretJwt
• ClientSecretPost
• None
• PrivateKeyJwt
• TlsClientAuth

Errors

• AuthorizationResponseError
• ClientError
• ResponseBodyError
• WWWAuthenticateChallengeError

Authorization Request

• buildAuthorizationUrl
• buildAuthorizationUrlWithJAR
• buildAuthorizationUrlWithPAR
• calculatePKCECodeChallenge
• randomNonce
• randomState

DPoP

• getDPoPHandle
• randomDPoPKeyPair

OpenID Connect 1.0

• authorizationCodeGrant
• buildEndSessionUrl
• discovery
• fetchUserInfo

PKCE

• authorizationCodeGrant
• calculatePKCECodeChallenge
• randomPKCECodeVerifier

Protected Resource Requests

• fetchProtectedResource
• fetchUserInfo

Token Management

• tokenIntrospection
• tokenRevocation

Interfaces

• AuthorizationCodeGrantChecks
• AuthorizationCodeGrantOptions
• AuthorizationDetails
• ConfigurationMethods
• ConfigurationProperties
• ConfirmationClaims
• CryptoKeyPair
• CustomFetchOptions
• DecryptionKey
• DeviceAuthorizationResponse
• DeviceAutorizationGrantPollOptions
• DiscoveryRequestOptions
• DPoPHandle
• DPoPOptions
• ExportedJWKSCache
• GenerateKeyPairOptions
• IDToken
• IntrospectionResponse
• JWK
• JWKS
• ModifyAssertionFunction
• ModifyAssertionOptions
• MTLSEndpointAliases
• PrivateKey
• ServerMetadataHelpers
• TokenEndpointResponse
• TokenEndpointResponseHelpers
• UserInfoAddress
• UserInfoResponse
• WWWAuthenticateChallenge
• WWWAuthenticateChallengeParameters

Type Aliases

• ClientAuth
• CustomFetch
• FetchBody
• JsonArray
• JsonObject
• JsonPrimitive
• JsonValue
• JWSAlgorithm

Variables

• clockSkew
• clockTolerance
• customFetch
• modifyAssertion
• skipStateCheck
• skipSubjectCheck