@jackdbd/fastify-userinfo-endpoint

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

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

Installation

1npm install @jackdbd/fastify-userinfo-endpoint

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
retrieveUserProfile	Function	Function that retrieves a user's profile from a storage backend.	yes

Example

1{
2    "includeErrorDescription": false,
3    "logPrefix": "userinfo-endpoint ",
4    "reportAllAjvErrors": false
5}

Dependencies

Package	Version
@fastify/response-validation	^3.0.3
@jackdbd/indieauth	^0.0.0-canary.1
@jackdbd/oauth2	^0.0.0-canary.1
@jackdbd/oauth2-error-responses	^0.0.0-canary.1
@jackdbd/oauth2-tokens	^0.0.0-canary.1
@jackdbd/schema-validators	^0.0.0-canary.1
@sinclair/typebox	^0.34.14
ajv	^8.17.1
ajv-formats	^3.0.1
fastify-plugin	^5.0.1

⚠️ Peer Dependencies

This package defines 1 peer dependency.

Peer	Version range
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