Supported IndieWeb specifications
The current status of Indiekit’s support for IndieWeb specifications and protocols.
IndieAuth
IndieAuth is an identity layer on top of OAuth 2.0, primarily used to obtain an OAuth 2.0 Bearer Token for use by Micropub clients. Users and clients are all represented by URLs. IndieAuth enables clients to verify the identity of a user, as well as to obtain an access token that can be used to access resources under the control of the user.
Discovery
Authorization
- Redeem
authorization_codefor a profile URL - Redeem
authorization_codefor an access token - Redeem
authorization_codefor profile information - Redeem
refresh_tokenfor a refreshed access token - Error responses
Indiekit uses Proof Key for Code Exchange (PKCE), but doesn’t require clients to issue a code challenge. This is to support clients using earlier versions of IndieAuth.
Access tokens
User information
Micropub
Micropub is used to create, update and delete posts on one’s own domain using third-party clients. Web apps and native apps can use Micropub to post and edit articles, short notes, comments, likes, photos, events or other kinds of posts on your own website.
- Create posts (using both
x-www-form-urlencodedand JSON syntaxes) - Update posts (replacing, adding and deleting properties)
- Delete and undelete posts
- Query
- Upload media
- Error response
The following scopes are supported:
create: User can create and undelete posts, and upload mediaupdate: User can update postsdelete: User can delete postsdraft: User can only create and update draft postsmedia: User can upload media
Extensions
- Category query
- Channel query
- Post list query
- Supported properties query
- Supported queries query
- Supported vocabulary query
- Media source query, including filtering by URL parameter[1]
- Pagination
- Filter query parameter
- Limit query parameter
- Offset query parameter
- Delete media
Server commands
-
mp-channel: Channel(s) to use for a published post -
mp-photo-alt: Alternative text to use for a published photo -
mp-slug: URL slug to use in published post -
mp-syndicate-to: Which syndication targets to syndicate post to
Microsub
Microsub provides a standardized way for clients to consume and interact with feeds collected by a server.
Microsub is not currently supported by Indiekit, but might be in the future.
Webmention
Webmention is a simple way to notify any URL when you mention it on your site. From the receiver's perspective, it's a way to request notifications when other sites mention it.