DIDComm Connections

Changed on

Find connection record by query

get/didcomm/connections

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /didcomm/connections
  • Auth
    none declared

Query parameters

outOfBandIdstring
Example:821f9b26-ad04-4f56-89b6-e2ef9c72b36e
aliasstring
state'start' | 'invitation-sent' | 'invitation-received' | 'request-sent' | 'request-received' | 'response-sent' | 'response-received' | 'abandoned' | 'completed'

Connection states as defined in RFC 0023.

didstring
theirDidstring
theirLabelstring

Headers

x-tenant-idstring

Optional header to set the context to a specific tenant. Only needed when the --multi-tenant feature is enabled. Default value is 'default'

Response

Ok

idstring required
createdAtstring date-time required
updatedAtstring date-time
typestring required
didstring
theirDidstring
theirLabelstring
state'start' | 'invitation-sent' | 'invitation-received' | 'request-sent' | 'request-received' | 'response-sent' | 'response-received' | 'abandoned' | 'completed' required

Connection states as defined in RFC 0023.

role'requester' | 'responder' required
aliasstring
autoAcceptConnectionboolean
threadIdstring
imageUrlstring
mediatorIdstring
errorMessagestring
protocol'https://didcomm.org/didexchange/1.x' | 'https://didcomm.org/connections/1.x'

Enum values should be sorted based on order of preference. Values will be included in this order when creating out of band invitations.

outOfBandIdstring
invitationDidstring
previousDidsDid[]
previousTheirDidsDid[]

Example response

[
  {
    "id": "821f9b26-ad04-4f56-89b6-e2ef9c72b36e",
    "threadId": "ea4e5e69-fc04-465a-90d2-9f8ff78aa71d"
  }
]

Changes

  • 33596742b733Revision changes
    • info

      the endpoint scheme security tenants was removed from the API

    • info

      added the new optional header request parameter x-tenant-id

  • a7641432a6c1Revision changes
    • warning

      deleted the header request parameter x-tenant-id

    • info

      the endpoint scheme security tenants was added to the API