Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/solidcouch/solid-identity

Simple solid identity for REST services - monorepo
https://github.com/solidcouch/solid-identity

Last synced: about 1 month ago
JSON representation

Simple solid identity for REST services - monorepo

Awesome Lists containing this project

README

        

# SoId - Solid Identity

With _Solid Identity_, you can give your Solid service a Solid-OIDC-compatible identity.

## Packages

- [`@soid/core`](https://npmjs.com/package/@soid/core) - Core methods.
- [`@soid/koa`](https://npmjs.com/package/@soid/koa) - Koa middleware.

## How does it work?

There are three endpoints that need to be set up:

- `/.well-known/openid-configuration`
- `/path/to/jwks`
- `/path/to/webId`

For more details, you can check the output of `getEndpoints(webId)` from the `@soid/core` package.

## Limitations

The identity — particularly the `.well-known` endpoint — must be hosted at the root URL (not at a subpath). Therefore, you'll likely need a dedicated (sub)domain for the service.