@inrupt/solid-client-access-grants API Documentation#
@inrupt/solid-client-access-grants is a JavaScript library for requesting and managing access given to an agent for a resource. These access grants are represented by Verifiable Credentials, signed by an Issuer associated to the Pod server where the resources are hosted.
It is part of a family open source JavaScript libraries designed to support developers building Solid applications.
Server Support
This experimental feature is currently only available in Inrupt Enterprise Solid Server (ESS).
Installation#
For the latest stable version of solid-client-access-grants:
npm install @inrupt/solid-client-access-grants
Changelog#
See the release notes.
Browser Support#
Our JavaScript Client Libraries use relatively modern JavaScript features that
will work in all commonly-used browsers, except Internet Explorer. If you need
support for Internet Explorer, it is recommended to pass them through a tool
like Babel, and to add polyfills for e.g. Map
,
Set
, Promise
, Headers
, Array.prototype.includes
,
Object.entries
and String.prototype.endsWith
.
Additionally, when using this package in an environment other than Node.js, you will need a polyfill for Node’s buffer module.
Node.js Support#
Our JavaScript Client Libraries track Node.js LTS releases.
Issues & Help#
Solid Community Forum#
If you have questions about working with Solid or just want to share what you’re working on, visit the Solid forum. The Solid forum is a good place to meet the rest of the community.
Bugs and Feature Requests#
For public feedback, bug reports, and feature requests please file an issue via Github.
For non-public feedback or support inquiries please use the Inrupt Service Desk.
API Documentation#
Modules#
Interfaces#
- Interface: FetchOptions
- Interface: UmaConfiguration
- Interface: AccessBaseOptions
- Interface: RedirectOptions
- Interface: AccessGrantParameters
- Interface: AccessRequestParameters
- Interface: BaseRequestParameters
- Interface: InputAccessGrantParameters
- Interface: InputAccessRequestParameters
- Interface: AccessModes