matrix-spec/data/api/client-server/definitions/one_time_keys.yaml

---
title: OneTimeKeys
type: object
description: |-
  One-time public keys.  The names of the properties should be in the format
  `<algorithm>:<key_id>`. The format of the key is determined
  by the [key algorithm](/client-server-api/#key-algorithms).
additionalProperties:
  oneOf:
    - type: string
    - type: object
      title: KeyObject
      properties:
        key:
          type: string
          description: The key, encoded using unpadded base64.
        signatures:
          type: object
          description: |-
            Signature for the device. Mapped from user ID to signature object,
            containing mapping from _key signing identifier_ to the signature
            (see also: [Signing JSON](/appendices/#signing-json))
          additionalProperties:
            type: object
      required: ['key', 'signatures']
keys.yml: fix one_time_keys object contents (#1127) * keys.yml: fix one_time_keys object contents The alternatives previously listed under two additionalProperties levels are actually one _more_ level deeper; we still can't define them in a formal way before moving to OpenAPI 3 but at least let's be honest and say there's always a dict where there's always a dict. Also, since the same data structure is used in three places now, at least give it a name, and document the actual definition (once) separately (not using it now because it's OpenAPI 3). * Changelog 2 years ago			`---`
			`title: OneTimeKeys`
			`type: object`
			`description: \|-`
			`One-time public keys. The names of the properties should be in the format`
			`<algorithm>:<key_id>`. The format of the key is determined
			`by the [key algorithm](/client-server-api/#key-algorithms).`
			`additionalProperties:`
			`oneOf:`
			`- type: string`
			`- type: object`
Use `OneTimeKeys` schema (#1800) This was commented prior to the port to OpenAPI 3.1 for technical reasons (#1127). Now we can use it just fine. Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr> 6 months ago			`title: KeyObject`
keys.yml: fix one_time_keys object contents (#1127) * keys.yml: fix one_time_keys object contents The alternatives previously listed under two additionalProperties levels are actually one _more_ level deeper; we still can't define them in a formal way before moving to OpenAPI 3 but at least let's be honest and say there's always a dict where there's always a dict. Also, since the same data structure is used in three places now, at least give it a name, and document the actual definition (once) separately (not using it now because it's OpenAPI 3). * Changelog 2 years ago			`properties:`
			`key:`
			`type: string`
			`description: The key, encoded using unpadded base64.`
			`signatures:`
			`type: object`
			`description: \|-`
			`Signature for the device. Mapped from user ID to signature object,`
			`containing mapping from _key signing identifier_ to the signature`
Use `OneTimeKeys` schema (#1800) This was commented prior to the port to OpenAPI 3.1 for technical reasons (#1127). Now we can use it just fine. Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr> 6 months ago			`(see also: [Signing JSON](/appendices/#signing-json))`
keys.yml: fix one_time_keys object contents (#1127) * keys.yml: fix one_time_keys object contents The alternatives previously listed under two additionalProperties levels are actually one _more_ level deeper; we still can't define them in a formal way before moving to OpenAPI 3 but at least let's be honest and say there's always a dict where there's always a dict. Also, since the same data structure is used in three places now, at least give it a name, and document the actual definition (once) separately (not using it now because it's OpenAPI 3). * Changelog 2 years ago			`additionalProperties:`
			`type: object`
			`required: ['key', 'signatures']`