Class SignifyClient

constructor

• new SignifyClient(url, bran, tier?, bootUrl?, externalModules?): SignifyClient

• SignifyClient constructor

  Parameters

  • url: string

    KERIA admin interface URL

  • bran: string

    Base64 21 char string that is used as base material for seed of the client AID

  • tier: Tier = Tier.low

    Security tier for generating keys of the client AID (high | mewdium | low)

  • bootUrl: string = DEFAULT_BOOT_URL

    KERIA boot interface URL

  • externalModules: ExternalModule[] = []

    list of external modules to load

  Returns SignifyClient

agent

authn

bootUrl

bran

controller

exteralModules

manager

pidx

tier

url

data

• get data(): (null | string | number | Authenticater)[]

• Returns (null | string | number | Authenticater)[]

approveDelegation

• approveDelegation(): Promise<Response>

• Approve the delegation of the client AID to the KERIA agent

  Returns Promise<Response>

  A promise to the result of the approval

  Async

boot

• boot(): Promise<Response>

• Boot a KERIA agent

  Returns Promise<Response>

  A promise to the result of the boot

  Async

challenges

• challenges(): Challenges

• Get challenges resource

  Returns Challenges

connect

• connect(): Promise<void>

• Connect to a KERIA agent

  Returns Promise<void>

  Async

contacts

• contacts(): Contacts

• Get contacts resource

  Returns Contacts

createSignedRequest

• createSignedRequest(aidName, url, req): Promise<Request>

• Create a Signed Request to fetch a resource from an external URL with headers signed by an AID

  Parameters

  • aidName: string

    Name or alias of the AID to be used for signing

  • url: string

    URL of the requested resource

  • req: RequestInit

    Request options should include: - method: HTTP method - data Data to be sent in the body of the resource. If the data is a CESR JSON string then you should also set contentType to 'application/json+cesr' If the data is a FormData object then you should not set the contentType and the browser will set it to 'multipart/form-data' If the data is an object then you should use JSON.stringify to convert it to a string and set the contentType to 'application/json' - contentType Content type of the request.

  Returns Promise<Request>

  A promise to the created Request

  Async

credentials

• credentials(): Credentials

• Get credentials resource

  Returns Credentials

delegations

• delegations(): Delegations

• Get delegations resource

  Returns Delegations

deletePasscode

• deletePasscode(): Promise<Response>

• Delete a saved passcode from KERIA agent

  Returns Promise<Response>

  A promise to the result of the deletion

  Async

escrows

• escrows(): Escrows

• Get escrows resource

  Returns Escrows

exchanges

• exchanges(): Exchanges

• Get exchange resource

  Returns Exchanges

fetch

• fetch(path, method, data, extraHeaders?): Promise<Response>

• Fetch a resource from the KERIA agent

  Parameters

  • path: string

    Path to the resource

  • method: string

    HTTP method

  • data: any

    Data to be sent in the body of the resource

  • Optional extraHeaders: Headers

    Optional extra headers to be sent with the request

  Returns Promise<Response>

  A promise to the result of the fetch

  Async

groups

• groups(): Groups

• Get groups resource

  Returns Groups

identifiers

• identifiers(): Identifier

• Get identifiers resource

  Returns Identifier

ipex

• ipex(): Ipex

• Get IPEX resource

  Returns Ipex

keyEvents

• keyEvents(): KeyEvents

• Get keyEvents resource

  Returns KeyEvents

keyStates

• keyStates(): KeyStates

• Get keyStates resource

  Returns KeyStates

notifications

• notifications(): Notifications

• Get notifications resource

  Returns Notifications

oobis

• oobis(): Oobis

• Get OOBIs resource

  Returns Oobis

operations

• operations(): Operations

• Get operations resource

  Returns Operations

registries

• registries(): Registries

• Get registries resource

  Returns Registries

rotate

• rotate(nbran, aids): Promise<Response>

• Rotate the client AID

  Parameters

  • nbran: string

    Base64 21 char string that is used as base material for the new seed

  • aids: string[]

    List of managed AIDs to be rotated

  Returns Promise<Response>

  A promise to the result of the rotation

  Async

saveOldPasscode

• saveOldPasscode(passcode): Promise<Response>

• Save old client passcode in KERIA agent

  Parameters

  • passcode: string

    Passcode to be saved

  Returns Promise<Response>

  A promise to the result of the save

  Async

schemas

• schemas(): Schemas

• Get schemas resource

  Returns Schemas

state

• state(): Promise<State>

• Get state of the agent and the client

  Returns Promise<State>

  A promise to the state

  Async