@jackdbd/fastify-userinfo-endpoint

Fastify plugin that adds a IndieAuth Userinfo Endpoint to a Fastify server.

• Installation
• Userinfo Endpoint Options
• Dependencies
• References
• License

Installation

npm install @jackdbd/fastify-userinfo-endpoint
Copy

Userinfo Endpoint Options

Options for the Fastify userinfo-endpoint plugin

Properties

Name	Type	Description	Required
ajv		Instance of Ajv	no
includeErrorDescription	boolean	Whether to include an error_description property in all error responses. This is meant to assist the client developer in understanding the error. This is NOT meant to be shown to the end user. Default: false	no
isAccessTokenRevoked	Function	Predicate function that returns true if a jti (JSON Web Token ID) is revoked.	yes
logPrefix	string	Default: "[userinfo-endpoint] "	no
reportAllAjvErrors (report all AJV errors)	boolean	Whether to report all AJV validation errors. Default: false	no
requestContextKey	string	The key under which the access token claims are stored in the request context. Default: "access_token_claims" Minimal Length: 1	no
retrieveUserProfile	Function	Retrieves a user's profile from a storage backend.	yes

Example

{
    "includeErrorDescription": false,
    "logPrefix": "[userinfo-endpoint] ",
    "reportAllAjvErrors": false,
    "requestContextKey": "access_token_claims"
}
Copy

Dependencies

Package	Version
@fastify/response-validation	^3.0.3
@jackdbd/canonical-url	0.2.0-canary.8
@jackdbd/fastify-hooks	0.2.0-canary.16
@jackdbd/fastify-utils	0.2.0-canary.10
@jackdbd/indieauth	0.2.0-canary.14
@jackdbd/oauth2-error-responses	0.2.0-canary.9
@jackdbd/schema-validators	0.2.0-canary.12
@sinclair/typebox	^0.34.14
ajv	^8.17.1
ajv-formats	^3.0.1
fastify-plugin	^5.0.1

Peer	Version range
@fastify/request-context	>=6.0.0
fastify	>=5.0.0

References

• Profile Information - IndieAuth
• Verifying the User Info (oauth.com)
• UserInfo - Retrieving details about the logged-in user (connect2id.com)

License

© 2024 - 2025 Giacomo Debidda // MIT License