Function approveAccessRequest

approveAccessRequest(
    requestVc: string | URL | VerifiableCredential | DatasetWithId,
    requestOverride: Partial<ApproveAccessRequestOverrides>,
    options: AccessBaseOptions & {
        returnLegacyJsonld: false;
        verifyLinkedRequest?: boolean;
    },
): Promise<DatasetWithId>
Approve an access request. The content of the approved access request is provided as a Verifiable Credential which properties may be overridden if necessary.
Parameters
- requestVc: string | URL | VerifiableCredential | DatasetWithId
  The Verifiable Credential representing the Access Request. If not conform to an Access Request, the function will throw.
- requestOverride: Partial<ApproveAccessRequestOverrides>
  Elements overriding information from the provided Verifiable Credential.
- options: AccessBaseOptions & { returnLegacyJsonld: false; verifyLinkedRequest?: boolean }
  Optional properties to customizes the access grant behavior. Options include updateAcr which defaults to true. If this flag is set to true, the ACR of the Resource will be updated when the access grant is approved. If this flag is set to false, the ACR of the Resource will remain unchanged. This is an advanced feature, and only users having a good understanding of the relationship between Access Grants and ACRs should deviate from the default. Additional information is available in the ESS documentation
Returns Promise<DatasetWithId>
A Verifiable Credential representing the granted access.

Since
0.0.1.
- Defined in src/gConsent/manage/approveAccessRequest.ts:162
approveAccessRequest(
    requestVc: string | URL | VerifiableCredential | DatasetWithId,
    requestOverride?: Partial<ApproveAccessRequestOverrides>,
    options?: AccessBaseOptions & { returnLegacyJsonld?: true },
): Promise<AccessGrant>
Approve an access request. The content of the approved access request is provided as a Verifiable Credential which properties may be overridden if necessary.
Parameters
- requestVc: string | URL | VerifiableCredential | DatasetWithId
  The Verifiable Credential representing the Access Request. If not conform to an Access Request, the function will throw.
- OptionalrequestOverride: Partial<ApproveAccessRequestOverrides>
  Elements overriding information from the provided Verifiable Credential.
- Optionaloptions: AccessBaseOptions & { returnLegacyJsonld?: true }
  Optional properties to customizes the access grant behavior. Options include updateAcr which defaults to true. If this flag is set to true, the ACR of the Resource will be updated when the access grant is approved. If this flag is set to false, the ACR of the Resource will remain unchanged. This is an advanced feature, and only users having a good understanding of the relationship between Access Grants and ACRs should deviate from the default. Additional information is available in the ESS documentation
Returns Promise<AccessGrant>
A Verifiable Credential representing the granted access.

Since
0.0.1.

Deprecated
Set the options flag returnLegacyJsonLd to false, and prefer using the RDFJS interfaces.
- Defined in src/gConsent/manage/approveAccessRequest.ts:191
approveAccessRequest(
    requestVc: string | URL | VerifiableCredential | DatasetWithId,
    requestOverride?: Partial<ApproveAccessRequestOverrides>,
    options?: AccessBaseOptions & {
        returnLegacyJsonld?: boolean;
        verifyLinkedRequest?: boolean;
    },
): Promise<DatasetWithId>
Approve an access request. The content of the approved access request is provided as a Verifiable Credential which properties may be overridden if necessary.
Parameters
- requestVc: string | URL | VerifiableCredential | DatasetWithId
  The Verifiable Credential representing the Access Request. If not conform to an Access Request, the function will throw.
- OptionalrequestOverride: Partial<ApproveAccessRequestOverrides>
  Elements overriding information from the provided Verifiable Credential.
- Optionaloptions: AccessBaseOptions & {
  returnLegacyJsonld?: boolean;
  verifyLinkedRequest?: boolean;
  }
  Optional properties to customizes the access grant behavior. Options include updateAcr which defaults to true. If this flag is set to true, the ACR of the Resource will be updated when the access grant is approved. If this flag is set to false, the ACR of the Resource will remain unchanged. This is an advanced feature, and only users having a good understanding of the relationship between Access Grants and ACRs should deviate from the default. Additional information is available in the ESS documentation
Returns Promise<DatasetWithId>
A Verifiable Credential representing the granted access.

Since
0.0.1.

Deprecated
Set the options flag returnLegacyJsonLd to false, and prefer using the RDFJS interfaces.
- Defined in src/gConsent/manage/approveAccessRequest.ts:219
approveAccessRequest(
    requestVc: undefined,
    requestOverride: ApproveAccessRequestOverrides,
    options: AccessBaseOptions & {
        returnLegacyJsonld: false;
        verifyLinkedRequest?: boolean;
    },
): Promise<DatasetWithId>
Approve an access request. The content of the approved access request is provided as a set of claims, and no input Verifiable Credential is expected.
Parameters
- requestVc: undefined
  A Verifiable Credential that would represent the Access Request if provided.
- requestOverride: ApproveAccessRequestOverrides
  Claims constructing the Access Grant.
- options: AccessBaseOptions & { returnLegacyJsonld: false; verifyLinkedRequest?: boolean }
  Optional properties to customise the access grant behaviour.
Returns Promise<DatasetWithId>
A Verifiable Credential representing the granted access.

Since
0.0.1.
- Defined in src/gConsent/manage/approveAccessRequest.ts:239
approveAccessRequest(
    requestVc: undefined,
    requestOverride: ApproveAccessRequestOverrides,
    options?: AccessBaseOptions & { returnLegacyJsonld?: true },
): Promise<AccessGrant>
Approve an access request. The content of the approved access request is provided as a set of claims, and no input Verifiable Credential is expected.
Parameters
- requestVc: undefined
  A Verifiable Credential that would represent the Access Request if provided.
- requestOverride: ApproveAccessRequestOverrides
  Claims constructing the Access Grant.
- Optionaloptions: AccessBaseOptions & { returnLegacyJsonld?: true }
  Optional properties to customise the access grant behaviour.
Returns Promise<AccessGrant>
A Verifiable Credential representing the granted access.

Since
0.0.1.

Deprecated
Set the options flag returnLegacyJsonLd to false, and prefer using the RDFJS interfaces.
- Defined in src/gConsent/manage/approveAccessRequest.ts:259
approveAccessRequest(
    requestVc: undefined,
    requestOverride: ApproveAccessRequestOverrides,
    options?: AccessBaseOptions & WithLegacyJsonFlag,
): Promise<DatasetWithId>
Approve an access request. The content of the approved access request is provided as a set of claims, and no input Verifiable Credential is expected.
Parameters
- requestVc: undefined
  A Verifiable Credential that would represent the Access Request if provided.
- requestOverride: ApproveAccessRequestOverrides
  Claims constructing the Access Grant.
- Optionaloptions: AccessBaseOptions & WithLegacyJsonFlag
  Optional properties to customise the access grant behaviour.
Returns Promise<DatasetWithId>
A Verifiable Credential representing the granted access.

Since
0.0.1.

Deprecated
Set the options flag returnLegacyJsonLd to false, and prefer using the RDFJS interfaces.
- Defined in src/gConsent/manage/approveAccessRequest.ts:278

Function approveAccessRequest

Parameters

Returns Promise<DatasetWithId>

Since

Parameters

Returns Promise<AccessGrant>

Since

Deprecated

Parameters

Returns Promise<DatasetWithId>

Since

Deprecated

Parameters

Returns Promise<DatasetWithId>

Since

Parameters

Returns Promise<AccessGrant>

Since

Deprecated

Parameters

Returns Promise<DatasetWithId>

Since

Deprecated

Settings