Global

Methods

deriveKeyFromWordList(wordList, passphraseopt) → {Promise.<Buffer>}

Parameters:
Name Type Attributes Description
wordList string | Array.<string> Array or Space-seperated words
passphrase string <optional>
Optional salt
Source:
Returns:
Generated key
Type
Promise.<Buffer>

Type Definitions

AuthorizeOptions

Type:
  • object
Properties:
Name Type Attributes Description
scope string <optional>
space delimited OpenID-Connect scopes; defaults to `openid`
response_type string <optional>
the authorization processing flow to be used; defaults to 'code'
response_mode string <optional>
the mechanism to be used for returning parameters
nonce string <optional>
string value used to associate a Client session with an ID Token
display string <optional>
specifies how to displays the user interface pages
prompt string <optional>
space delimited values that specifies whether to prompt for reauthentication
login_hint string <optional>
the login identifier the End-User might use to log in
claims ClaimsOptions | string <optional>
JSON with the specific Claims be returned
Source:

KeyInfoMap

Type:
  • object
Properties:
Name Type Description
isRevoked boolean whether the address was revoked
timestamp number the unix-epoch timestamp of the last operation
revokedBy string the address of the revoker
replaces string the address of the credential that is replaced by this
recovery string the address of the registered recovery key
rootAddress string the root address of this credential
Source:

RequestInfo

Type:
  • string | Object
Properties:
Name Type Attributes Description
name string A unique file name for this image.
data string The base64 encoded image data.
oid Dotted <optional>
An optional OID for this image.
loa number <optional>
An optional level of assurance.
pubkey string The HEX-encoded ES256 public key of the subject.
expiry string The expiry date and time for the issued claims.
attributes Object.<Dotted, AttributeValue> A map with `"OID":"value"` pairs.
requestid string <optional>
A unique ID for this request (for example, an UUID) for retries and notifications.
images Array.<ImageInfo> <optional>
An array with images, each with a `ImageInfo` map.
Source:

RequestOptions

Type:
  • object
Properties:
Name Type Attributes Description
username string <optional>
Username of the account trying to log in (if known)
documentUrl string <optional>
The URL to a document for PDF signing
objectIds string | Array.<Dotted> <optional>
A comma-separated list of OIDs
message string <optional>
An optional text message for transaction authorization
callbackType string <optional>
The type of callback, one of "POST", "SYSTEM", or "JSON"
timeout number | string <optional>
The timeout for the request in minutes
Source: