types

Description:

  • Contains various types

Source:

Contains various types

Type Definitions

ActivityPubClaimVerificationConfig

Description:

  • Config related to the verification of ActivityPub claims

Source:
Properties:
Name Type Description
url string

The URL of the verifier account
privateKey string

The private key to sign the request

Config related to the verification of ActivityPub claims

Type:
  • object

ClaimVerificationConfig

Description:

  • Config related to the verification of supported claims

Source:
Properties:
Name Type Attributes Description
activitypub module:types~ActivityPubClaimVerificationConfig <optional>

Config related to the verification of ActivityPub claims
irc module:types~IrcClaimVerificationConfig <optional>

Config related to the verification of IRC claims
matrix module:types~MatrixClaimVerificationConfig <optional>

Config related to the verification of Matrix claims
telegram module:types~TelegramClaimVerificationConfig <optional>

Config related to the verification of Telegram claims
xmpp module:types~XmppClaimVerificationConfig <optional>

Config related to the verification of XMPP claims

Config related to the verification of supported claims

Type:
  • object

IrcClaimVerificationConfig

Description:

  • Config related to the verification of IRC claims

Source:
Properties:
Name Type Description
nick string

The nick that the library uses to connect to the IRC server

Config related to the verification of IRC claims

Type:
  • object

MatrixClaimVerificationConfig

Description:

  • Config related to the verification of Matrix claims

Source:
Properties:
Name Type Description
instance string

The server hostname on which the library can log in
accessToken string

The access token required to identify the library (Matrix docs)

Config related to the verification of Matrix claims

Type:
  • object

ProfilePublicKey

Description:

  • Public key for a profile

Source:
Properties:
Name Type Attributes Description
keyType PublicKeyType

The type of cryptographic key
encoding PublicKeyEncoding

The encoding of the cryptographic key
fingerprint string <optional>

The fingerprint of the cryptographic key
encodedKey string <optional>

The encoded cryptographic key
key module:openpgp~PublicKey | module:jose~JWK <optional>

The raw cryptographic key as object (to be removed during toJSON())
fetch module:types~ProfilePublicKeyFetch

Details on how to fetch the public key

Public key for a profile

Type:
  • object

ProfilePublicKeyFetch

Description:

  • Details on how to fetch the public key

Source:
Properties:
Name Type Attributes Description
method PublicKeyFetchMethod

The method to fetch the key
query string <optional>

The query to fetch the key
resolvedUrl string <optional>

The URL the method eventually resolved to

Details on how to fetch the public key

Type:
  • object

ProfileVerifier

Description:

  • The online verifier instance of identity profiles like Keyoxide's web interface

Source:
Properties:
Name Type Description
name string

Name of the profile verifier
url string

URL to the profile verifier

The online verifier instance of identity profiles like Keyoxide's web interface

Type:
  • object

ProofTarget

Description:

  • The method to find the proof inside the response data

Source:
Properties:
Name Type Description
format ClaimFormat

How the response data is formatted
encoding EntityEncodingFormat

How the response data is encoded
relation ClaimRelation

How the proof is related to the response data
path Array.<string>

Path to the proof inside the response data object

The method to find the proof inside the response data

Type:
  • object

ProxyVerificationConfig

Description:

  • Config related to the use of proxy servers

Source:
Properties:
Name Type Attributes Description
scheme string <optional>

The scheme to use for proxy requests
hostname string <optional>

The hostname of the proxy
policy ProxyPolicy

The policy that defines when to use a proxy

Config related to the use of proxy servers

Type:
  • object

ServiceProviderAbout

Description:

  • Details about the service provider

Source:
Properties:
Name Type Attributes Description
id string

Identifier of the service provider (no whitespace or symbols, lowercase)
name string

Full name of the service provider
homepage string <optional>

URL to the homepage of the service provider

Details about the service provider

Type:
  • object

ServiceProviderClaim

