validateAuthResponse.md

Function: validateAuthResponse()

💗 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.

---

▸ validateAuthResponse(as, client, parameters, expectedState?): URLSearchParams | OAuth2Error

Validates an OAuth 2.0 Authorization Response or Authorization Error Response message returned from the authorization server's as.authorization_endpoint.

Parameters

Parameter	Type	Description
as	AuthorizationServer	Authorization Server Metadata.
client	Client	Client Metadata.
parameters	URLSearchParams | URL	Authorization response.
expectedState?	string | typeof expectNoState | typeof skipStateCheck	Expected state parameter value. Default is expectNoState.

Returns

URLSearchParams | OAuth2Error

Validated Authorization Response parameters or Authorization Error Response.

See

• RFC 6749 - The OAuth 2.0 Authorization Framework
• OpenID Connect Core 1.0
• RFC 9207 - OAuth 2.0 Authorization Server Issuer Identification