OAuth 2.0 JSON Request
draft-richer-oauth-json-request-00

Document Type Active Internet-Draft (individual)
Last updated 2020-07-09
Stream (None)
Intended RFC status (None)
Formats plain text html xml pdf htmlized (tools) htmlized bibtex
Stream Stream state (No stream defined)
Consensus Boilerplate Unknown
RFC Editor Note (None)
IESG IESG state I-D Exists
Telechat date
Responsible AD (None)
Send notices to (None)
Web Authorization Protocol                                     J. Richer
Internet-Draft                                       Bespoke Engineering
Intended status: Standards Track                             9 July 2020
Expires: 10 January 2021

                         OAuth 2.0 JSON Request
                   draft-richer-oauth-json-request-00

Abstract

   This document specifies a method for sending requests to OAuth
   endpoints as a JSON document instead of a form-encoded document.

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 https://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 10 January 2021.

Copyright Notice

   Copyright (c) 2020 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 (https://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.

Richer                   Expires 10 January 2021                [Page 1]
Internet-Draft             oauth-json-request                  July 2020

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
     1.1.  Conventions and Terminology . . . . . . . . . . . . . . .   2
   2.  Formatting a request as JSON  . . . . . . . . . . . . . . . .   3
     2.1.  Token Endpoint Parameters . . . . . . . . . . . . . . . .   3
   3.  Sending a request as JSON . . . . . . . . . . . . . . . . . .   3
   4.  Examples  . . . . . . . . . . . . . . . . . . . . . . . . . .   3
   5.  Metadata  . . . . . . . . . . . . . . . . . . . . . . . . . .   6
   6.  Security Considerations . . . . . . . . . . . . . . . . . . .   6
   7.  Privacy Considerations  . . . . . . . . . . . . . . . . . . .   6
   8.  Acknowledgements  . . . . . . . . . . . . . . . . . . . . . .   7
   9.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   7
   10. Normative References  . . . . . . . . . . . . . . . . . . . .   7
   11. Informative References  . . . . . . . . . . . . . . . . . . .   7
   Appendix A.  Document History . . . . . . . . . . . . . . . . . .   8
   Author's Address  . . . . . . . . . . . . . . . . . . . . . . . .   8

1.  Introduction

   The OAuth 2.0 authorization framework [RFC6749] uses form encoding
   for requests to the token endpoint, and several extensions including
   [RFC7009] and [RFC7662] also use this format for their own endpoints.
   Additionally, due to this choice, several parameters such as the
   "scope" parameter have a special serialization defined in the
   protocol to allow it to be expressed within the string-based form
   encoding format.

   This draft defines a method for encoding all inputs to form-based
   endpoints in the OAuth 2 protocol as JSON [RFC8259].

1.1.  Conventions and Terminology

   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 [RFC2119] [RFC8174] when, and only when, they appear in all
   capitals, as shown here.

   This specification uses the terms "access token", "refresh token",
   "authorization server", "resource server", "authorization endpoint",
   "authorization request", "authorization response", "token endpoint",
   "grant type", "access token request", "access token response", and
   "client" defined by The OAuth 2.0 Authorization Framework [RFC6749].

Richer                   Expires 10 January 2021                [Page 2]
Internet-Draft             oauth-json-request                  July 2020

2.  Formatting a request as JSON

   The sender creates a JSON object to contain all parameters to the
   target endpoint.  For each parameter to be sent, the parameter name
   is used as the object member name within that object.  The value of
   each parameter is encoded in JSON dependent on which parameter is
   being sent.

   Parameters that have a specific JSON encoding will have an indication
Show full document text