audriga

Alter Schlachthof 57 Karlsruhe 76137 Germany joris@audriga.com https://www.audriga.com

audriga

Alter Schlachthof 57 Karlsruhe 76137 Germany hans-joerg@audriga.com https://www.audriga.com

Applications JMAP jmap rest This document specifies a REST Mapping for JMAP endpoints to impose fewer requirements on applications compared to conventional JMAP endpoints.

Introduction Structured data exchange over JMAP usually involves processing JMAP Request JSON payloads. This might impose unnecessary requirements for certain use cases of JMAP. Likely scenarios in which this is beneficiary are situations in which portability needs to be provided due to regulatory requirements or when migrating user data away from legacy platforms. For rapid development of a JMAP API without support for batching, the essential properties of the Request object can instead be implemented as a URI.

Conventions Used In This Document The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 when, and only when, they appear in all capitals, as shown here. The definitions of JSON keys and datatypes in the document follow the conventions described in the core JMAP specification .

Addition to the capabilities object The capabilities object is returned as part of the JMAP Session object; see , Section 2. This document defines one additional capability URI.

urn:ietf:params:jmap:rest The capability urn:ietf:params:jmap:rest being present in the "capabilities" property represents support for the simplified JMAP REST API. The value of this property in the JMAP Session capabilities property and the account's accountCapabilities property is an empty object.

Addition to the Session Resource The JMAP Session Resource will be extended by the following property:

• apiUrlSimple: String The URL to use for JMAP API requests. THE URL MUST contain the variables using and methodCall as defined in Section 3.3. One MAY use additional variables specific to a JMAP method like ids or accountId. Implementations MAY implement the required variables as query parameters to avoid implementing routing logic.

Capability Example { ... "capabilities": { ..., "urn:ietf:params:jmap:rest": {} }, "apiUrlRest": "https://jmap.me/api /?accountId=<account-id>&methodCall=<methodCall>&ids=<ids>" }

Security considerations All security considerations of JMAP apply to this specification.

IANA considerations

JMAP Capability registration for "rest" IANA is requested to register the "rest" JMAP Capability as follows: Capability Name: urn:ietf:params:jmap:rest Specification document: this document Intended use: common Change Controller: IETF Security and privacy considerations: this document, .

Acknowledgements Bron Gondwana, Neil Jenkins, Alexey Melnikov, Ken Murchison, Robert Stepanek and the JMAP working group at the IETF.

Normative References