@inrupt/solid-client-access-grants / interfaces / AccessBaseOptions

Interface: AccessBaseOptions

Optional parameters to customise the behaviour of access requests.

• fetch: Pass in a function with a signature compatible with the WHATWG Fetch API, which will be used to make HTTP requests. Primarily useful when requests need to be authenticated.

  When @inrupt/solid-client-authn-browser is available and this property is not set, fetch will be imported from there. Otherwise, the HTTP requests will be unauthenticated.

• accessEndpoint: A base URL used when determining the location of access API calls. If not given, it is attempted to be found by determining the server URL from the resource involved in the request and reading its .well-known/solid file for an Access API entry.

• updateAcr: A boolean flag. If true, the Access Control Resource of the resource for which an Access Grant is issued will be updated so that the Access Grant is effective. If updateAcr is false, the Access Control Resource attached to the resource targeted by the Access Grant will be left unchanged. Depending on the Access Control Policy structure of the target storage, this could result in the Access Grant being ineffective, and subsequent fetch operations using this Access Grant for authorization would fail with a 403 Unauthorized response from the server. To manually update the ACR and enable Access Grant-based access to the target resource, one can use acp_ess_2.setVcAccess, from @inrupt/solid-client.

  For more information about the Access Control Policy structured supported by ESS, please refer to the documentation.

  The default value of this flag is true, and users should have a good understanding of the interaction between Access Grants and Access Control Policy before changing the default value.

Since

0.4.0

Properties

accessEndpoint

• Optional accessEndpoint: string | URL

Since

0.4.0

Defined in

src/gConsent/type/AccessBaseOptions.ts:74

---

fetch

• Optional fetch: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>

Type declaration

▸ (input, init?): Promise<Response>

MDN Reference

Parameters

Name	Type
input	RequestInfo | URL
init?	RequestInit

Returns

Promise<Response>

Defined in

src/gConsent/type/AccessBaseOptions.ts:70

---

updateAcr

• Optional updateAcr: boolean

Since

2.1.0

Defined in

src/gConsent/type/AccessBaseOptions.ts:69