JSON Meta Application Protocol
draft-ietf-jmap-core-01
| The information below is for an old version of the document |
| Document |
Type |
|
Active Internet-Draft (jmap WG)
|
|
Author |
|
Neil Jenkins
|
|
Last updated |
|
2017-07-16
|
|
Replaces |
|
draft-jenkins-jmap
|
|
Stream |
|
Internet Engineering Task Force (IETF)
|
|
Formats |
|
pdf
htmlized (tools)
htmlized
bibtex
|
|
Reviews |
|
|
| Stream |
WG state
|
|
WG Document
|
|
Document shepherd |
|
No shepherd assigned
|
| IESG |
IESG state |
|
I-D Exists
|
|
Consensus Boilerplate |
|
Unknown
|
|
Telechat date |
|
|
|
Responsible AD |
|
(None)
|
|
Send notices to |
|
(None)
|
JMAP N. Jenkins
Internet-Draft FastMail
Intended status: Standards Track July 16, 2017
Expires: January 17, 2018
JSON Meta Application Protocol
draft-ietf-jmap-core-01
Abstract
This document specifies a protocol for synchronising JSON-based data
objects efficiently, with support for push and out-of-band binary
data upload/download.
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on January 17, 2018.
Copyright Notice
Copyright (c) 2017 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Jenkins Expires January 17, 2018 [Page 1]
Internet-Draft JMAP July 2017
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Notational Conventions . . . . . . . . . . . . . . . . . 4
1.2. JSON as the data encoding format . . . . . . . . . . . . 4
1.3. Terminology . . . . . . . . . . . . . . . . . . . . . . . 5
1.3.1. User . . . . . . . . . . . . . . . . . . . . . . . . 5
1.3.2. Accounts . . . . . . . . . . . . . . . . . . . . . . 5
1.3.3. Data types and records . . . . . . . . . . . . . . . 5
1.4. Ids . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.5. The JMAP API model . . . . . . . . . . . . . . . . . . . 6
2. Authentication . . . . . . . . . . . . . . . . . . . . . . . 6
2.1. Service autodiscovery . . . . . . . . . . . . . . . . . . 6
2.2. Getting an access token . . . . . . . . . . . . . . . . . 7
2.2.1. 200: Success, but more authorization required. . . . 8
2.2.2. 201: Authentication is complete, access token
created. . . . . . . . . . . . . . . . . . . . . . . 11
2.2.3. 400: Malformed request . . . . . . . . . . . . . . . 13
2.2.4. 403: Authentication step failed, but client may try
again . . . . . . . . . . . . . . . . . . . . . . . . 14
2.2.5. 404: Not found . . . . . . . . . . . . . . . . . . . 14
2.2.6. 410: Restart authentication . . . . . . . . . . . . . 14
2.2.7. 429: Rate limited . . . . . . . . . . . . . . . . . . 14
2.2.8. 500: Internal server error . . . . . . . . . . . . . 14
2.2.9. 503: Service unavailable . . . . . . . . . . . . . . 14
2.3. Refetching URL endpoints . . . . . . . . . . . . . . . . 14
2.3.1. 201: Authentication is complete, access token
created. . . . . . . . . . . . . . . . . . . . . . . 15
2.3.2. 403: Restart authentication . . . . . . . . . . . . . 15
2.3.3. 404: Not found . . . . . . . . . . . . . . . . . . . 15
2.3.4. 500: Internal server error . . . . . . . . . . . . . 16
2.3.5. 503: Service unavailable . . . . . . . . . . . . . . 16
2.4. Revoking an access token . . . . . . . . . . . . . . . . 16
2.4.1. 204: Success . . . . . . . . . . . . . . . . . . . . 16
2.4.2. 401: Unauthorized . . . . . . . . . . . . . . . . . . 16
2.5. Authenticating HTTP requests . . . . . . . . . . . . . . 16
2.5.1. Signed GET requests . . . . . . . . . . . . . . . . . 17
3. Structured data exchange . . . . . . . . . . . . . . . . . . 17
3.1. Making an API request . . . . . . . . . . . . . . . . . . 18
3.1.1. 200: OK . . . . . . . . . . . . . . . . . . . . . . . 18
3.1.2. 400: Bad Request . . . . . . . . . . . . . . . . . . 18
3.1.3. 401: Unauthorized . . . . . . . . . . . . . . . . . . 18
Show full document text