Description:

  • Information about the claim matching process

Source:
Properties:
Name Type Description
uriRegularExpression string

Regular expression used to parse the URI
uriIsAmbiguous boolean

Whether this match automatically excludes other matches

Information about the claim matching process

Type:
  • object

ServiceProviderObject

Description:

  • Service provider

Source:
Properties:
Name Type Description
about module:types~ServiceProviderAbout

Details about the service provider
profile module:types~ServiceProviderProfile

What the profile would look like if a claim matches this service provider
claim module:types~ServiceProviderClaim

Details from the claim matching process
proof module:types~ServiceProviderProof

Information for the proof verification process

Service provider

Type:
  • object

ServiceProviderProfile

Description:

  • What the profile would look like if a claim matches this service provider

Source:
Properties:
Name Type Attributes Description
display string

Profile name to be displayed
uri string

URI or URL for public access to the profile
qr string <optional>

URI or URL associated with the profile usually served as a QR code

What the profile would look like if a claim matches this service provider

Type:
  • object

ServiceProviderProof

Description:

  • Information for the proof verification process

Source:
Properties:
Name Type Description
request module:types~ServiceProviderProofRequest

Details to request the potential proof
response module:types~ServiceProviderProofResponse

Details about the expected response
target Array.<module:types~ProofTarget>

Details about the target located in the response

Information for the proof verification process

Type:
  • object

ServiceProviderProofRequest

Description:

  • Details to request the potential proof

Source:
Properties:
Name Type Attributes Description
uri string <optional>

Location of the proof
fetcher string

Fetcher to be used to request the proof
accessRestriction ProofAccessRestriction

Type of access restriction
data object

Data needed by the fetcher or proxy to request the proof

Details to request the potential proof

Type:
  • object

ServiceProviderProofResponse

Description:

  • Details about the expected response

Source:
Properties:
Name Type Description
format ProofFormat

Expected format of the proof

Details about the expected response

Type:
  • object

TelegramClaimVerificationConfig

Description:

  • Config related to the verification of Telegram claims

Source:
Properties:
Name Type Description
token string

The Telegram API's token (Telegram docs)

Config related to the verification of Telegram claims

Type:
  • object

VerificationConfig

Description:

  • Config used for the claim verification

Source:
Properties:
Name Type Attributes Description
proxy module:types~ProxyVerificationConfig <optional>

Options related to the use of proxy servers
claims module:types~ClaimVerificationConfig <optional>

Config related to the verification of supported claims

Config used for the claim verification

Type:
  • object

VerificationParams

Description:

  • Parameters needed to perform the proof verification

Source:
Properties:
Name Type Attributes Description
target string

Proof to search
claimFormat ClaimFormat

Format of the claim
proofEncodingFormat EntityEncodingFormat

Encoding of the data containing the proof
claimRelation ClaimRelation <optional>

How to find the proof inside the JSON data

Parameters needed to perform the proof verification

Type:
  • object

VerificationResult

Description:

  • Result of the proof verification

Source:
Properties:
Name Type Attributes Description
result boolean

Whether the proof was found and the claim verified
completed boolean

Whether the verification process completed without errors
proof module:types~VerificationResultProof <optional>

Details about the proof and how it was fetched
errors Array.<any>

Errors that ocurred during the verification process

Result of the proof verification

Type:
  • object

VerificationResultProof

Description:

  • Information about the proof in the proof verification result

Source:
Properties:
Name Type Description
fetcher string

Which fetcher was used to obtain the data containing the proof
viaProxy boolean

Whether a proxy was used to obtain the data containing the proof

Information about the proof in the proof verification result

Type:
  • object

XmppClaimVerificationConfig

Description:

  • Config related to the verification of XMPP claims

Source:
Properties:
Name Type Description
service string

The server hostname on which the library can log in
username string

The username used to log in
password string

The password used to log in

Config related to the verification of XMPP claims

Type:
  • object