Function issueVerifiableCredential

issueVerifiableCredential(
    issuerEndpoint: string,
    subjectClaims: JsonLd,
    credentialClaims: JsonLd,
    options: {
        fetch?: {
            (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
            (input: string | Request | URL, init?: RequestInit): Promise<Response>;
        };
        returnLegacyJsonld: false;
    },
): Promise<DatasetWithId>
Request that a given Verifiable Credential (VC) Issuer issues a VC containing the provided claims. The VC Issuer is expected to implement the W3C VC Issuer HTTP API.
Parameters
- issuerEndpoint: string
  The /issue endpoint of the VC Issuer.
- subjectClaims: JsonLd
  Claims about the subject that will be attested by the VC.
- credentialClaims: JsonLd
  Claims about the credential itself, rather than its subject, e.g. credential type or expiration.
- options: {
      fetch?: {
          (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
          (input: string | Request | URL, init?: RequestInit): Promise<Response>;
      };
      returnLegacyJsonld: false;
  }
  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.returnLegacyJsonld: Include the normalized JSON-LD in the response
  - Optionalfetch?: {
    (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
    (input: string | Request | URL, init?: RequestInit): Promise<Response>;
    }
  - returnLegacyJsonld: false
Returns Promise<DatasetWithId>
the VC returned by the Issuer if the request is successful. Otherwise, an error is thrown.

Since
0.1.0
- Defined in issue/issue.ts:62
issueVerifiableCredential(
    issuerEndpoint: string,
    subjectClaims: JsonLd,
    credentialClaims?: JsonLd,
    options?: {
        fetch?: {
            (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
            (input: string | Request | URL, init?: RequestInit): Promise<Response>;
        };
        normalize?: (object: VerifiableCredentialBase) => VerifiableCredentialBase;
        returnLegacyJsonld?: true;
    },
): Promise<VerifiableCredential>
Request that a given Verifiable Credential (VC) Issuer issues a VC containing the provided claims. The VC Issuer is expected to implement the W3C VC Issuer HTTP API.
Parameters
- issuerEndpoint: string
  The /issue endpoint of the VC Issuer.
- subjectClaims: JsonLd
  Claims about the subject that will be attested by the VC.
- OptionalcredentialClaims: JsonLd
  Claims about the credential itself, rather than its subject, e.g. credential type or expiration.
- Optionaloptions: {
      fetch?: {
          (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
          (input: string | Request | URL, init?: RequestInit): Promise<Response>;
      };
      normalize?: (object: VerifiableCredentialBase) => VerifiableCredentialBase;
      returnLegacyJsonld?: true;
  }
  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.returnLegacyJsonld: Include the normalized JSON-LD in the response
  - Optionalfetch?: {
    (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
    (input: string | Request | URL, init?: RequestInit): Promise<Response>;
    }
  - Optionalnormalize?: (object: VerifiableCredentialBase) => VerifiableCredentialBase
  - OptionalreturnLegacyJsonld?: true
Returns Promise<VerifiableCredential>
the VC returned by the Issuer if the request is successful. Otherwise, an error is thrown.

Since
0.1.0

Deprecated
Deprecated in favour of setting returnLegacyJsonld: false. This will be the default value in future versions of this library.
- Defined in issue/issue.ts:90
issueVerifiableCredential(
    issuerEndpoint: string,
    subjectClaims: JsonLd,
    credentialClaims?: JsonLd,
    options?: {
        fetch?: {
            (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
            (input: string | Request | URL, init?: RequestInit): Promise<Response>;
        };
        normalize?: (object: VerifiableCredentialBase) => VerifiableCredentialBase;
        returnLegacyJsonld?: boolean;
    },
): Promise<DatasetWithId>
Request that a given Verifiable Credential (VC) Issuer issues a VC containing the provided claims. The VC Issuer is expected to implement the W3C VC Issuer HTTP API.
Parameters
- issuerEndpoint: string
  The /issue endpoint of the VC Issuer.
- subjectClaims: JsonLd
  Claims about the subject that will be attested by the VC.
- OptionalcredentialClaims: JsonLd
  Claims about the credential itself, rather than its subject, e.g. credential type or expiration.
- Optionaloptions: {
      fetch?: {
          (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
          (input: string | Request | URL, init?: RequestInit): Promise<Response>;
      };
      normalize?: (object: VerifiableCredentialBase) => VerifiableCredentialBase;
      returnLegacyJsonld?: boolean;
  }
  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.returnLegacyJsonld: Include the normalized JSON-LD in the response
  - Optionalfetch?: {
    (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
    (input: string | Request | URL, init?: RequestInit): Promise<Response>;
    }
  - Optionalnormalize?: (object: VerifiableCredentialBase) => VerifiableCredentialBase
  - OptionalreturnLegacyJsonld?: boolean
Returns Promise<DatasetWithId>
the VC returned by the Issuer if the request is successful. Otherwise, an error is thrown.

Since
0.1.0

Deprecated
Deprecated in favour of setting returnLegacyJsonld: false. This will be the default value in future versions of this library.
- Defined in issue/issue.ts:119

Function issueVerifiableCredential

Parameters

`Optional`fetch?: {
(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
(input: string | Request | URL, init?: RequestInit): Promise<Response>;
}

returnLegacyJsonld: false

Returns Promise<DatasetWithId>

Since

Parameters

`Optional`fetch?: {
(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
(input: string | Request | URL, init?: RequestInit): Promise<Response>;
}

`Optional`normalize?: (object: VerifiableCredentialBase) => VerifiableCredentialBase

`Optional`returnLegacyJsonld?: true

Returns Promise<VerifiableCredential>

Since

Deprecated

Parameters

`Optional`fetch?: {
(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
(input: string | Request | URL, init?: RequestInit): Promise<Response>;
}

`Optional`normalize?: (object: VerifiableCredentialBase) => VerifiableCredentialBase

`Optional`returnLegacyJsonld?: boolean

Returns Promise<DatasetWithId>

Since

Deprecated

Settings

Function issueVerifiableCredential

Parameters

Optionalfetch?: { (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | Request | URL, init?: RequestInit): Promise<Response>;}

returnLegacyJsonld: false

Returns Promise<DatasetWithId>

Since

Parameters

Optionalfetch?: { (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | Request | URL, init?: RequestInit): Promise<Response>;}

Optionalnormalize?: (object: VerifiableCredentialBase) => VerifiableCredentialBase

OptionalreturnLegacyJsonld?: true

Returns Promise<VerifiableCredential>

Since

Deprecated

Parameters

Optionalfetch?: { (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | Request | URL, init?: RequestInit): Promise<Response>;}

Optionalnormalize?: (object: VerifiableCredentialBase) => VerifiableCredentialBase

OptionalreturnLegacyJsonld?: boolean

Returns Promise<DatasetWithId>

Since

Deprecated

Settings

`Optional`fetch?: {
(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
(input: string | Request | URL, init?: RequestInit): Promise<Response>;
}

`Optional`fetch?: {
(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
(input: string | Request | URL, init?: RequestInit): Promise<Response>;
}

`Optional`normalize?: (object: VerifiableCredentialBase) => VerifiableCredentialBase

`Optional`returnLegacyJsonld?: true

`Optional`fetch?: {
(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
(input: string | Request | URL, init?: RequestInit): Promise<Response>;
}

`Optional`normalize?: (object: VerifiableCredentialBase) => VerifiableCredentialBase

`Optional`returnLegacyJsonld?: boolean