Function issueAccessRequest

issueAccessRequest(
    params: InputAccessRequestParameters,
    options: AccessBaseOptions & {
        customFields?: Set<CustomField>;
        returnLegacyJsonld: false;
    },
): Promise<DatasetWithId>
Request access to a given Resource.
Parameters
- params: InputAccessRequestParameters
  Access to request.
- options: AccessBaseOptions & {
  customFields?: Set<CustomField>;
  returnLegacyJsonld: false;
  }
  Optional properties to customize the access request behavior.
Returns Promise<DatasetWithId>
A signed Verifiable Credential representing the access request.

Since
0.4.0
- Defined in src/gConsent/request/issueAccessRequest.ts:85
issueAccessRequest(
    params: InputAccessRequestParameters,
    options?: AccessBaseOptions & {
        customFields?: Set<CustomField>;
        returnLegacyJsonld?: true;
    },
): Promise<AccessRequest>
Request access to a given Resource.
Parameters
- params: InputAccessRequestParameters
  Access to request.
- Optionaloptions: AccessBaseOptions & {
  customFields?: Set<CustomField>;
  returnLegacyJsonld?: true;
  }
  Optional properties to customize the access request behavior.
Returns Promise<AccessRequest>
A signed Verifiable Credential representing the access request.

Since
0.4.0

Deprecated
Use RDFJS API instead of relying on the JSON structure by setting returnLegacyJsonld to false
- Defined in src/gConsent/request/issueAccessRequest.ts:101
issueAccessRequest(
    params: InputAccessRequestParameters,
    options?: AccessBaseOptions & {
        customFields?: Set<CustomField>;
        returnLegacyJsonld?: boolean;
    },
): Promise<DatasetWithId>
Request access to a given Resource.
Parameters
- params: InputAccessRequestParameters
  Access to request.
- Optionaloptions: AccessBaseOptions & {
  customFields?: Set<CustomField>;
  returnLegacyJsonld?: boolean;
  }
  Optional properties to customize the access request behavior.
Returns Promise<DatasetWithId>
A signed Verifiable Credential representing the access request.

Since
0.4.0

Deprecated
Use RDFJS API instead of relying on the JSON structure by setting returnLegacyJsonld to false
- Defined in src/gConsent/request/issueAccessRequest.ts:117
issueAccessRequest(
    params: DeprecatedAccessRequestParameters,
    options?: AccessBaseOptions & {
        customFields?: Set<CustomField>;
        returnLegacyJsonld?: boolean;
    },
): Promise<AccessRequest>
Parameters
- params: DeprecatedAccessRequestParameters
- Optionaloptions: AccessBaseOptions & {
  customFields?: Set<CustomField>;
  returnLegacyJsonld?: boolean;
  }
Returns Promise<AccessRequest>
Deprecated
Please remove the requestor parameter.
- Defined in src/gConsent/request/issueAccessRequest.ts:127

Function issueAccessRequest

Parameters

Returns Promise<DatasetWithId>

Since

Parameters

Returns Promise<AccessRequest>

Since

Deprecated

Parameters

Returns Promise<DatasetWithId>

Since

Deprecated

Parameters

Returns Promise<AccessRequest>

Deprecated

Settings