Skip to main content

PairingInvitationSummary

Safe host-visible status for one reusable pairing invitation.

invitationIdstring<uuid>required

Public invitation identifier.

createdAtstring<date-time>required

UTC invitation creation time.

expiresAtstring<date-time>required

UTC invitation expiry.

successfulPairingsSuccessfulpairings (integer)required

Number of devices that received credentials.

Possible values: >= 0

maxPairingsMaxpairings (integer)required

Maximum successful pairings allowed.

Possible values: >= 1 and <= 20

activeAttemptsActiveattempts (integer)required

Unexpired attempts currently awaiting proof.

Possible values: >= 0

totalAttemptsTotalattempts (integer)required

All attempts issued during the invitation lifetime.

Possible values: >= 0

statePairingInvitationState (string)required

Current invitation state.

Possible values: [active, expired, exhausted, attempt-limit, revoked]

PairingInvitationSummary
{
"invitationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createdAt": "2024-07-29T15:51:28.071Z",
"expiresAt": "2024-07-29T15:51:28.071Z",
"successfulPairings": 0,
"maxPairings": 0,
"activeAttempts": 0,
"totalAttempts": 0,
"state": "active"
}