This is an Alpha release of this package, it is only intended to be used by @inrupt/solid-client-access-grants for now.

@inrupt/solid-client-vc / revoke

Module: revoke

References

default

Renames and re-exports revokeVerifiableCredential

Functions

revokeVerifiableCredential

▸ revokeVerifiableCredential(issuerEndpoint, credentialId, options?): Promise<void>

Revoke a given VC from a given issuer. This changes the status of the VC so that subsequent verifications will fail. The issuer is expected to implement the W3C VC Issuer HTTP API, in particular VC status update.

Parameters

Name	Type	Description
issuerEndpoint	string	The /status endpoint of the holder.
credentialId	string	The identifier of the VC to be revoked.
options?	Object	Optional parameter options.fetch: An alternative fetch function to make the HTTP request, compatible with the browser-native fetch API. This can be typically used for authentication. Note that if it is omitted, and @inrupt/solid-client-authn-browser is in your dependencies, the default session is picked up.
options.fetch	(input: RequestInfo | URL, init?: RequestInit) => Promise<Response>(input: string | Request | URL, init?: RequestInit) => Promise<Response>	MDN Reference

Returns

Promise<void>

Since

0.1.0

Defined in

src/revoke/revoke.ts:41