Skip to main content

GetDIDComponentArgs interface

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Input arguments for getDIDComponentById This API may change without a BREAKING CHANGE notice.

Signature:

export interface GetDIDComponentArgs

Properties

PropertyModifiersTypeDescription
didDocumentDIDDocument(BETA) the DID document from which to extract the fragment. This MUST be the document resolved by IResolver.resolveDid()
didUrlstring

(BETA) The DID URI that needs to be dereferenced. This should refer to the subsection by #fragment.

Example: did:example:identifier#controller

section?DIDDocumentSection(BETA) (Optional) Optional. The section of the DID document where to search for the fragment. Example 'keyAgreement', or 'assertionMethod', or 'authentication', etc