draft-ietf-oauth-dyn-reg-12.txt   draft-ietf-oauth-dyn-reg-13.txt 
OAuth Working Group J. Richer, Ed. OAuth Working Group J. Richer, Ed.
Internet-Draft The MITRE Corporation Internet-Draft The MITRE Corporation
Intended status: Standards Track J. Bradley Intended status: Standards Track J. Bradley
Expires: December 08, 2013 Ping Identity Expires: January 03, 2014 Ping Identity
M. Jones M. Jones
Microsoft Microsoft
M. Machulak M. Machulak
Newcastle University Newcastle University
June 06, 2013 July 02, 2013
OAuth 2.0 Dynamic Client Registration Protocol OAuth 2.0 Dynamic Client Registration Protocol
draft-ietf-oauth-dyn-reg-12 draft-ietf-oauth-dyn-reg-13
Abstract Abstract
This specification defines an endpoint and protocol for dynamic This specification defines an endpoint and protocol for dynamic
registration of OAuth 2.0 Clients at an Authorization Server and registration of OAuth 2.0 clients at an authorization server and
methods for the dynamically registered client to manage its methods for the dynamically registered client to manage its
registration. registration through an OAuth 2.0 protected web API.
Status of This Memo Status of This Memo
This Internet-Draft is submitted in full conformance with the This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79. provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/. Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on December 08, 2013. This Internet-Draft will expire on January 03, 2014.
Copyright Notice Copyright Notice
Copyright (c) 2013 IETF Trust and the persons identified as the Copyright (c) 2013 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
skipping to change at page 2, line 26 skipping to change at page 2, line 26
1.4.1. Credential Rotation . . . . . . . . . . . . . . . . . 7 1.4.1. Credential Rotation . . . . . . . . . . . . . . . . . 7
2. Client Metadata . . . . . . . . . . . . . . . . . . . . . . . 7 2. Client Metadata . . . . . . . . . . . . . . . . . . . . . . . 7
2.1. Relationship Between Grant Types and Response Types . . . 10 2.1. Relationship Between Grant Types and Response Types . . . 10
2.2. Human Readable Client Metadata . . . . . . . . . . . . . 11 2.2. Human Readable Client Metadata . . . . . . . . . . . . . 11
3. Client Registration Endpoint . . . . . . . . . . . . . . . . 12 3. Client Registration Endpoint . . . . . . . . . . . . . . . . 12
3.1. Client Registration Request . . . . . . . . . . . . . . . 13 3.1. Client Registration Request . . . . . . . . . . . . . . . 13
3.2. Client Registration Response . . . . . . . . . . . . . . 15 3.2. Client Registration Response . . . . . . . . . . . . . . 15
4. Client Configuration Endpoint . . . . . . . . . . . . . . . . 15 4. Client Configuration Endpoint . . . . . . . . . . . . . . . . 15
4.1. Forming the Client Configuration Endpoint URL . . . . . . 15 4.1. Forming the Client Configuration Endpoint URL . . . . . . 15
4.2. Client Read Request . . . . . . . . . . . . . . . . . . . 16 4.2. Client Read Request . . . . . . . . . . . . . . . . . . . 16
4.3. Client Update Request . . . . . . . . . . . . . . . . . . 16 4.3. Client Update Request . . . . . . . . . . . . . . . . . . 17
4.4. Client Delete Request . . . . . . . . . . . . . . . . . . 18 4.4. Client Delete Request . . . . . . . . . . . . . . . . . . 19
5. Responses . . . . . . . . . . . . . . . . . . . . . . . . . . 19 5. Responses . . . . . . . . . . . . . . . . . . . . . . . . . . 20
5.1. Client Information Response . . . . . . . . . . . . . . . 20 5.1. Client Information Response . . . . . . . . . . . . . . . 20
5.2. Client Registration Error Response . . . . . . . . . . . 21 5.2. Client Registration Error Response . . . . . . . . . . . 21
6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 22 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 22
6.1. OAuth Token Endpoint Authentication Methods Registry . . 22 6.1. OAuth Token Endpoint Authentication Methods Registry . . 22
6.1.1. Registration Template . . . . . . . . . . . . . . . . 23 6.1.1. Registration Template . . . . . . . . . . . . . . . . 23
6.1.2. Initial Registry Contents . . . . . . . . . . . . . . 23 6.1.2. Initial Registry Contents . . . . . . . . . . . . . . 23
7. Security Considerations . . . . . . . . . . . . . . . . . . . 23 7. Security Considerations . . . . . . . . . . . . . . . . . . . 24
8. Normative References . . . . . . . . . . . . . . . . . . . . 25 8. Normative References . . . . . . . . . . . . . . . . . . . . 26
Appendix A. Acknowledgments . . . . . . . . . . . . . . . . . . 26 Appendix A. Acknowledgments . . . . . . . . . . . . . . . . . . 27
Appendix B. Client Lifecycle Examples . . . . . . . . . . . . . 27 Appendix B. Client Lifecycle Examples . . . . . . . . . . . . . 27
B.1. Open Registration . . . . . . . . . . . . . . . . . . . . 28 B.1. Open Registration . . . . . . . . . . . . . . . . . . . . 28
B.2. Protected Registration . . . . . . . . . . . . . . . . . 28 B.2. Protected Registration . . . . . . . . . . . . . . . . . 29
B.3. Developer Automation . . . . . . . . . . . . . . . . . . 30 B.3. Developer Automation . . . . . . . . . . . . . . . . . . 30
Appendix C. Document History . . . . . . . . . . . . . . . . . . 31 Appendix C. Document History . . . . . . . . . . . . . . . . . . 32
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 34 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 35
1. Introduction 1. Introduction
In some use-case scenarios, it is desirable or necessary to allow In some use-case scenarios, it is desirable or necessary to allow
OAuth 2.0 clients to obtain authorization from an OAuth 2.0 OAuth 2.0 clients to obtain authorization from an OAuth 2.0
authorization server without requiring the two parties to interact authorization server without requiring the two parties to interact
beforehand. Nevertheless, for the authorization server to accurately beforehand. Nevertheless, for the authorization server to accurately
and securely represent to end-users which client is seeking and securely represent to end-users which client is seeking
authorization to access the end-user's resources, a method for authorization to access the end-user's resources, a method for
automatic and unique registration of clients is needed. The OAuth automatic and unique registration of clients is needed. The OAuth
2.0 authorization framework does not define how the relationship 2.0 authorization framework does not define how the relationship
between the Client and the Authorization Server is initialized, or between the client and the authorization server is initialized, or
how a given client is assigned a unique Client Identifier. how a given client is assigned a unique client identifier.
Historically, this has happened out-of-band from the OAuth 2.0 Historically, this has happened out-of-band from the OAuth 2.0
protocol. This draft provides a mechanism for a client to register protocol. This draft provides a mechanism for a client to register
itself with the Authorization Server, which can be used to itself with the authorization server, which can be used to
dynamically provision a Client Identifier, and optionally a Client dynamically provision a client identifier, and optionally a client
Secret. Additionally, the mechanisms in this draft may can be used secret. Additionally, the mechanisms in this draft may can be used
by a client developer to register the client with the authorization by a client developer to register the client with the authorization
server in a programmatic fashion. server in a programmatic fashion.
As part of the registration process, this specification also defines As part of the registration process, this specification also defines
a mechanism for the client to present the Authorization Server with a a mechanism for the client to present the authorization server with a
set of metadata, such as a display name and icon to be presented to set of metadata, such as a display name and icon to be presented to
the user during the authorization step. This draft also provides a the user during the authorization step. This draft also provides a
mechanism for the Client to read and update this information after mechanism for the client to read and update this information after
the initial registration action. This draft protects these actions the initial registration action. This draft protects these actions
through the use of an OAuth 2.0 Bearer Access Token that is issued to through the use of an OAuth 2.0 bearer access token that is issued to
the client during registration explicitly for this purpose. the client during registration explicitly for this purpose.
1.1. Notational Conventions 1.1. Notational Conventions
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL NOT', The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL NOT',
'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'MAY', and 'OPTIONAL' in this 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'MAY', and 'OPTIONAL' in this
document are to be interpreted as described in [RFC2119]. document are to be interpreted as described in [RFC2119].
Unless otherwise noted, all the protocol parameter names and values Unless otherwise noted, all the protocol parameter names and values
are case sensitive. are case sensitive.
skipping to change at page 3, line 45 skipping to change at page 3, line 45
1.2. Terminology 1.2. Terminology
This specification uses the terms "Access Token", "Refresh Token", This specification uses the terms "Access Token", "Refresh Token",
"Authorization Code", "Authorization Grant", "Authorization Server", "Authorization Code", "Authorization Grant", "Authorization Server",
"Authorization Endpoint", "Client", "Client Identifier", "Client "Authorization Endpoint", "Client", "Client Identifier", "Client
Secret", "Protected Resource", "Resource Owner", "Resource Server", Secret", "Protected Resource", "Resource Owner", "Resource Server",
and "Token Endpoint" defined by OAuth 2.0 [RFC6749]. and "Token Endpoint" defined by OAuth 2.0 [RFC6749].
This specification defines the following additional terms: This specification defines the following additional terms:
Client Registration Endpoint OAuth 2.0 Endpoint through which a Client Registration Endpoint OAuth 2.0 endpoint through which a
Client can be registered at an Authorization Server. The means by client can be registered at an authorization server. The means by
which the URL for this endpoint are obtained are out of scope for which the URL for this endpoint are obtained are out of scope for
this specification. this specification.
Client Configuration Endpoint OAuth 2.0 Endpoint through which Client Configuration Endpoint OAuth 2.0 endpoint through which
registration information for a registered Client can be managed. registration information for a registered client can be managed.
This URL for this endpoint is returned by the Authorization Server This URL for this endpoint is returned by the authorization server
in the Client Information Response. in the client information response.
Registration Access Token OAuth 2.0 Bearer Token issued by the Registration Access Token OAuth 2.0 bearer token issued by the
Authorization Server through the Client Registration Endpoint that authorization server through the client registration endpoint that
is used to authenticate the caller when accessing the Client's is used to authenticate the caller when accessing the client's
registration information at the Client Configuration Endpoint. registration information at the client configuration endpoint.
This Access Token is associated with a particular registered This access token is associated with a particular registered
Client. client.
Initial Access Token OAuth 2.0 Access Token optionally issued by an Initial Access Token OAuth 2.0 access token optionally issued by an
Authorization Server and used to authorize calls to the Client Authorization Server and used to authorize calls to the client
Registration Endpoint. The means by which the Authorization registration endpoint. The type and format of this token are
Server issues this token as well as the means by which the likely service-specific and are out of scope for this
Registration Endpoint validates this token are out of scope for specification. The means by which the authorization server issues
this specification. this token as well as the means by which the registration endpoint
validates this token are out of scope for this specification.
1.3. Protocol Flow 1.3. Protocol Flow
(preamble) (preamble)
+--------(A)- Initial Access Token +--------(A)- Initial Access Token
| |
v v
+-----------+ +---------------+ +-----------+ +---------------+
| |--(B)- Client Registration Request -->| Client | | |--(B)- Client Registration Request -->| Client |
skipping to change at page 5, line 4 skipping to change at page 5, line 4
| |<-(E)- Client Information Response ---| Client | | |<-(E)- Client Information Response ---| Client |
| | | Configuration | | | | Configuration |
| | | Endpoint | | | | Endpoint |
| | | | | | | |
| |--(F)- Delete Request --------------->| | | |--(F)- Delete Request --------------->| |
| | | | | | | |
| |<-(G)- Delete Confirmation -----------| | | |<-(G)- Delete Confirmation -----------| |
+-----------+ +---------------+ +-----------+ +---------------+
Figure 1: Abstract Protocol Flow Figure 1: Abstract Protocol Flow
The abstract OAuth 2.0 Client Dynamic Registration flow illustrated The abstract OAuth 2.0 Client dynamic registration flow illustrated
in Figure 1 describes the interaction between the Client or Developer in Figure 1 describes the interaction between the client or developer
and the two Endpoints defined in this specification. This figure and the two endpoints defined in this specification. This figure
does not demonstrate error conditions. This flow includes the does not demonstrate error conditions. This flow includes the
following steps: following steps:
(A) (A)
Optionally, the Client or Developer is issued an Initial Access Optionally, the client or developer is issued an initial access
Token for use with the Client Registration Endpoint. The method token for use with the client registration endpoint. The method
by which the Initial Access Token is issued to the Client or by which the initial access token is issued to the client or
Developer is out of scope for this specification. developer is out of scope for this specification.
(B) (B)
The Client or Developer calls the Client Registration Endpoint The client or developer calls the client registration endpoint
with its desired registration metadata, optionally including the with its desired registration metadata, optionally including the
Initial Access Token from (A) if one is required by the initial access token from (A) if one is required by the
Authorization Server. authorization server.
(C) (C)
The Authorization Server registers the Client and returns the The authorization server registers the client and returns the
client's registered metadata, a Client Identifier that is unique client's registered metadata, a client identifier that is unique
at the server, a set of Client Credentials such as a Client Secret at the server, a set of client credentials such as a client secret
if applicable for this Client, a URI pointing to the Client if applicable for this client, a URI pointing to the client
Configuration Endpoint, and a Registration Access Token to be used configuration endpoint, and a registration access token to be used
when calling the Client Configuration Endpoint. when calling the client configuration endpoint.
(D) (D)
The Client or Developer optionally calls the Client Configuration The client or developer optionally calls the client configuration
Endpoint with a Read or Update request using the Registration endpoint with a read or update request using the registration
Access Token issued in (C). An Update request contains all of the access token issued in (C). An update request contains all of the
client's registered metadata. client's registered metadata.
(E) (E)
The Authorization Server responds with the Client's current The authorization server responds with the client's current
configuration, potentially including a new Registration Access configuration, potentially including a new registration access
Token and a new set of Client Credentials such as a Client Secret token and a new set of client credentials such as a client secret
if applicable for this Client. If a new Registration Access Token if applicable for this client. If a new registration access token
is issued, it replaces the token issued in (C) for all subsequent is issued, it replaces the token issued in (C) for all subsequent
calls to the Client Configuration Endpoint. calls to the client configuration endpoint.
(F) (F)
The Client or Developer optionally calls the Client Configuration The client or developer optionally calls the client configuration
Endpoint with a Delete request using the Registration Access Token endpoint with a delete request using the registration access token
issued in (C). issued in (C).
(G) (G)
The Authorization Server deprovisions the client and responds with The authorization server deprovisions the client and responds with
a confirmation that the deletion has taken place. a confirmation that the deletion has taken place.
Further discussion of possible example lifecycles are found in the Further discussion of possible example lifecycles are found in the
Appendix to this specification, Client Lifecycle Examples Appendix to this specification, Client Lifecycle Examples
(Appendix B). (Appendix B).
1.4. Registration Tokens and Client Credentials 1.4. Registration Tokens and Client Credentials
Throughout the course of the Dynamic Registration protocol, there are Throughout the course of the dynamic registration protocol, there are
three different classes of credentials in play, each with different three different classes of credentials in play, each with different
properties and targets. properties and targets.
o The Initial Access Token is optionally used by the Client or o The initial access token is optionally used by the client or
Developer at the Registration Endpoint. This is an OAuth 2.0 developer at the registration endpoint. This is an OAuth 2.0
Token that is used to authorize the initial Client Registration token that is used to authorize the initial client registration
Request. The content, structure, generation, and validation of request. The content, structure, generation, and validation of
this token are out of scope for this specification. The this token are out of scope for this specification. The
Authorization Server can use this token to verify that the authorization server can use this token to verify that the
presenter is allowed to dynamically register new clients. This presenter is allowed to dynamically register new clients. This
token may be shared between multiple instances of a Client to token may be shared between multiple instances of a client to
allow them to each register separately, thereby letting the allow them to each register separately, thereby letting the
Authorization Server use this token to tie multiple instances of authorization server use this token to tie multiple instances of
registered clients (each with their own distinct Client registered clients (each with their own distinct client
Identifier) back to the party to whom the Initial Access Token was identifier) back to the party to whom the initial access token was
issued, usually an application developer. This token should be issued, usually an application developer. This token should be
used only at the Client Registration Endpoint. used only at the client registration endpoint.
o The Registration Access Token is used by the Client or Developer o The registration access token is used by the client or developer
at the Client Configuration Endpoint and represents the holder's at the client configuration endpoint and represents the holder's
authorization to manage the registration of a Client. This is an authorization to manage the registration of a client. This is an
OAuth 2.0 Bearer Token that is issued from the Client Registration OAuth 2.0 bearer token that is issued from the client registration
Endpoint in response to a Client Registration Request and is endpoint in response to a client registration request and is
returned in a Client Information Response. The Registration returned in a client information response. The registration
Access Token is uniquely bound to the Client Identifier and is access token is uniquely bound to the client identifier and is
required to be presented with all calls to the Client required to be presented with all calls to the client
Configuration Endpoint. The Registration Access Token should be configuration endpoint. The registration access token should be
protected and should not be shared between instances of a client protected and should not be shared between instances of a client
(otherwise, one instance could change or delete registration (otherwise, one instance could change or delete registration
values for all instances of the client). The Registration Access values for all instances of the client). The registration access
Token can be rotated through the use of the client read and update token can be rotated through the use of the client read and update
methods on the Client Configuration Endpoint. The Registration methods on the client configuration endpoint. The registration
Access Token should be used only at the Client Configuration access token should be used only at the client configuration
Endpoint. endpoint.
o The Client Credentials (such as "client_secret") are optional o The client credentials (such as "client_secret") are optional
depending on the type of Client and are used to retrieve OAuth depending on the type of client and are used to retrieve OAuth
tokens. Client Credentials are usually bound to particular tokens. Client credentials are most often bound to particular
instances of a Client and should not be shared between instances. instances of a client and should not be shared between instances.
Since not all types of Clients have Client Credentials, they Note that since not all types of clients have client credentials,
cannot be used to manage client registrations. The Client they cannot be used to manage client registrations at the client
Credentials can be rotated through the use of the client read and configuration endpoint. The client credentials can be rotated
update methods on the Client Configuration Endpoint. The Client through the use of the client read and update methods on the
Credentials should not be used for authentication at the Client client configuration endpoint. The client credentials can not be
Registration Endpoint or at the Client Configuration endpoint. used for authentication at the client registration endpoint or at
the client configuration endpoint.
1.4.1. Credential Rotation 1.4.1. Credential Rotation
The Authorization Server MAY rotate the Client's Registration Access The Authorization Server MAY rotate the client's registration access
Token and/or Client Credentials (such as a client_secret) throughout token and/or client credentials (such as a "client_secret")
the lifetime of the Client. The Client is informed of the changed throughout the lifetime of the client. The client is informed of the
values changing by making calls either Read or Update requests to the changed values changing by making either read or update requests to
Client Configuration Endpoint, and the new values of the Registration the client configuration endpoint, and the new values of the
Access Token and the Client Credentials will be included in the registration access token and the client credentials will be included
Client Information Response. in the client information response.
The Registration Access Token SHOULD be rotated only in response to a The registration access token SHOULD be rotated only in response to a
Read or Update request to the Client Configuration Endpoint, at which read or update request to the client configuration endpoint, at which
point the new Registration Access Token is returned to the Client and point the new registration access token is returned to the client and
the old Registration Access Token SHOULD be discarded by both the old registration access token SHOULD be discarded by both
parties. parties. If the registration access token to expire or be rotated
outside of such requests, the client or developer may be locked out
of managing the client's configuration.
2. Client Metadata 2. Client Metadata
Clients generally have an array of metadata associated with their Clients generally have an array of metadata associated with their
unique Client Identifier at the Authorization Server. These can unique client identifier at the authorization server. These can
range from human-facing display strings, such as a client name, to range from human-facing display strings, such as a client name, to
items that impact the security of the protocol, such as the list of items that impact the security of the protocol, such as the list of
valid redirect URIs. valid redirect URIs.
The client metadata values serve two parallel purposes in the overall The client metadata values serve two parallel purposes in the overall
OAuth 2.0 Dynamic Client Registration protocol: OAuth 2.0 dynamic client registration protocol:
o the Client requesting its desired values for each parameter to the o the client requesting its desired values for each parameter to the
Authorization Server in a register (Section 3.1) or update authorization server in a register (Section 3.1) or update
(Section 4.3) request, and (Section 4.3) request, and
o the Authorization Server informing the Client of the current o the authorization server informing the client of the current
values of each parameter that the Client has been registered to values of each parameter that the client has been registered to
use through a client information response (Section 5.1). use through a client information response (Section 5.1).
An Authorization Server MAY override any value that a Client requests An authorization server MAY override any value that a client requests
during the registration process (including any omitted values) and during the registration process (including any omitted values) and
replace the requested value with a default at the server's replace the requested value with a default at the server's
discretion. The Authorization Server SHOULD provide documentation discretion. The authorization server SHOULD provide documentation
for any fields that it requires to be filled in by the client or to for any fields that it requires to be filled in by the client or to
have particular values or formats. An Authorization Server MAY have particular values or formats. An authorization server MAY
ignore the values in any field in this list. ignore the values provided by the client for any field in this list.
Extensions and profiles of this specification MAY expand this list, Extensions and profiles of this specification MAY expand this list,
and Authorization Servers MUST accept all fields in this list. The and authorization servers MUST accept all fields in this list. The
Authorization Server MUST ignore any additional parameters sent by authorization server MUST ignore any additional parameters sent by
the Client that it does not understand. the Client that it does not understand.
redirect_uris redirect_uris
Array of redirect URIs for use in redirect-based flows such as the Array of redirect URIs for use in redirect-based flows such as the
Authorization Code and Implicit grant types. It is RECOMMENDED authorization code and implicit grant types. It is RECOMMENDED
that clients using these flows register this parameter, and an that clients using these flows register this parameter, and an
Authorization Server SHOULD require registration of valid redirect authorization server SHOULD require registration of valid redirect
URIs for all clients that use these grant types to protect against URIs for all clients that use these grant types to protect against
token and credential theft attacks. token and credential theft attacks.
client_name client_name
Human-readable name of the Client to be presented to the user. If Human-readable name of the client to be presented to the user. If
omitted, the Authorization Server MAY display the raw "client_id" omitted, the authorization server MAY display the raw "client_id"
value to the user instead. It is RECOMMENDED that clients always value to the user instead. It is RECOMMENDED that clients always
send this field. The value of this field MAY be internationalized send this field. The value of this field MAY be internationalized
as described in Human Readable Client Metadata (Section 2.2). as described in Human Readable Client Metadata (Section 2.2).
client_uri client_uri
URL of the homepage of the Client. If present, the server SHOULD URL of the homepage of the client. If present, the server SHOULD
display this URL to the end user in a clickable fashion. It is display this URL to the end user in a clickable fashion. It is
RECOMMENDED that clients always send this field. The value of RECOMMENDED that clients always send this field. The value of
this field MUST point to a valid Web page. The value of this this field MUST point to a valid web page. The value of this
field MAY be internationalized as described in Human Readable field MAY be internationalized as described in Human Readable
Client Metadata (Section 2.2). Client Metadata (Section 2.2).
logo_uri logo_uri
URL that references a logo for the Client. If present, the server URL that references a logo for the client. If present, the server
SHOULD display this image to the end user during approval. The SHOULD display this image to the end user during approval. The
value of this field MUST point to a valid image file. The value value of this field MUST point to a valid image file. The value
of this field MAY be internationalized as described in Human of this field MAY be internationalized as described in Human
Readable Client Metadata (Section 2.2). Readable Client Metadata (Section 2.2).
contacts contacts
Array of email addresses for people responsible for this Client. Array of email addresses for people responsible for this client.
The Authorization Server MAY make these addresses available to end The authorization server MAY make these addresses available to end
users for support requests for the Client. An Authorization users for support requests for the client. An authorization
Server MAY use these email addresses as identifiers for an server MAY use these email addresses as identifiers for an
administrative page for this client. administrative page for this client.
tos_uri tos_uri
URL that points to a human-readable Terms of Service document for URL that points to a human-readable Terms of Service document for
the Client. The Authorization Server SHOULD display this URL to the client. The Authorization Server SHOULD display this URL to
the End-User if it is given. The Terms of Service usually the end-user if it is given. The Terms of Service usually
describe a contractual relationship between the End-User and the describe a contractual relationship between the end-user and the
Client that the End-User accepts when authorizing the Client. The client that the end-user accepts when authorizing the client. The
value of this field MUST point to a valid Web page. The value of value of this field MUST point to a valid web page. The value of
this field MAY be internationalized as described in Human Readable this field MAY be internationalized as described in Human Readable
Client Metadata (Section 2.2). Client Metadata (Section 2.2).
policy_uri policy_uri
URL that points to a human-readable Policy document for the URL that points to a human-readable Policy document for the
Client. The Authorization Server SHOULD display this URL to the client. The authorization server SHOULD display this URL to the
End-User if it is given. The Policy usually describes how an End- end-user if it is given. The policy usually describes how an end-
User's data will be used by the Client. The value of this field user's data will be used by the client. The value of this field
MUST point to a valid Web page. The value of this field MAY be MUST point to a valid web page. The value of this field MAY be
internationalized as described in Human Readable Client Metadata internationalized as described in Human Readable Client Metadata
(Section 2.2). (Section 2.2).
token_endpoint_auth_method token_endpoint_auth_method
The requested authentication method for the Token Endpoint. The requested authentication method for the token endpoint.
Values defined by this specification are: Values defined by this specification are:
* "none": The client is a public client as defined in OAuth 2.0 * "none": The client is a public client as defined in OAuth 2.0
and does not have a client secret. and does not have a client secret.
* "client_secret_post": The client uses the HTTP POST parameters * "client_secret_post": The client uses the HTTP POST parameters
defined in OAuth 2.0 section 2.3.1. defined in OAuth 2.0 section 2.3.1.
* "client_secret_basic": the client uses HTTP Basic defined in * "client_secret_basic": the client uses HTTP Basic defined in
OAuth 2.0 section 2.3.1 OAuth 2.0 section 2.3.1
Additional values can be defined via the IANA OAuth Token Endpoint Additional values can be defined via the IANA OAuth Token Endpoint
Authentication Methods registry Section 6.1. Absolute URIs can Authentication Methods Registry Section 6.1. Absolute URIs can
also be used as values for this parameter. If unspecified or also be used as values for this parameter without being
omitted, the default is "client_secret_basic", denoting HTTP Basic registered. If unspecified or omitted, the default is
Authentication Scheme as specified in Section 2.3.1 of OAuth 2.0. "client_secret_basic", denoting HTTP Basic Authentication Scheme
as specified in Section 2.3.1 of OAuth 2.0.
scope scope
Space separated list of scope values (as described in OAuth 2.0 Space separated list of scope values (as described in OAuth 2.0
Section 3.3 [RFC6749]) that the client can use when requesting Section 3.3 [RFC6749]) that the client can use when requesting
access tokens. The semantics of values in this list is service access tokens. The semantics of values in this list is service
specific. If omitted, an Authorization Server MAY register a specific. If omitted, an authorization server MAY register a
Client with a default set of scopes. Client with a default set of scopes.
grant_types grant_types
Array of OAuth 2.0 grant types that the Client may use. These Array of OAuth 2.0 grant types that the Client may use. These
grant types are defined as follows: grant types are defined as follows:
* "authorization_code": The Authorization Code Grant described in * "authorization_code": The Authorization Code Grant described in
OAuth 2.0 Section 4.1 OAuth 2.0 Section 4.1
* "implicit": The Implicit Grant described in OAuth 2.0 * "implicit": The Implicit Grant described in OAuth 2.0
Section 4.2 Section 4.2
* "password": The Resource Owner Password Credentials Grant * "password": The Resource Owner Password Credentials Grant
described in OAuth 2.0 Section 4.3 described in OAuth 2.0 Section 4.3
* "client_credentials": The Client Credentials Grant described in * "client_credentials": The Client Credentials Grant described in
OAuth 2.0 Section 4.4 OAuth 2.0 Section 4.4
* "refresh_token": The Refresh Token Grant described in OAuth 2.0 * "refresh_token": The Refresh Token Grant described in OAuth 2.0
Section 6. Section 6.
* "urn:ietf:params:oauth:grant-type:jwt-bearer": The JWT Bearer * "urn:ietf:params:oauth:grant-type:jwt-bearer": The JWT Bearer
grant type defined in OAuth JWT Bearer Token Profiles Grant defined in OAuth JWT Bearer Token Profiles [OAuth.JWT].
[OAuth.JWT].
* "urn:ietf:params:oauth:grant-type:saml2-bearer": The SAML 2 * "urn:ietf:params:oauth:grant-type:saml2-bearer": The SAML 2
Bearer grant type defined in OAuth SAML 2 Bearer Token Profiles Bearer Grant defined in OAuth SAML 2 Bearer Token Profiles
[OAuth.SAML2]. [OAuth.SAML2].
Authorization Servers MAY allow for other values as defined in Authorization Servers MAY allow for other values as defined in
grant type extensions to OAuth 2.0. The extension process is grant type extensions to OAuth 2.0. The extension process is
described in OAuth 2.0 Section 2.5. If the Token Endpoint is used described in OAuth 2.0 Section 2.5. If the token endpoint is used
in the grant type, the value of this parameter MUST be the same as in the grant type, the value of this parameter MUST be the same as
the value of the "grant_type" parameter passed to the Token the value of the "grant_type" parameter passed to the token
Endpoint defined in the extension. endpoint defined in the extension.
response_types response_types
Array of the OAuth 2.0 response types that the Client may use. Array of the OAuth 2.0 response types that the Client may use.
These response types are defined as follows: These response types are defined as follows:
* "code": The Authorization Code response described in OAuth 2.0 * "code": The Authorization Code response described in OAuth 2.0
Section 4.1. Section 4.1.
* "token": The Implicit response described in OAuth 2.0 * "token": The Implicit response described in OAuth 2.0
Section 4.2. Section 4.2.
Authorization Servers MAY allow for other values as defined in Authorization servers MAY allow for other values as defined in
response type extensions to OAuth 2.0. The extension process is response type extensions to OAuth 2.0. The extension process is
described in OAuth 2.0 Section 2.5, and the value of this described in OAuth 2.0 Section 2.5. If the authorization endpoint
parameter MUST be the same as the value of the "response_type" is used by the grant type, the value of this parameter MUST be the
parameter passed to the Authorization Endpoint defined in the same as the value of the "response_type" parameter passed to the
extension. authorization endpoint defined in the extension.
jwks_uri jwks_uri
URL for the Client's JSON Web Key Set [JWK] document representing URL for the Client's JSON Web Key Set [JWK] document representing
the client's public keys. The value of this field MUST point to a the client's public keys. The value of this field MUST point to a
valid JWK Set. These keys MAY also be used for higher level valid JWK Set. These keys MAY be used for higher level protocols
protocols that require signing or encryption. that require signing or encryption.
2.1. Relationship Between Grant Types and Response Types 2.1. Relationship Between Grant Types and Response Types
The "grant_types" and "response_types" values described above are The "grant_types" and "response_types" values described above are
partially orthogonal, as they refer to arguments passed to different partially orthogonal, as they refer to arguments passed to different
endpoints in the OAuth protocol. However, they are related in that endpoints in the OAuth protocol. However, they are related in that
the "grant_types" available to a client influence the the "grant_types" available to a client influence the
"response_types" that the client is allowed to use, and vice versa. "response_types" that the client is allowed to use, and vice versa.
For instance, a "grant_types" value that includes For instance, a "grant_types" value that includes
"authorization_code" implies a "response_types" value that includes "authorization_code" implies a "response_types" value that includes
code, as both values are defined as part of the OAuth 2.0 "code", as both values are defined as part of the OAuth 2.0
Authorization Code Grant. As such, a server supporting these fields authorization code grant. As such, a server supporting these fields
SHOULD take steps to ensure that a client cannot register itself into SHOULD take steps to ensure that a client cannot register itself into
an inconsistent state. an inconsistent state.
The correlation between the two fields is listed in the table below. The correlation between the two fields is listed in the table below.
+-------------------------------------------------+-----------------+ +-------------------------------------------------+-----------------+
| grant_types value includes: | response_types | | grant_types value includes: | response_types |
| | value includes: | | | value includes: |
+-------------------------------------------------+-----------------+ +-------------------------------------------------+-----------------+
| authorization_code | code | | authorization_code | code |
skipping to change at page 11, line 18 skipping to change at page 11, line 24
| urn:ietf:params:oauth:grant-type:jwt-bearer | (none) | | urn:ietf:params:oauth:grant-type:jwt-bearer | (none) |
| urn:ietf:params:oauth:grant-type:saml2-bearer | (none) | | urn:ietf:params:oauth:grant-type:saml2-bearer | (none) |
+-------------------------------------------------+-----------------+ +-------------------------------------------------+-----------------+
Extensions and profiles of this document that introduce new values to Extensions and profiles of this document that introduce new values to
either the "grant_types" or "response_types" parameter MUST document either the "grant_types" or "response_types" parameter MUST document
all correspondences between these two parameter types. all correspondences between these two parameter types.
2.2. Human Readable Client Metadata 2.2. Human Readable Client Metadata
Human-readable Client Metadata values and Client Metadata values that Human-readable client metadata values and client metadata values that
reference human-readable values MAY be represented in multiple reference human-readable values MAY be represented in multiple
languages and scripts. For example, the values of fields such as languages and scripts. For example, the values of fields such as
"client_name", "tos_uri", "policy_uri", "logo_uri", and "client_uri" "client_name", "tos_uri", "policy_uri", "logo_uri", and "client_uri"
might have multiple locale-specific values in some Client might have multiple locale-specific values in some client
registrations. registrations.
To specify the languages and scripts, BCP47 [RFC5646] language tags To specify the languages and scripts, BCP47 [RFC5646] language tags
are added to Client Metadata member names, delimited by a # are added to client metadata member names, delimited by a #
character. Since JSON member names are case sensitive, it is character. Since JSON member names are case sensitive, it is
RECOMMENDED that language tag values used in Claim Names be spelled RECOMMENDED that language tag values used in Claim Names be spelled
using the character case with which they are registered in the IANA using the character case with which they are registered in the IANA
Language Subtag Registry [IANA.Language]. In particular, normally Language Subtag Registry [IANA.Language]. In particular, normally
language names are spelled with lowercase characters, region names language names are spelled with lowercase characters, region names
are spelled with uppercase characters, and languages are spelled with are spelled with uppercase characters, and languages are spelled with
mixed case characters. However, since BCP47 language tag values are mixed case characters. However, since BCP47 language tag values are
case insensitive, implementations SHOULD interpret the language tag case insensitive, implementations SHOULD interpret the language tag
values supplied in a case insensitive manner. Per the values supplied in a case insensitive manner. Per the
recommendations in BCP47, language tag values used in Metadata member recommendations in BCP47, language tag values used in metadata member
names should only be as specific as necessary. For instance, using names should only be as specific as necessary. For instance, using
"fr" might be sufficient in many contexts, rather than "fr-CA" or "fr" might be sufficient in many contexts, rather than "fr-CA" or
"fr-FR". "fr-FR".
For example, a Client could represent its name in English as For example, a client could represent its name in English as
""client_name#en": "My Client"" and its name in Japanese as ""client_name#en": "My Client"" and its name in Japanese as
""client_name#ja-Jpan-JP": ""client_name#ja-Jpan-JP":
"\u30AF\u30E9\u30A4\u30A2\u30F3\u30C8\u540D"" within the same "\u30AF\u30E9\u30A4\u30A2\u30F3\u30C8\u540D"" within the same
registration request. The Authorization Server MAY display any or registration request. The authorization server MAY display any or
all of these names to the Resource Owner during the authorization all of these names to the resource owner during the authorization
step, choosing which name to display based on system configuration, step, choosing which name to display based on system configuration,
user preferences or other factors. user preferences or other factors.
If any human-readable field is sent without a language tag, parties If any human-readable field is sent without a language tag, parties
using it MUST NOT make any assumptions about the language, character using it MUST NOT make any assumptions about the language, character
set, or script of the string value, and the string value MUST be used set, or script of the string value, and the string value MUST be used
as-is wherever it is presented in a user interface. To facilitate as-is wherever it is presented in a user interface. To facilitate
interoperability, it is RECOMMENDED that clients and servers use a interoperability, it is RECOMMENDED that clients and servers use a
human-readable field without any language tags in addition to any human-readable field without any language tags in addition to any
language-specific fields, and it is RECOMMENDED that any human- language-specific fields, and it is RECOMMENDED that any human-
readable fields sent without language tags contain values suitable readable fields sent without language tags contain values suitable
for display on a wide variety of systems. for display on a wide variety of systems.
Implementer's Note: Many JSON libraries make it possible to reference Implementer's Note: Many JSON libraries make it possible to reference
members of a JSON object as members of an Object construct in the members of a JSON object as members of an object construct in the
native programming environment of the library. However, while the native programming environment of the library. However, while the
"#" character is a valid character inside of a JSON object's member "#" character is a valid character inside of a JSON object's member
names, it is not a valid character for use in an object member name names, it is not a valid character for use in an object member name
in many programming environments. Therefore, implementations will in many programming environments. Therefore, implementations will
need to use alternative access forms for these claims. For instance, need to use alternative access forms for these claims. For instance,
in JavaScript, if one parses the JSON as follows, "var j = in JavaScript, if one parses the JSON as follows, "var j =
JSON.parse(json);", then the member "client_name#en-us" can be JSON.parse(json);", then the member "client_name#en-us" can be
accessed using the JavaScript syntax "j["client_name#en-us"]". accessed using the JavaScript syntax "j["client_name#en-us"]".
3. Client Registration Endpoint 3. Client Registration Endpoint
The Client Registration Endpoint is an OAuth 2.0 Endpoint defined in The client registration endpoint is an OAuth 2.0 endpoint defined in
this document that is designed to allow a Client to be registered this document that is designed to allow a client to be registered
with the Authorization Server. The Client Registration Endpoint MUST with the authorization server. The client registration Endpoint MUST
accept HTTP POST messages with request parameters encoded in the accept HTTP POST messages with request parameters encoded in the
entity body using the "application/json" format. The Client entity body using the "application/json" format. The client
Registration Endpoint MUST be protected by a transport-layer security registration endpoint MUST be protected by a transport-layer security
mechanism, and the server MUST support TLS 1.2 RFC 5246 [RFC5246] and mechanism, and the server MUST support TLS 1.2 RFC 5246 [RFC5246] and
/or TLS 1.0 [RFC2246] and MAY support additional transport-layer /or TLS 1.0 [RFC2246] and MAY support additional transport-layer
mechanisms meeting its security requirements. When using TLS, the mechanisms meeting its security requirements. When using TLS, the
Client MUST perform a TLS/SSL server certificate check, per RFC 6125 Client MUST perform a TLS/SSL server certificate check, per RFC 6125
[RFC6125]. [RFC6125].
The Client Registration Endpoint MAY be an OAuth 2.0 Protected The client registration endpoint MAY be an OAuth 2.0 protected
Resource and accept an Initial Access Token in the form of an OAuth resource and accept an initial access token in the form of an OAuth
2.0 [RFC6749] access token to limit registration to only previously 2.0 [RFC6749] access token to limit registration to only previously
authorized parties. The method by which the Initial Access Token is authorized parties. The method by which the initial access token is
obtained by the registrant is generally out-of-band and is out of obtained by the registrant is generally out-of-band and is out of
scope for this specification. The method by which the Initial Access scope for this specification. The method by which the initial access
Token is verified and validated by the Client Registration Endpoint token is verified and validated by the client registration endpoint
is out of scope for this specification. is out of scope for this specification.
To support open registration and facilitate wider interoperability, To support open registration and facilitate wider interoperability,
the Client Registration Endpoint SHOULD allow initial registration the client registration endpoint SHOULD allow initial registration
requests with no authorization (which is to say, with no OAuth 2.0 requests with no authorization (which is to say, with no OAuth 2.0
access token in the request). These requests MAY be rate-limited or access token in the request). These requests MAY be rate-limited or
otherwise limited to prevent a denial-of-service attack on the Client otherwise limited to prevent a denial-of-service attack on the client
Registration Endpoint. registration endpoint.
To allow registered clients to manage their information, the Client To allow the registrant to manage the client's information, the
Registration Endpoint issues a Request Access Token as an OAuth 2.0 client registration endpoint issues a request access token as an
Bearer Token [RFC6750] to securely authorize calls to the Client OAuth 2.0 Bearer Token [RFC6750] to securely authorize calls to the
Configuration Endpoint (Section 4). client configuration endpoint (Section 4).
The Client Registration Endpoint MUST ignore all parameters it does The client registration endpoint MUST ignore all parameters it does
not understand. not understand.
3.1. Client Registration Request 3.1. Client Registration Request
This operation registers a new Client to the Authorization Server. This operation registers a new client to the authorization server.
The Authorization Server assigns this client a unique Client The authorization server assigns this client a unique client
Identifier, optionally assigns a Client Secret, and associates the identifier, optionally assigns a client secret, and associates the
metadata given in the request with the issued Client Identifier. The metadata given in the request with the issued client identifier. The
request includes any parameters described in Client Metadata request includes any parameters described in Client Metadata
(Section 2) that the client wishes to specify for itself during the (Section 2) that the client wishes to specify for itself during the
registration. The Authorization Server MAY provision default values registration. The authorization server MAY provision default values
for any items omitted in the Client Metadata. for any items omitted in the client metadata.
The Client sends an HTTP POST to the Client Registration Endpoint To register, the client or developer sends an HTTP POST to the client
with a content type of "application/json". The HTTP Entity Payload registration endpoint with a content type of "application/json". The
is a JSON [RFC4627] document consisting of a JSON object and all HTTP Entity Payload is a JSON [RFC4627] document consisting of a JSON
parameters as top-level members of that JSON object. object and all parameters as top-level members of that JSON object.
For example, if the server supports open registration (with no For example, if the server supports open registration (with no
Initial Access Token), the Client could send the following initial access token), the client could send the following
registration request to the Client Registration Endpoint: registration request to the client registration endpoint:
Following is a non-normative example request (with line wraps for Following is a non-normative example request (with line wraps for
display purposes only): display purposes only):
POST /register HTTP/1.1 POST /register HTTP/1.1
Content-Type: application/json Content-Type: application/json
Accept: application/json Accept: application/json
Host: server.example.com Host: server.example.com
{ {
"redirect_uris":["https://client.example.org/callback", "redirect_uris":["https://client.example.org/callback",
"https://client.example.org/callback2"] "https://client.example.org/callback2"],
"client_name":"My Example Client", "client_name":"My Example Client",
"client_name#ja-Jpan-JP": "client_name#ja-Jpan-JP":
"\u30AF\u30E9\u30A4\u30A2\u30F3\u30C8\u540D", "\u30AF\u30E9\u30A4\u30A2\u30F3\u30C8\u540D",
"token_endpoint_auth_method":"client_secret_basic", "token_endpoint_auth_method":"client_secret_basic",
"scope":"read write dolphin", "scope":"read write dolphin",
"logo_uri":"https://client.example.org/logo.png", "logo_uri":"https://client.example.org/logo.png",
"jwks_uri":"https://client.example.org/my_public_keys.jwks" "jwks_uri":"https://client.example.org/my_public_keys.jwks"
} }
Alternatively, if the server supports authorized registration, the Alternatively, if the server supports authorized registration, the
developer or the client will be provisioned with an Initial Access developer or the client will be provisioned with an initial access
Token (the method by which the Initial Access Token is obtained is token (the method by which the initial access token is obtained is
out of scope for this specification). The developer or client sends out of scope for this specification). The developer or client sends
the following authorized registration request to the Client the following authorized registration request to the client
Registration Endpoint, with the Initial Access Token sent in this registration endpoint. Note that the initial access token sent in
example as an OAuth 2.0 Bearer Token [RFC6750]: this example as an OAuth 2.0 Bearer Token [RFC6750], but any OAuth
2.0 token type could be used by an authorization server:
Following is a non-normative example request (with line wraps for Following is a non-normative example request (with line wraps for
display purposes only): display purposes only):
POST /register HTTP/1.1 POST /register HTTP/1.1
Content-Type: application/json Content-Type: application/json
Accept: application/json Accept: application/json
Authorization: Bearer ey23f2.adfj230.af32-developer321 Authorization: Bearer ey23f2.adfj230.af32-developer321
Host: server.example.com Host: server.example.com
{ {
"redirect_uris":["https://client.example.org/callback", "redirect_uris":["https://client.example.org/callback",
"https://client.example.org/callback2"] "https://client.example.org/callback2"],
"client_name":"My Example Client", "client_name":"My Example Client",
"client_name#ja-Jpan-JP": "client_name#ja-Jpan-JP":
"\u30AF\u30E9\u30A4\u30A2\u30F3\u30C8\u540D", "\u30AF\u30E9\u30A4\u30A2\u30F3\u30C8\u540D",
"token_endpoint_auth_method":"client_secret_basic", "token_endpoint_auth_method":"client_secret_basic",
"scope":"read write dolphin", "scope":"read write dolphin",
"logo_uri":"https://client.example.org/logo.png", "logo_uri":"https://client.example.org/logo.png",
"jwks_uri":"https://client.example.org/my_public_keys.jwks" "jwks_uri":"https://client.example.org/my_public_keys.jwks"
} }
3.2. Client Registration Response 3.2. Client Registration Response
Upon successful registration, the Authorization Server generates a Upon successful registration, the authorization server generates a
new Client Identifier for the client. This Client Identifier MUST be new client identifier for the client. This client identifier MUST be
unique at the server and MUST NOT be in use by any other client. The unique at the server and MUST NOT be in use by any other client. The
server responds with an HTTP 201 Created code and a body of type server responds with an HTTP 201 Created code and a body of type
"application/json" with content described in Client Information "application/json" with content described in Client Information
Response (Section 5.1). Response (Section 5.1).
Upon an unsuccessful registration, the Authorization Server responds Upon an unsuccessful registration, the authorization server responds
with an error as described in Client Registration Error with an error as described in Client Registration Error
(Section 5.2). (Section 5.2).
4. Client Configuration Endpoint 4. Client Configuration Endpoint
The Client Configuration Endpoint is an OAuth 2.0 protected resource The client configuration endpoint is an OAuth 2.0 protected resource
that is provisioned by the server for a specific client to be able to that is provisioned by the server to facilitate viewing, updating,
view and update its registered information. The location of this and deleting a client's registered information. The location of this
endpoint is communicated to the Client through the endpoint is communicated to the client through the
"registration_client_uri" member of the Client Information Response "registration_client_uri" member of the Client Information Response
(Section 5.1). The Client MUST use its Registration Access Token in (Section 5.1). The client MUST use its registration access token in
all calls to this endpoint as an OAuth 2.0 Bearer Token [RFC6750]. all calls to this endpoint as an OAuth 2.0 Bearer Token [RFC6750].
Operations on this endpoint are switched through the use of different Operations on this endpoint are switched through the use of different
HTTP methods [RFC2616]. HTTP methods [RFC2616]. If an authorization server does not support
a particular method on the client configuration endpoint, it MUST
respond with the appropriate error code.
4.1. Forming the Client Configuration Endpoint URL 4.1. Forming the Client Configuration Endpoint URL
The Authorization Server MUST provide the client with the fully The authorization server MUST provide the client with the fully
qualified URL in the "registration_client_uri" element of the Client qualified URL in the "registration_client_uri" element of the Client
Information Response (Section 5.1). The Authorization Server MUST Information Response (Section 5.1). The authorization server MUST
NOT expect the client to construct or discover this URL on its own. NOT expect the client to construct or discover this URL on its own.
The Client MUST use the URL as given by the server and MUST NOT The client MUST use the URL as given by the server and MUST NOT
construct this URL from component pieces. construct this URL from component pieces.
Depending on deployment characteristics, the Client Configuration Depending on deployment characteristics, the client configuration
Endpoint URL may take any number of forms. It is RECOMMENDED that endpoint URL may take any number of forms. It is RECOMMENDED that
this endpoint URL be formed through the use of a server-constructed this endpoint URL be formed through the use of a server-constructed
URL string which combines the Client Registration Endpoint's URL and URL string which combines the client registration endpoint's URL and
the issued "client_id" for this Client, with the latter as either a the issued "client_id" for this client, with the latter as either a
path parameter or a query parameter. For example, a Client with the path parameter or a query parameter. For example, a client with the
Client ID "s6BhdRkqt3" could be given a Client Configuration Endpoint client identifier "s6BhdRkqt3" could be given a client configuration
URL of "https://server.example.com/register/s6BhdRkqt3" (path endpoint URL of "https://server.example.com/register/s6BhdRkqt3"
parameter) or of "https://server.example.com/ (path parameter) or of "https://server.example.com/
register?client_id=s6BhdRkqt3" (query parameter). In both of these register?client_id=s6BhdRkqt3" (query parameter). In both of these
cases, the client simply uses the URL as given. cases, the client simply uses the URL as given by the authorization
server.
These common patterns can help the Server to more easily determine These common patterns can help the server to more easily determine
the client to which the request pertains, which MUST be matched the client to which the request pertains, which MUST be matched
against the client to which the Registration Access Token was issued. against the client to which the registration access token was issued.
If desired, the server MAY simply return the Client Registration If desired, the server MAY simply return the client registration
Endpoint URL as the Client Configuration Endpoint URL and change endpoint URL as the client configuration endpoint URL and change
behavior based on the authentication context provided by the behavior based on the authentication context provided by the
Registration Access Token. registration access token.
4.2. Client Read Request 4.2. Client Read Request
To read the current configuration of the Client on the Authorization To read the current configuration of the client on the authorization
Server, the Client makes an HTTP GET request to the Client server, the client makes an HTTP GET request to the client
Configuration Endpoint, authenticating with its Registration Access configuration endpoint, authenticating with its registration access
Token. token.
Following is a non-normative example request (with line wraps for Following is a non-normative example request (with line wraps for
display purposes only): display purposes only):
GET /register/s6BhdRkqt3 HTTP/1.1 GET /register/s6BhdRkqt3 HTTP/1.1
Accept: application/json Accept: application/json
Host: server.example.com Host: server.example.com
Authorization: Bearer reg-23410913-abewfq.123483 Authorization: Bearer reg-23410913-abewfq.123483
Upon successful read of the information for a currently active Upon successful read of the information for a currently active
Client, the Authorization Server responds with an HTTP 200 OK with client, the authorization server responds with an HTTP 200 OK with
content type of "application/json" and a payload as described in content type of "application/json" and a payload as described in
Client Information Response (Section 5.1). Some values in the Client Information Response (Section 5.1). Some values in the
response, including the "client_secret" and response, including the "client_secret" and
"registration_access_token", MAY be different from those in the "registration_access_token", MAY be different from those in the
initial registration response. If the Authorization Server includes initial registration response. If the authorization server includes
a new Client Secret and/or Registration Access Token in its response, a new client secret and/or registration access token in its response,
the Client MUST immediately discard its previous Client Secret and/or the client MUST immediately discard its previous client secret and/or
Registration Access Token. The value of the "client_id" MUST NOT registration access token. The value of the "client_id" MUST NOT
change from the initial registration response. change from the initial registration response.
If the client does not exist on this server, the server MUST respond If the client does not exist on this server, the server MUST respond
with HTTP 401 Unauthorized and the Registration Access Token used to with HTTP 401 Unauthorized and the registration access token used to
make this request SHOULD be immediately revoked. make this request SHOULD be immediately revoked.
If the Client does not have permission to read its record, the server If the client does not have permission to read its record, the server
MUST return an HTTP 403 Forbidden. MUST return an HTTP 403 Forbidden.
4.3. Client Update Request 4.3. Client Update Request
This operation updates a previously-registered client with new This operation updates a previously-registered client with new
metadata at the Authorization Server. This request is authenticated metadata at the authorization server. This request is authenticated
by the Registration Access Token issued to the client. by the registration access token issued to the client.
The Client sends an HTTP PUT to the Client Configuration Endpoint The client sends an HTTP PUT to the client configuration endpoint
with a content type of "application/json". The HTTP Entity Payload with a content type of "application/json". The HTTP entity payload
is a JSON [RFC4627] document consisting of a JSON object and all is a JSON [RFC4627] document consisting of a JSON object and all
parameters as top- level members of that JSON object. parameters as top- level members of that JSON object.
This request MUST include all fields described in Client Metadata This request MUST include all fields described in Client Metadata
(Section 2) as returned to the Client from a previous register, read, (Section 2) as returned to the client from a previous register, read,
or update operation. The Client MUST NOT include the or update operation. The client MUST NOT include the
"registration_access_token", "registration_client_uri", "registration_access_token", "registration_client_uri",
"client_secret_expires_at", or "client_id_issued_at" fields described "client_secret_expires_at", or "client_id_issued_at" fields described
in Client Information Response (Section 5.1). in Client Information Response (Section 5.1).
Valid values of Client Metadata fields in this request MUST replace, Valid values of client metadata fields in this request MUST replace,
not augment, the values previously associated with this Client. not augment, the values previously associated with this client.
Omitted fields MUST be treated as null or empty values by the server. Omitted fields MUST be treated as null or empty values by the server.
The Client MUST include its "client_id" field in the request, and it The client MUST include its "client_id" field in the request, and it
MUST be the same as its currently-issued Client Identifier. If the MUST be the same as its currently-issued client identifier. If the
client includes the "client_secret" field in the request, the value client includes the "client_secret" field in the request, the value
of this field MUST match the currently-issued Client Secret for that of this field MUST match the currently-issued client secret for that
Client. The Client MUST NOT be allowed to overwrite its existing client. The client MUST NOT be allowed to overwrite its existing
Client Secret with its own chosen value. client secret with its own chosen value.
For all metadata fields, the Authorization Server MAY replace any For all metadata fields, the authorization server MAY replace any
invalid values with suitable default values, and it MUST return any invalid values with suitable default values, and it MUST return any
such fields to the Client in the response. such fields to the client in the response.
For example, a client could send the following request to the Client For example, a client could send the following request to the client
Registration Endpoint to update the client registration in the above registration endpoint to update the client registration in the above
example with new information: example with new information:
Following is a non-normative example request (with line wraps for Following is a non-normative example request (with line wraps for
display purposes only): display purposes only):
PUT /register/s6BhdRkqt3 HTTP/1.1 PUT /register/s6BhdRkqt3 HTTP/1.1
Accept: application/json Accept: application/json
Host: server.example.com Host: server.example.com
Authorization: Bearer reg-23410913-abewfq.123483 Authorization: Bearer reg-23410913-abewfq.123483
skipping to change at page 18, line 25 skipping to change at page 18, line 36
"scope": "read write dolphin", "scope": "read write dolphin",
"grant_types": ["authorization_code", "refresh_token"] "grant_types": ["authorization_code", "refresh_token"]
"token_endpoint_auth_method": "client_secret_basic", "token_endpoint_auth_method": "client_secret_basic",
"jwks_uri": "https://client.example.org/my_public_keys.jwks" "jwks_uri": "https://client.example.org/my_public_keys.jwks"
"client_name":"My New Example", "client_name":"My New Example",
"client_name#fr":"Mon Nouvel Exemple", "client_name#fr":"Mon Nouvel Exemple",
"logo_uri":"https://client.example.org/newlogo.png" "logo_uri":"https://client.example.org/newlogo.png"
"logo_uri#fr":"https://client.example.org/fr/newlogo.png" "logo_uri#fr":"https://client.example.org/fr/newlogo.png"
} }
Upon successful update, the Authorization Server responds with an Upon successful update, the authorization server responds with an
HTTP 200 OK Message with content type "application/json" and a HTTP 200 OK Message with content type "application/json" and a
payload as described in Client Information Response (Section 5.1). payload as described in Client Information Response (Section 5.1).
Some values in the response, including the "client_secret" and Some values in the response, including the "client_secret" and
r"egistration_access_token", MAY be different from those in the r"egistration_access_token", MAY be different from those in the
initial registration response. If the Authorization Server includes initial registration response. If the authorization server includes
a new Client Secret and/or Registration Access Token in its response, a new client secret and/or registration access token in its response,
the Client MUST immediately discard its previous Client Secret and/or the client MUST immediately discard its previous client secret and/or
Registration Access Token. The value of the "client_id" MUST NOT registration access token. The value of the "client_id" MUST NOT
change from the initial registration response. change from the initial registration response.
If the client does not exist on this server, the server MUST respond If the client does not exist on this server, the server MUST respond
with HTTP 401 Unauthorized, and the Registration Access Token used to with HTTP 401 Unauthorized, and the registration access token used to
make this request SHOULD be immediately revoked. make this request SHOULD be immediately revoked.
If the Client is not allowed to update its records, the server MUST If the client is not allowed to update its records, the server MUST
respond with HTTP 403 Forbidden. respond with HTTP 403 Forbidden.
If the Client attempts to set an invalid metadata field and the If the client attempts to set an invalid metadata field and the
Authorization Server does not set a default value, the Authorization authorization server does not set a default value, the authorization
Server responds with an error as described in Client Registration server responds with an error as described in Client Registration
Error Response (Section 5.2). Error Response (Section 5.2).
4.4. Client Delete Request 4.4. Client Delete Request
To deprovision itself on the Authorization Server, the Client makes To deprovision itself on the authorization server, the client makes
an HTTP DELETE request to the Client Configuration Endpoint. This an HTTP DELETE request to the client configuration endpoint. This
request is authenticated by the Registration Access Token issued to request is authenticated by the registration access token issued to
the client. the client.
Following is a non-normative example request (with line wraps for Following is a non-normative example request (with line wraps for
display purposes only): display purposes only):
DELETE /register/s6BhdRkqt3 HTTP/1.1 DELETE /register/s6BhdRkqt3 HTTP/1.1
Accept: application/json
Host: server.example.com Host: server.example.com
Authorization: Bearer reg-23410913-abewfq.123483 Authorization: Bearer reg-23410913-abewfq.123483
A successful delete action will invalidate the "client_id", A successful delete action will invalidate the "client_id",
"client_secret", and "registration_access_token" for this client, "client_secret", and "registration_access_token" for this client,
thereby preventing the "client_id" from being used at either the thereby preventing the "client_id" from being used at either the
Authorization Endpoint or Token Endpoint of the Authorization Server. authorization endpoint or token endpoint of the authorization server.
The Authorization Server SHOULD immediately invalidate all existing The authorization server SHOULD immediately invalidate all existing
authorization grants and currently-active tokens associated with this authorization grants and currently-active tokens associated with this
Client. client.
If a Client has been successfully deprovisioned, the Authorization If a client has been successfully deprovisioned, the authorization
Server responds with an HTTP 204 No Content message. server responds with an HTTP 204 No Content message.
If the server does not support the delete method, the server MUST If the server does not support the delete method, the server MUST
respond with an HTTP 405 Not Supported. respond with an HTTP 405 Not Supported.
If the client does not exist on this server, the server MUST respond If the client does not exist on this server, the server MUST respond
with HTTP 401 Unauthorized and the Registration Access Token used to with HTTP 401 Unauthorized and the registration access token used to
make this request SHOULD be immediately revoked. make this request SHOULD be immediately revoked.
If the client is not allowed to delete itself, the server MUST If the client is not allowed to delete itself, the server MUST
respond with HTTP 403 Forbidden. respond with HTTP 403 Forbidden.
Following is a non-normative example response: Following is a non-normative example response:
HTTP/1.1 204 No Content HTTP/1.1 204 No Content
Cache-Control: no-store Cache-Control: no-store
Pragma: no-cache Pragma: no-cache
5. Responses 5. Responses
In response to certain requests from the Client to either the Client In response to certain requests from the client to either the client
Registration Endpoint or the Client Configuration Endpoint as registration endpoint or the client configuration endpoint as
described in this specification, the Authorization Server sends the described in this specification, the authorization server sends the
following response bodies. following response bodies.
5.1. Client Information Response 5.1. Client Information Response
The response contains the Client Identifier as well as the Client The response contains the client identifier as well as the client
Secret, if the Client is a confidential Client. The response also secret, if the client is a confidential client. The response also
contains the fully qualified URL to the Client Configuration Endpoint contains the fully qualified URL to the client configuration endpoint
for this specific client that the client may use to obtain and update for this specific client that the client may use to obtain and update
information about itself. The response also contains a Registration information about itself. The response also contains a registration
Access Token that is to be used by the client to perform subsequent access token that is to be used by the client to perform subsequent
operations at the Client Configuration Endpoint. operations at the client configuration endpoint.
client_id client_id
REQUIRED. The unique Client identifier, MUST NOT be currently REQUIRED. The unique client identifier, MUST NOT be currently
valid for any other registered Client. valid for any other registered client.
client_secret client_secret
OPTIONAL. The Client secret. If issued, this MUST be unique for OPTIONAL. The client secret. If issued, this MUST be unique for
each "client_id". This value is used by confidential clients to each "client_id". This value is used by confidential clients to
authenticate to the Token Endpoint as described in OAuth 2.0 authenticate to the token endpoint as described in OAuth 2.0
Section 2.3.1. Section 2.3.1.
client_id_issued_at client_id_issued_at
OPTIONAL. Time at which the Client Identifier was issued. The OPTIONAL. Time at which the Client Identifier was issued. The
time is represented as the number of seconds from time is represented as the number of seconds from
1970-01-01T0:0:0Z as measured in UTC until the date/time. 1970-01-01T0:0:0Z as measured in UTC until the date/time.
client_secret_expires_at client_secret_expires_at
REQUIRED if "client_secret" is issued. Time at which the REQUIRED if "client_secret" is issued. Time at which the
"client_secret" will expire or 0 if it will not expire. The time "client_secret" will expire or 0 if it will not expire. The time
is represented as the number of seconds from 1970-01-01T0:0:0Z as is represented as the number of seconds from 1970-01-01T0:0:0Z as
measured in UTC until the date/time. measured in UTC until the date/time.
registration_access_token registration_access_token
REQUIRED. Access Token that is used at the Client Configuration REQUIRED. Access token that is used at the client configuration
Endpoint to perform subsequent operations upon the Client endpoint to perform subsequent operations upon the client
registration. registration.
registration_client_uri registration_client_uri
REQUIRED. The fully qualified URL of the Client Configuration REQUIRED. The fully qualified URL of the client configuration
Endpoint for this client. The Client MUST use this URL as given endpoint for this client. The client MUST use this URL as given
when communicating with the Client Configuration Endpoint. when communicating with the client configuration endpoint.
Additionally, the Authorization Server MUST return all registered Additionally, the Authorization Server MUST return all registered
metadata (Section 2) about this client, including any fields metadata (Section 2) about this client, including any fields
provisioned by the Authorization Server itself. The Authorization provisioned by the authorization server itself. The authorization
Server MAY reject or replace any of the client's requested metadata server MAY reject or replace any of the client's requested metadata
values submitted during the registration or update requests and values submitted during the registration or update requests and
substitute them with suitable values. substitute them with suitable values.
The response is an "application/json" document with all parameters as The response is an "application/json" document with all parameters as
top-level members of a JSON object [RFC4627]. top-level members of a JSON object [RFC4627].
Following is a non-normative example response: Following is a non-normative example response:
HTTP/1.1 200 OK HTTP/1.1 200 OK
Content-Type: application/json Content-Type: application/json
skipping to change at page 21, line 33 skipping to change at page 21, line 45
"scope": "read write dolphin", "scope": "read write dolphin",
"grant_types": ["authorization_code", "refresh_token"] "grant_types": ["authorization_code", "refresh_token"]
"token_endpoint_auth_method": "client_secret_basic", "token_endpoint_auth_method": "client_secret_basic",
"logo_uri": "https://client.example.org/logo.png", "logo_uri": "https://client.example.org/logo.png",
"jwks_uri": "https://client.example.org/my_public_keys.jwks" "jwks_uri": "https://client.example.org/my_public_keys.jwks"
} }
5.2. Client Registration Error Response 5.2. Client Registration Error Response
When an OAuth 2.0 error condition occurs, such as the client When an OAuth 2.0 error condition occurs, such as the client
presenting an invalid Registration Access Token, the Authorization presenting an invalid registration access token, the authorization
Server returns an Error Response as defined in Section 5.2 of the server returns an error response appropriate to the OAuth 2.0 token
OAuth 2.0 specification. type. For the registration access token, which is an OAuth 2.0
bearer token, this error response is defined in Section 3 of OAuth
2.0 Bearer Token Usage [RFC6750].
When a registration error condition occurs, the Authorization Server When a registration error condition occurs, the authorization server
returns an HTTP 400 status code with content type "application/json" returns an HTTP 400 status code (unless otherwise specified) with
consisting of a JSON object [RFC4627] describing the error in the content type "application/json" consisting of a JSON object [RFC4627]
response body. describing the error in the response body.
The JSON object contains two members: The JSON object contains two members:
error error
The error code, a single ASCII string. The error code, a single ASCII string.
error_description error_description
A human-readable text description of the error for debugging. A human-readable text description of the error for debugging.
This specification defines the following error codes: This specification defines the following error codes:
invalid_redirect_uri invalid_redirect_uri
The value of one or more "redirect_uris" is invalid. The value of one or more "redirect_uris" is invalid.
invalid_client_metadata invalid_client_metadata
The value of one of the client metadata (Section 2) fields is The value of one of the client metadata (Section 2) fields is
invalid and the server has rejected this request. Note that an invalid and the server has rejected this request. Note that an
Authorization server MAY choose to substitute a valid value for Authorization server MAY choose to substitute a valid value for
any requested parameter of a client's metadata. any requested parameter of a client's metadata.
invalid_client_id invalid_client_id
Value of "client_id" is invalid. The value of "client_id" does not match the one assigned to this
client.
Following is a non-normative example of an error response (with line Following is a non-normative example of an error response (with line
wraps for display purposes only): wraps for display purposes only):
HTTP/1.1 400 Bad Request HTTP/1.1 400 Bad Request
Content-Type: application/json Content-Type: application/json
Cache-Control: no-store Cache-Control: no-store
Pragma: no-cache Pragma: no-cache
{ {
skipping to change at page 24, line 4 skipping to change at page 24, line 15
o Token Endpoint Authorization Method name: "client_secret_post" o Token Endpoint Authorization Method name: "client_secret_post"
o Change controller: IETF o Change controller: IETF
o Specification document(s): [[ this document ]] o Specification document(s): [[ this document ]]
o Token Endpoint Authorization Method name: "client_secret_basic" o Token Endpoint Authorization Method name: "client_secret_basic"
o Change controller: IETF o Change controller: IETF
o Specification document(s): [[ this document ]] o Specification document(s): [[ this document ]]
7. Security Considerations 7. Security Considerations
Since requests to the Client Registration Endpoint result in the
Since requests to the client registration endpoint result in the
transmission of clear-text credentials (in the HTTP request and transmission of clear-text credentials (in the HTTP request and
response), the server MUST require the use of a transport-layer response), the Authorization Server MUST require the use of a
security mechanism when sending requests to the Registration transport-layer security mechanism when sending requests to the
Endpoint. The server MUST support TLS 1.2 RFC 5246 [RFC5246] and/or registration endpoint. The server MUST support TLS 1.2 RFC 5246
TLS 1.0 [RFC2246] and MAY support additional transport-layer [RFC5246] and/or TLS 1.0 [RFC2246] and MAY support additional
mechanisms meeting its security requirements. When using TLS, the transport-layer mechanisms meeting its security requirements. When
Client MUST perform a TLS/SSL server certificate check, per RFC 6125 using TLS, the Client MUST perform a TLS/SSL server certificate
[RFC6125]. check, per RFC 6125 [RFC6125].
Since the Client Configuration Endpoint is an OAuth 2.0 Protected Since the client configuration endpoint is an OAuth 2.0 protected
Resource, it SHOULD have some rate limiting on failures to prevent resource, it SHOULD have some rate limiting on failures to prevent
the Registration Access Token from being disclosed though repeated the registration access token from being disclosed though repeated
access attempts. access attempts.
For clients that use redirect-based grant types such as Authorization For clients that use redirect-based grant types such as
Code and Implicit, Authorization Servers SHOULD require clients to "authorization_code" and "implicit", authorization servers SHOULD
register their "redirect_uris". Requiring Clients to do so can help require clients to register their "redirect_uris". Requiring clients
mitigate attacks where rogue actors inject and impersonate a validly to do so can help mitigate attacks where rogue actors inject and
registered client and intercept its authorization code or tokens impersonate a validly registered client and intercept its
through an invalid redirect URI. authorization code or tokens through an invalid redirect URI.
The authorization server MUST treat all client metadata as self- The authorization server MUST treat all client metadata as self-
asserted. A rogue Client might use the name and logo for the asserted. A rogue client might use the name and logo for the
legitimate Client, which it is trying to impersonate. An legitimate client, which it is trying to impersonate. An
Authorization Server needs to take steps to mitigate this phishing authorization server needs to take steps to mitigate this phishing
risk, since the logo could confuse users into thinking they're risk, since the logo could confuse users into thinking they're
logging in to the legitimate Client. For instance, an Authorization logging in to the legitimate client. For instance, an authorization
Server could warn if the domain/site of the logo doesn't match the server could warn if the domain/site of the logo doesn't match the
domain/site of redirect URIs. An Authorization Server can also domain/site of redirect URIs. An authorization server can also
present warning messages to end users about untrusted Clients in all present warning messages to end users about untrusted clients in all
cases, especially if such clients have been dynamically registered cases, especially if such clients have been recently registered and
and have not been trusted by any users at the Authorization Server have not been trusted by any users at the authorization server
before. before.
In a situation where the Authorization Server is supporting open In a situation where the authorization server is supporting open
Client registration, it must be extremely careful with any URL client registration, it must be extremely careful with any URL
provided by the Client that will be displayed to the user (e.g. provided by the client that will be displayed to the user (e.g.
"logo_uri", "tos_uri", "client_uri", and "policy_uri"). For "logo_uri", "tos_uri", "client_uri", and "policy_uri"). For
instance, a rogue Client could specify a registration request with a instance, a rogue client could specify a registration request with a
reference to a drive-by download in the "policy_uri". The reference to a drive-by download in the "policy_uri". The
Authorization Server SHOULD check to see if the "logo_uri", authorization server SHOULD check to see if the "logo_uri",
"tos_uri", "client_uri", and "policy_uri" have the same host and "tos_uri", "client_uri", and "policy_uri" have the same host and
scheme as the those defined in the array of "redirect_uris" and that scheme as the those defined in the array of "redirect_uris" and that
all of these resolve to valid Web pages. all of these resolve to valid web pages.
While the Client Secret can expire, the Registration Access Token While the client secret can expire, the registration access token
should not expire while a client is still actively registered. If should not expire while a client is still actively registered. If
this token were to expire, a developer or Client could be left in a this token were to expire, a developer or client could be left in a
situation where they have no means of retrieving the Client's situation where they have no means of retrieving or updating the
registration information or updating it. Were that the case, a new client's registration information. Were that the case, a new
registration would be required, thereby getting a new Client registration would be required, thereby generating a new client
Identifier. However, Registration Access Tokens MAY be rotated when identifier. However, to limit the exposure surface of the
the developer or client does a read or update operation on its Client registration access token, the registration access token MAY be
Configuration Endpoint, and the developer or Client MUST use this new rotated when the developer or client does a read or update operation
Registration Access Token. As the Registration Access Tokens are on the client's client configuration endpoint. As the registration
long-term credentials, and since the Registration Access Token is a access tokens are relatively long-term credentials, and since the
Bearer token and acts as the sole authentication for use at the registration access token is a Bearer token and acts as the sole
Client Configuration Endpoint, it MUST be protected by the developer authentication for use at the client configuration endpoint, it MUST
or Client as described in OAuth 2.0 Bearer [RFC6750]. be protected by the developer or client as described in OAuth 2.0
Bearer Token Usage [RFC6750].
If a Client is deprovisioned from a server, any outstanding If a client is deprovisioned from a server, any outstanding
Registration Access Token for that client MUST be invalidated at the registration access token for that client MUST be invalidated at the
same time. Otherwise, this can lead to an inconsistent state wherein same time. Otherwise, this can lead to an inconsistent state wherein
a Client could make requests to the Client Configuration Endpoint a client could make requests to the client configuration endpoint
where the authentication would succeed but the action would fail where the authentication would succeed but the action would fail
because the Client is no longer valid. because the client is no longer valid. To prevent accidental
disclosure from such an erroneous situation, the authorization server
MUST treat all such requests as if the registration access token was
invalid (by returning an HTTP 401 Unauthorized error, as described).
Public clients MAY register with an Authorization Server using this Public clients MAY register with an authorization server using this
protocol, if the Authorization Server's policy allows them, by using protocol, if the authorization server's policy allows them. Public
a "none" value for the "token_endpoint_auth_method" metadata field clients use a "none" value for the "token_endpoint_auth_method"
and generally used with the "implicit" grant type. Often these metadata field and are generally used with the "implicit" grant type.
clients will be short-lived in-browser applications requesting access Often these clients will be short-lived in-browser applications
to a user's resources and access is tied to a user's active session requesting access to a user's resources and access is tied to a
at the Authorization Server. Since such clients often do not have user's active session at the authorization server. Since such
long-term storage, it's possible that such clients would need to re- clients often do not have long-term storage, it's possible that such
register every time the browser application is loaded. To avoid the clients would need to re-register every time the browser application
resulting proliferation of dead Client Identifiers, an Authorization is loaded. Additionally, such clients may not have ample opportunity
Server MAY decide to expire registrations for existing clients to unregister themselves using the delete action before the browser
meeting certain criteria after a period of time has elapsed. closes. To avoid the resulting proliferation of dead client
identifiers, an authorization server MAY decide to expire
registrations for existing clients meeting certain criteria after a
period of time has elapsed.
Since different OAuth 2.0 grant types have different security and
usage parameters, an authorization server MAY require separate
registrations for a piece of software to support multiple grant
types. For instance, an authorization server might require that all
clients using the "authorization_code" grant type make use of a
client secret for the "token_endpoint_auth_method", but any clients
using the "implicit" grant type do not use any authentication at the
token endpoint. In such a situation, a server MAY disallow clients
from registering for both the "authorization_code" and "implicit"
grant types simultaneously. Similarly, the "authorization_code"
grant type is used to represent access on behalf of an end user, but
the "client_credentials" grant type represents access on behalf of
the client itself. For security reasons, an authorization server
could require that different scopes be used for these different use
cases, and as a consequence it MAY disallow these two grant types
from being registered together by the same client. In all of these
cases, the authorization server would respond with an
"invalid_client_metadata" error response (Section 5.2).
8. Normative References 8. Normative References
[IANA.Language] [IANA.Language]
Internet Assigned Numbers Authority (IANA), "Language Internet Assigned Numbers Authority (IANA), "Language
Subtag Registry", 2005. Subtag Registry", 2005.
[JWK] Jones, M., "JSON Web Key (JWK)", draft-ietf-jose-json-web- [JWK] Jones, M., "JSON Web Key (JWK)", draft-ietf-jose-json-web-
key (work in progress), May 2013. key (work in progress), May 2013.
skipping to change at page 27, line 4 skipping to change at page 27, line 35
(PKIX) Certificates in the Context of Transport Layer (PKIX) Certificates in the Context of Transport Layer
Security (TLS)", RFC 6125, March 2011. Security (TLS)", RFC 6125, March 2011.
[RFC6749] Hardt, D., "The OAuth 2.0 Authorization Framework", RFC [RFC6749] Hardt, D., "The OAuth 2.0 Authorization Framework", RFC
6749, October 2012. 6749, October 2012.
[RFC6750] Jones, M. and D. Hardt, "The OAuth 2.0 Authorization [RFC6750] Jones, M. and D. Hardt, "The OAuth 2.0 Authorization
Framework: Bearer Token Usage", RFC 6750, October 2012. Framework: Bearer Token Usage", RFC 6750, October 2012.
Appendix A. Acknowledgments Appendix A. Acknowledgments
The authors thank the OAuth Working Group, the User-Managed Access The authors thank the OAuth Working Group, the User-Managed Access
Working Group, and the OpenID Connect Working Group participants for Working Group, and the OpenID Connect Working Group participants for
their input to this document. In particular, the following their input to this document. In particular, the following
individuals have been instrumental in their review and contribution individuals have been instrumental in their review and contribution
to various versions of this document: Amanda Anganes, Tim Bray, to various versions of this document: Amanda Anganes, Derek Atkins,
Domenico Catalano, Donald Coffin, George Fletcher, Thomas Hardjono, Tim Bray, Domenico Catalano, Donald Coffin, Vladimir Dzhuvinov,
Phil Hunt, Torsten Lodderstedt, Eve Maler, Josh Mandel, Nov Matake, George Fletcher, Thomas Hardjono, Phil Hunt, William Kim, Torsten
Nat Sakimura, Christian Scholz, and Hannes Tschofenig. Lodderstedt, Eve Maler, Josh Mandel, Nov Matake, Nat Sakimura,
Christian Scholz, and Hannes Tschofenig.
Appendix B. Client Lifecycle Examples Appendix B. Client Lifecycle Examples
In the OAuth 2.0 specification [RFC6749], a Client is identified by In the OAuth 2.0 specification [RFC6749], a client is identified by
its own unique Client Identifier ("client_id") at each Authorization its own unique Client identifier ("client_id") at each authorization
Server that it associates with. Dynamic Registration as defined in server that it associates with. Dynamic registration as defined in
this document is one way for a Client to get a Client Identifier and this document is one way for a client to get a client identifier and
associate a set of metadata with that identifier. Lack of such a associate a set of metadata with that identifier. Lack of such a
Client Identifier is the expected trigger for a client registration client identifier is the expected trigger for a client registration
operation. operation.
In many cases, this Client Identifier is a unique, pairwise In many cases, this client identifier is a unique, pairwise
association between a particular running instance of a piece of association between a particular running instance of a piece of
Client software and a particular running instance of an Authorization client software and a particular running instance of an authorization
Server software. In particular: server software. In particular:
o A single instance of Client software (such as a Web server) o A single instance of client software (such as a Web server)
talking to multiple Authorization Servers will need to register talking to multiple authorization servers will need to register
with each Authorization Server separately, creating a distinct with each authorization server separately, creating a distinct
Client Identifier with each Authorization Server. The Client can client identifier with each authorization server. The client can
not make any assumption that the Authorization Server is not make any assumption that the authorization servers are
correlating separate instances of the client together without correlating separate registrations of the client software together
further profiles and extensions to this specification document. without further profiles and extensions to this specification
The means by which a Client discovers and differentiates between document. The means by which a client discovers and
multiple Authorization Servers is out of scope for this differentiates between multiple authorization servers is out of
specification. scope for this specification.
o Multiple instances of Client software (such as a native o Multiple instances of client software (such as a native
application installed on multiple devices simultaneously) talking application installed on multiple devices simultaneously) talking
to the same Authorization Server will need to each register with to the same authorization server will need to each register with
that Authorization Server separately, creating a distinct Client that authorization server separately, creating a distinct client
Identifier for each copy of the application. The Authorization identifier for each copy of the application. The authorization
Server cannot make any assumption of correlation between these server cannot make any assumption of correlation between these
clients without further specifications, profiles, and extensions clients without further specifications, profiles, and extensions
to this specification. to this specification. The client can not make any assumption
that the authorization server will correlate separate
registrations of the client software together without further
profiles and extensions to this specification document.
A Client Identifier (and its associated credentials) could also be A client identifier (and its associated credentials) could also be
shared between multiple instances of a Client. Mechanisms for shared between multiple instances of a client. Mechanisms for
sharing Client Identifiers between multiple instances of a piece of sharing client identifiers between multiple instances of a piece of
software (either Client or Authorization Server) are outside the software (either client or authorization server) are outside the
scope of this specification, as it is expected that every successful scope of this specification, as it is expected that every successful
registration request (Section 3.1) results in the issuance of a new registration request (Section 3.1) results in the issuance of a new
Client Identifier. client identifier.
There are several patterns of OAuth Client registration that this There are several patterns of OAuth client registration that dynamic
protocol can enable. The following non-normative example lifecycle registration protocol can enable. The following non-normative
descriptions are not intended to be an exhaustive list. It is example lifecycle descriptions are not intended to be an exhaustive
assumed that the Authorization Server supports the Dynamic list. It is assumed that the authorization server supports the
Registration protocol and that all necessary discovery steps (which dynamic registration protocol and that all necessary discovery steps
are out of scope for this specification) have already been performed. (which are out of scope for this specification) have already been
performed.
B.1. Open Registration B.1. Open Registration
Open registration, with no authorization required on the client
registration endpoint, works as follows:
Open Registration, with no authentication on the Registration a. A client needs to get OAuth 2.0 tokens from an authorization
Endpoint, works as follows: server, but the client does not have a client identifier for that
authorization server.
a. A Client needs to get OAuth 2.0 tokens from an Authorization b. The client sends an HTTP POST request to the client registration
Server, but the Client does not have a Client Identifier for that endpoint at the authorization server and includes its metadata.
Authorization Server. c. The authorization server issues a client identifier and returns
b. The Client sends an HTTP POST request to the Client Registration it to the client along with a registration access token and a
Endpoint at the Authorization Server and includes its metadata. reference to the client's client configuration endpoint.
c. The Authorization Server issues a Client Identifier and returns d. The client stores the returned response from the authorization
it to the Client along with a Registration Access Token and a server. At a minimum, it should remember the values of
reference to the Client's Client Configuration Endpoint. "client_id", "client_secret" (if present),
d. The Client stores the returned response from the Authorization "registration_access_token", and "registration_client_uri".
Server. At a minimum, it should know the values of "client_id", e. The client uses the its "client_id" and "client_secret" (if
"client_secret" (if present), "registration_access_token", and
"registration_client_uri".
e. The Client uses the its "client_id" and "client_secret" (if
provided) to request OAuth 2.0 tokens using any valid OAuth 2.0 provided) to request OAuth 2.0 tokens using any valid OAuth 2.0
flow. flow for which it is authorized.
f. If the Client's "client_secret" expires or otherwise stops f. If the client's "client_secret" expires or otherwise stops
working, the Client sends an HTTP GET request to the working, the client sends an HTTP GET request to the
"registration_client_uri" with the "registration_access_token" as "registration_client_uri" with the "registration_access_token" as
its authorization. This response will contain the Client's its authorization. This response will contain the client's
refreshed "client_secret" along with any changed metadata values. refreshed "client_secret" along with any changed metadata values.
Its "client_id" will remain the same. Its "client_id" will remain the same.
g. If the Client needs to update its configuration on the g. If the client needs to update its configuration on the
Authorization Server, it sends an HTTP PUT request to the authorization server, it sends an HTTP PUT request to the
"registration_client_uri" with the "registration_access_token" as "registration_client_uri" with the "registration_access_token" as
its authorization. This response will contain the Client's its authorization. This response will contain the client's
changed metadata values. Its "client_id" will remain the same. changed metadata values. Its "client_id" will remain the same.
h. If the Client is uninstalled or otherwise deprovisioned, it can h. If the client is uninstalled or otherwise deprovisioned, it can
send an HTTP DELETE request to the "registration_client_uri" with send an HTTP DELETE request to the "registration_client_uri" with
the "registration_access_token" as its authorization. This will the "registration_access_token" as its authorization. This will
effectively deprovision the client from the Authorization Server. effectively deprovision the client from the authorization server.
B.2. Protected Registration B.2. Protected Registration
An Authorization Server may require an Initial Access Token for
requests to its Registration Endpoint. While the method by which a
Client receives this Initial Access Token and the method by which the
Authorization Server validates this Initial Access Token are out of
scope for this specification, a common approach is for the Developer
to use a manual pre-registration portal at the Authorization Server
that issues an Initial Access Token to the Developer. This allows
the Developer to package the Initial Access Token with different
instances of the application. While each copy of the application
would get its own Client Identifier (and Registration Access Token),
all instances of the application would be tied back to the Developer
by their use of this initial registration token.
a. A Developer is creating a Client to use an Authorization Server An authorization server may require an initial access token for
and knows that instances of the Client will dynamically register requests to its registration endpoint. While the method by which a
at runtime, but that the Authorization Server requires client receives this initial Access token and the method by which the
authorization the registration endpoint. authorization server validates this initial access token are out of
b. The Developer visits a manual pre-registration page at the scope for this specification, a common approach is for the developer
Authorization Server and is issued an Initial Access Token in the to use a manual pre-registration portal at the authorization server
that issues an initial access token to the developer. This allows
the developer to package the initial access token with different
instances of the client application. While each copy of the
application would get its own client identifier (and registration
access token), all instances of the application would be tied back to
the developer by their shared use of this initial access token.
a. A developer is creating a client to use an authorization server
and knows that instances of the client will dynamically register
at runtime, but that the authorization server requires
authorization at the registration endpoint.
b. The developer visits a manual pre-registration page at the
authorization server and is issued an initial access token in the
form of an OAuth 2.0 Bearer Token [RFC6750]. form of an OAuth 2.0 Bearer Token [RFC6750].
c. The Developer packages that token with all instances of the c. The developer packages that token with all instances of the
Client application. client application.
d. The Client needs to get OAuth 2.0 tokens from an Authorization d. The client needs to get OAuth 2.0 tokens from an authorization
Server, but the Client does not have a Client Identifier for that server, but the client does not have a client identifier for that
Authorization Server. authorization server.
e. The Client sends an HTTP POST request to the Client Registration e. The client sends an HTTP POST request to the client registration
Endpoint at the Authorization Server with its metadata, and the endpoint at the authorization server with its metadata, and the
Initial Access Token as its authorization. initial access token as its authorization.
f. The Authorization Server issues a Client Identifier and returns f. The authorization server issues a client identifier and returns
it to the Client along with a Registration Access Token and a it to the client along with a registration access token and a
reference to the Client's Client Configuration Endpoint. reference to the client's client configuration endpoint.
g. The Client stores the returned response from the Authorization g. The client stores the returned response from the authorization
Server. At a minimum, it should know the values of "client_id", server. At a minimum, it should know the values of "client_id",
"client_secret" (if present), "registration_access_token", and "client_secret" (if present), "registration_access_token", and
"registration_client_uri". "registration_client_uri".
h. The Client uses the its "client_id" and "client_secret" (if h. The client uses the its "client_id" and "client_secret" (if
provided) to request OAuth 2.0 tokens using any supported OAuth provided) to request OAuth 2.0 tokens using any supported OAuth
2.0 flow. 2.0 flow for which this client is authorized.
i. If the Client's "client_secret" expires or otherwise stops i. If the client's "client_secret" expires or otherwise stops
working, the Client sends an HTTP GET request to the working, the client sends an HTTP GET request to the
"registration_client_uri" with the "registration_access_token" as "registration_client_uri" with the "registration_access_token" as
its authorization. This response will contain the Client's its authorization. This response will contain the client's
refreshed "client_secret" along with any metadata values refreshed "client_secret" along with any metadata values
registered to that client, some of which may have changed. Its registered to that client, some of which may have changed. Its
"client_id" will remain the same. "client_id" will remain the same.
j. If the Client needs to update its configuration on the j. If the client needs to update its configuration on the
Authorization Server, it sends an HTTP PUT request to the authorization server, it sends an HTTP PUT request to the
"registration_client_uri" with the "registration_access_token" as "registration_client_uri" with the "registration_access_token" as
its authorization. The response will contain the Client's its authorization. The response will contain the client's
changed metadata values. Its "client_id" will remain the same. changed metadata values. Its "client_id" will remain the same.
k. If the Client is uninstalled or otherwise deprovisioned, it can k. If the client is uninstalled or otherwise deprovisioned, it can
send an HTTP DELETE request to the "registration_client_uri" with send an HTTP DELETE request to the "registration_client_uri" with
the "registration_access_token" as its authorization. This will the "registration_access_token" as its authorization. This will
effectively deprovision the client from the Authorization Server. effectively deprovision the client from the Authorization Server.
B.3. Developer Automation B.3. Developer Automation
The Dynamic Registration protocol can also be used in place of a The dynamic registration protocol can also be used in place of a
manual registration portal, for instance as part of an automated manual registration portal, for instance as part of an automated
build and deployment process. An Authorization Server may require an build and deployment process. In this scenario, the authorization
Initial Access Token for requests to its Registration Endpoint, as server may require an initial access token for requests to its
described in Protected Registration (Appendix B.2). However, in this registration endpoint, as described in Protected Registration
scenario, the Developer manages the Client's registration instead of (Appendix B.2). However, here the developer manages the client's
the Client itself. Therefore, the initial registration token and registration instead of the client itself. Therefore, the initial
Registration Access Token all remain with the Developer. The registration token and registration access token all remain with the
Developer packages the Client Identifier with the Client as part of developer. The developer packages the client identifier with the
the Client's build process. client as part of the client's build process.
a. A Developer is creating a Client to use an Authorization Server a. A developer is creating a client to use an authorization server
and knows that instances of the Client will not dynamically and knows that instances of the client will not dynamically
register at runtime. register at runtime.
b. If required for registrations at the Authorization Server, the b. If required for registrations at the authorization server, the
Developer performs an OAuth 2.0 authorization of his build developer performs an OAuth 2.0 authorization of his build
environment against the Authorization Server. The Authorization environment against the authorization server using any valid
Server and is issues an Initial Access Token to the Developer's OAuth 2.0 flow. The authorization server and is issues an
build environment in the form of an OAuth 2.0 Bearer Token initial access token to the developer's build environment in the
[RFC6750]. form of an OAuth 2.0 Bearer Token [RFC6750].
c. The Developer configures his build environment to send an HTTP c. The developer configures his build environment to send an HTTP
POST request to the Client Registration Endpoint at the POST request to the client registration endpoint at the
Authorization Server with the Client's metadata, using the authorization server with the client's metadata, using the
Initial Access Token obtained the previous step as an OAuth 2.0 initial access token obtained the previous step as an OAuth 2.0
Bearer Token [RFC6750], if needed. Bearer Token [RFC6750].
d. The Authorization Server issues a Client Identifier and returns d. The authorization server issues a client identifier and returns
it to the Developer along with a Registration Access Token and a it to the developer along with a registration access token and a
reference to the Client's Client Configuration Endpoint. reference to the client's client configuration endpoint.
e. The Developer packages the Client Identifier with the Client and e. The developer packages the client identifier with the client and
stores the "registration_access_token", and stores the "registration_access_token", and
"registration_client_uri" in the deployment system. "registration_client_uri" in the deployment system.
f. The Client uses the its "client_id" and "client_secret" (if f. The client uses the its "client_id" and "client_secret" (if
provided) to request OAuth 2.0 tokens using any supported OAuth provided) to request OAuth 2.0 tokens using any supported OAuth
2.0 flow. 2.0 flow.
g. If the Client's "client_secret" expires or otherwise stops g. If the client's "client_secret" expires or otherwise stops
working, the Developer's deployment system sends an HTTP GET working, the developer's deployment system sends an HTTP GET
request to the "registration_client_uri" with the request to the "registration_client_uri" with the
"registration_access_token" as its authorization. This response "registration_access_token" as its authorization. This response
will contain the Client's refreshed "client_secret" along with will contain the client's refreshed "client_secret" along with
any changed metadata values. Its "client_id" will remain the any changed metadata values. Its "client_id" will remain the
same. These new values will then be packaged and shipped to or same. These new values will then be packaged and shipped to or
retrieved by instances of the Client, if necessary. retrieved by instances of the client, if necessary.
h. If the Developer needs to update its configuration on the h. If the developer needs to update its configuration on the
Authorization Server, the deployment system sends an HTTP PUT authorization server, the deployment system sends an HTTP PUT
request to the "registration_client_uri" with the request to the "registration_client_uri" with the
"registration_access_token" as its authorization. This response "registration_access_token" as its authorization. This response
will contain the Client's changed metadata values. Its will contain the client's changed metadata values. Its
"client_id" will remain the same. These new values will then be "client_id" will remain the same. These new values will then be
packaged and shipped to or retrieved by instances of the Client, packaged and shipped to or retrieved by instances of the client,
if necessary. if necessary.
i. If the Client is deprovisioned, the Developer's deployment system i. If the client is deprovisioned, the developer's deployment system
can send an HTTP DELETE request to the "registration_client_uri" can send an HTTP DELETE request to the "registration_client_uri"
with the "registration_access_token" as its authorization. This with the "registration_access_token" as its authorization. This
will effectively deprovision the client from the Authorization will effectively deprovision the client from the authorization
Server and prevent any instances of the client from functioning. server and prevent any instances of the client from functioning.
Appendix C. Document History Appendix C. Document History
[[ to be removed by the RFC editor before publication as an RFC ]] [[ to be removed by the RFC editor before publication as an RFC ]]
-13
o Fixed broken example text in registration request and in delete
request
o Added security discussion of separating clients of different grant
types
o Fixed error reference to point to RFC6750 instead of RFC6749
o Clarified that servers must respond to all requests to
configuration endpoint, even if it's just an error code
o Lowercased all Terms to conform to style used in RFC6750
-12 -12
o Improved definition of Initial Access Token o Improved definition of Initial Access Token
o Changed developer registration scenario to have the Initial Access o Changed developer registration scenario to have the Initial Access
Token gotten through a normal OAuth 2.0 flow Token gotten through a normal OAuth 2.0 flow
o Moved non-normative client lifecycle examples to appendix o Moved non-normative client lifecycle examples to appendix
o Marked differentiating between auth servers as out of scope o Marked differentiating between auth servers as out of scope
o Added protocol flow diagram o Added protocol flow diagram
o Added credential rotation discussion o Added credential rotation discussion
o Called out Client Registration Endpoint as an OAuth 2.0 Protected o Called out Client Registration Endpoint as an OAuth 2.0 Protected
 End of changes. 200 change blocks. 
520 lines changed or deleted 574 lines changed or added

This html diff was produced by rfcdiff 1.41. The latest version is available from http://tools.ietf.org/tools/rfcdiff/