mx_keys_claim: Claim one-time keys for an Olm handshake

In mx.api: Minimal Matrix Client-Server API

Claim one-time keys for an Olm handshake

Description

POST /_matrix/client/v3/keys/claim. The one_time_keys argument selects which algorithm to claim for each (user_id, device_id) pair.

Usage

mx_keys_claim(session, one_time_keys, timeout = 10000L)

Arguments

session	An mx_session.
one_time_keys	Named list. Names are user ids; values are named lists mapping device ids to the desired algorithm (typically "signed_curve25519").
timeout	Integer milliseconds. Server-side timeout when talking to remote homeservers.

Value

Parsed response with the claimed keys keyed by user_id -> device_id -> "<algorithm>:<key_id>" -> key_object.

Examples

## Not run: 
mx_keys_claim(s, list(
  "@alice:example.org" = list(ABCD1234 = "signed_curve25519")
))

## End(Not run)

mx.api documentation built on Sept. 12, 2026, 1:07 a.m.