forked from jricher/oauth-spec
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdraft-ietf-oauth-dyn-reg.xml
2056 lines (1658 loc) · 97.7 KB
/
draft-ietf-oauth-dyn-reg.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="US-ASCII"?>
<!DOCTYPE rfc PUBLIC "-//IETF//DTD RFC 2629//EN"
"http://xml.resource.org/authoring/rfc2629.dtd" [
<!ENTITY rfc2119 PUBLIC "" "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml">
]>
<rfc category="std" docName="draft-ietf-oauth-dyn-reg-14" ipr="trust200902">
<?xml-stylesheet type='text/xsl' href='rfc2629.xslt' ?>
<?rfc toc='yes' ?>
<?rfc tocdepth='3' ?>
<?rfc symrefs='yes' ?>
<?rfc sortrefs='yes' ?>
<?rfc compact='yes' ?>
<?rfc subcompact='no' ?>
<?rfc strict='yes' ?>
<?rfc notedraftinprogress='yes' ?>
<front>
<title abbrev="oauth-dyn-reg">OAuth 2.0 Dynamic Client Registration
Protocol</title>
<author fullname="Justin Richer" initials="J" role="editor"
surname="Richer">
<organization>The MITRE Corporation</organization>
<address>
<postal>
<street/>
<city/>
<region/>
<code/>
<country/>
</postal>
<phone/>
<facsimile/>
<email>[email protected]</email>
<uri/>
</address>
</author>
<author fullname="John Bradley" initials="J." surname="Bradley">
<organization abbrev="Ping Identity">Ping Identity</organization>
<address>
<email>[email protected]</email>
</address>
</author>
<author fullname="Michael B. Jones" initials="M.B." surname="Jones">
<organization abbrev="Microsoft">Microsoft</organization>
<address>
<email>[email protected]</email>
<uri>http://self-issued.info/</uri>
</address>
</author>
<author fullname="Maciej Machulak" initials="M" surname="Machulak">
<organization>Newcastle University</organization>
<address>
<email>[email protected]</email>
<uri>http://ncl.ac.uk/</uri>
</address>
</author>
<date day="29" month="July" year="2013"/>
<area>Security</area>
<workgroup>OAuth Working Group</workgroup>
<abstract>
<t>This specification defines an endpoint and protocol for dynamic
registration of OAuth 2.0 clients at an authorization server and methods
for the dynamically registered client to manage its registration through
an OAuth 2.0 protected web API.</t>
</abstract>
</front>
<middle>
<section anchor="Introduction" title="Introduction">
<t>In some use-case scenarios, it is desirable or necessary to allow
OAuth 2.0 clients to obtain authorization from an OAuth 2.0
authorization server without requiring the two parties to interact
beforehand. Nevertheless, for the authorization server to accurately and
securely represent to end-users which client is seeking authorization to
access the end-user's resources, a method for automatic and unique
registration of clients is needed. The OAuth 2.0 authorization framework
does not define how the relationship between the client and the
authorization server is initialized, or how a given client is assigned a
unique client identifier. Historically, this has happened out-of-band
from the OAuth 2.0 protocol. This draft provides a mechanism for a
client to register itself with the authorization server, which can be
used to dynamically provision a client identifier, and optionally a
client secret. Additionally, the mechanisms in this draft may can be
used by a client developer to register the client with the authorization
server in a programmatic fashion.</t>
<t>As part of the registration process, this specification also defines
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 the
user during the authorization step. This draft also provides a mechanism
for the client to read and update this information after the initial
registration action. This draft protects these actions through the use
of an OAuth 2.0 bearer access token that is issued to the client during
registration explicitly for this purpose.</t>
<section anchor="Notation" title="Notational Conventions">
<t>The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL NOT',
'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'MAY', and 'OPTIONAL' in this
document are to be interpreted as described in <xref
target="RFC2119"/>.</t>
<t>Unless otherwise noted, all the protocol parameter names and values
are case sensitive.</t>
</section>
<section anchor="terminology" title="Terminology">
<t>This specification uses the terms "Access Token", "Refresh Token",
"Authorization Code", "Authorization Grant", "Authorization Server",
"Authorization Endpoint", "Client", "Client Identifier", "Client
Secret", "Protected Resource", "Resource Owner", "Resource Server",
and "Token Endpoint" defined by <xref target="RFC6749">OAuth
2.0</xref>.</t>
<t>This specification defines the following additional terms:</t>
<t><list style="hanging">
<t hangText="Client Registration Endpoint">OAuth 2.0 endpoint
through which a client can be registered at an authorization
server. The means by which the URL for this endpoint are obtained
are out of scope for this specification.</t>
<t hangText="Client Configuration Endpoint">OAuth 2.0 endpoint
through which registration information for a registered client can
be managed. This URL for this endpoint is returned by the
authorization server in the client information response.</t>
<t hangText="Registration Access Token">OAuth 2.0 bearer token
issued by the authorization server through the client registration
endpoint that is used to authenticate the caller when accessing
the client's registration information at the client configuration
endpoint. This access token is associated with a particular
registered client.</t>
<t hangText="Initial Access Token">OAuth 2.0 access token
optionally issued by an Authorization Server and used to authorize
calls to the client registration endpoint. The type and format of
this token are likely service-specific and are out of scope for
this specification. The means by which the authorization server
issues this token as well as the means by which the registration
endpoint validates this token are out of scope for this
specification.</t>
</list></t>
</section>
<section anchor="protocol-flow" title="Protocol Flow">
<figure>
<preamble>(preamble)</preamble>
<artwork><![CDATA[
+--------(A)- Initial Access Token
|
v
+-----------+ +---------------+
| |--(B)- Client Registration Request -->| Client |
| | | Registration |
| |<-(C)- Client Information Response ---| Endpoint |
| | +---------------+
| |
| | +---------------+
| Client or |--(D)- Read or Update Request ------->| |
| Developer | | |
| |<-(E)- Client Information Response ---| Client |
| | | Configuration |
| | | Endpoint |
| | | |
| |--(F)- Delete Request --------------->| |
| | | |
| |<-(G)- Delete Confirmation -----------| |
+-----------+ +---------------+
]]></artwork>
<postamble>Figure 1: Abstract Protocol Flow</postamble>
</figure>
<t>The abstract OAuth 2.0 Client dynamic registration flow illustrated
in Figure 1 describes the interaction between the client or developer
and the two endpoints defined in this specification. This figure does
not demonstrate error conditions. This flow includes the following
steps:</t>
<t><list style="hanging">
<t hangText="(A)"><vspace blankLines="0"/>Optionally, the client
or developer is issued an initial access token for use with the
client registration endpoint. The method by which the initial
access token is issued to the client or developer is out of scope
for this specification.</t>
<t hangText="(B)"><vspace blankLines="0"/>The client or developer
calls the client registration endpoint with its desired
registration metadata, optionally including the initial access
token from (A) if one is required by the authorization server.</t>
<t hangText="(C)"><vspace blankLines="0"/>The authorization server
registers the client and returns the client's registered metadata,
a client identifier that is unique at the server, a set of client
credentials such as a client secret if applicable for this client,
a URI pointing to the client configuration endpoint, and a
registration access token to be used when calling the client
configuration endpoint.</t>
<t hangText="(D)"><vspace blankLines="0"/>The client or developer
optionally calls the client configuration endpoint with a read or
update request using the registration access token issued in (C).
An update request contains all of the client's registered
metadata.</t>
<t hangText="(E)"><vspace blankLines="0"/>The authorization server
responds with the client's current configuration, potentially
including a new registration access token and a new set of client
credentials such as a client secret if applicable for this client.
If a new registration access token is issued, it replaces the
token issued in (C) for all subsequent calls to the client
configuration endpoint.</t>
<t hangText="(F)"><vspace blankLines="0"/>The client or developer
optionally calls the client configuration endpoint with a delete
request using the registration access token issued in (C).</t>
<t hangText="(G)"><vspace blankLines="0"/>The authorization server
deprovisions the client and responds with a confirmation that the
deletion has taken place.</t>
</list>Further discussion of possible example lifecycles are found
in the Appendix to this specification, <xref
target="client-lifecycle-examples">Client Lifecycle
Examples</xref>.</t>
</section>
<section anchor="Credentials"
title="Registration Tokens and Client Credentials">
<t>Throughout the course of the dynamic registration protocol, there
are three different classes of credentials in play, each with
different properties and targets.</t>
<t><list style="symbols">
<t>The initial access token is optionally used by the client or
developer at the registration endpoint. This is an OAuth 2.0 token
that is used to authorize the initial client registration request.
The content, structure, generation, and validation of this token
are out of scope for this specification. The authorization server
can use this token to verify that the presenter is allowed to
dynamically register new clients. This token may be shared between
multiple instances of a client to allow them to each register
separately, thereby letting the authorization server use this
token to tie multiple instances of registered clients (each with
their own distinct client identifier) back to the party to whom
the initial access token was issued, usually an application
developer. This token should be used only at the client
registration endpoint.</t>
<t>The registration access token is used by the client or
developer at the client configuration endpoint and represents the
holder's authorization to manage the registration of a client.
This is an OAuth 2.0 bearer token that is issued from the client
registration endpoint in response to a client registration request
and is returned in a client information response. The registration
access token is uniquely bound to the client identifier and is
required to be presented with all calls to the client
configuration endpoint. The registration access token should be
protected and should not be shared between instances of a client
(otherwise, one instance could change or delete registration
values for all instances of the client). The registration access
token can be rotated through the use of the client read and update
methods on the client configuration endpoint. The registration
access token should be used only at the client configuration
endpoint.</t>
<t>The client credentials (such as <spanx style="verb">client_secret</spanx>)
are optional depending on the type of client and are used to
retrieve OAuth tokens. Client credentials are most often bound to
particular instances of a client and should not be shared between
instances. Note that since not all types of clients have client
credentials, they cannot be used to manage client registrations at
the client configuration endpoint. The client credentials can be
rotated through the use of the client read and update methods on
the client configuration endpoint. The client credentials can not
be used for authentication at the client registration endpoint or
at the client configuration endpoint.</t>
</list></t>
<section anchor="credential-rotation" title="Credential Rotation">
<t>The Authorization Server MAY rotate the client's registration
access token and/or client credentials (such as a <spanx
style="verb">client_secret</spanx>) throughout the lifetime of the
client. The client can discovery that these values have changed by
reading the client information response returned from either a read
or update request to the client configuration endpoint. The client's
current registration access token and client credentials (if
applicable) MUST be included in this response.</t>
<t>The registration access token SHOULD be rotated only in response
to a read or update request to the client configuration endpoint, at
which point the new registration access token is returned to the
client and the old registration access token SHOULD be discarded by
both 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.</t>
</section>
</section>
</section>
<section anchor="client-metadata" title="Client Metadata">
<t>Clients generally have an array of metadata associated with their
unique client identifier at the authorization server. These can 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 valid redirect
URIs.</t>
<t>The client metadata values serve two parallel purposes in the overall
OAuth 2.0 dynamic client registration protocol:</t>
<t><list style="symbols">
<t>the client requesting its desired values for each parameter to
the authorization server in a <xref
target="RegistrationRequest">register</xref> or <xref
target="UpdateRequest">update</xref> request, and</t>
<t>the authorization server informing the client of the current
values of each parameter that the client has been registered to use
through a <xref target="client-info-response">client information
response</xref>.</t>
</list></t>
<t>An authorization server MAY override any value that a client requests
during the registration process (including any omitted values) and
replace the requested value with a default at the server's discretion.
The authorization server SHOULD provide documentation for any fields
that it requires to be filled in by the client or to have particular
values or formats. An authorization server MAY ignore the values
provided by the client for any field in this list.</t>
<t>Extensions and profiles of this specification MAY expand this list,
and authorization servers MUST accept all fields in this list. The
authorization server MUST ignore any additional parameters sent by the
Client that it does not understand.</t>
<t><list style="hanging">
<t hangText="redirect_uris"><vspace blankLines="0"/>Array of
redirect URIs for use in redirect-based flows such as the
authorization code and implicit grant types. It is RECOMMENDED that
clients using these flows register this parameter, and an
authorization server SHOULD require registration of valid redirect
URIs for all clients that use these grant types to protect against
token and credential theft attacks.</t>
<t hangText="client_name"><vspace blankLines="0"/>Human-readable
name of the client to be presented to the user. If omitted, the
authorization server MAY display the raw <spanx style="verb">client_id</spanx>
value to the user instead. It is RECOMMENDED that clients always
send this field. The value of this field MAY be internationalized as
described in <xref target="HumanReadableClientMetadata">Human
Readable Client Metadata</xref>.</t>
<t hangText="client_uri"><vspace/>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 RECOMMENDED that clients always send this
field. The value of this field MUST point to a valid web page. The
value of this field MAY be internationalized as described in <xref
target="HumanReadableClientMetadata">Human Readable Client
Metadata</xref>.</t>
<t hangText="logo_uri"><vspace blankLines="0"/>URL that references a
logo for the client. If present, the server SHOULD display this
image to the end user during approval. The value of this field MUST
point to a valid image file. The value of this field MAY be
internationalized as described in <xref
target="HumanReadableClientMetadata">Human Readable Client
Metadata</xref>.</t>
<t hangText="contacts"><vspace blankLines="0"/>Array of email
addresses for people responsible for this client. The authorization
server MAY make these addresses available to end users for support
requests for the client. An authorization server MAY use these email
addresses as identifiers for an administrative page for this
client.</t>
<t hangText="tos_uri"><vspace blankLines="0"/>URL that points to a
human-readable Terms of Service document for the client. The
Authorization Server SHOULD display this URL to the end-user if it
is given. The Terms of Service usually describe a contractual
relationship between the end-user and 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 this field MAY be
internationalized as described in <xref
target="HumanReadableClientMetadata">Human Readable Client
Metadata</xref>.</t>
<t hangText="policy_uri"><vspace blankLines="0"/>URL that points to
a human-readable Policy document for the client. The authorization
server SHOULD display this URL to the 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 MUST point to a valid web page. The
value of this field MAY be internationalized as described in <xref
target="HumanReadableClientMetadata">Human Readable Client
Metadata</xref>.</t>
<t hangText="token_endpoint_auth_method"><vspace blankLines="0"/>The
requested authentication method for the token endpoint. Values
defined by this specification are: <list style="symbols">
<t><spanx style="verb">none</spanx>: The client is a public
client as defined in OAuth 2.0 and does not have a client
secret.</t>
<t><spanx style="verb">client_secret_post</spanx>: The client
uses the HTTP POST parameters defined in OAuth 2.0 section
2.3.1.</t>
<t><spanx style="verb">client_secret_basic</spanx>: the client
uses HTTP Basic defined in OAuth 2.0 section 2.3.1</t>
</list> Additional values can be defined via the IANA OAuth Token
Endpoint Authentication Methods Registry <xref
target="team-registry"/>. Absolute URIs can also be used as values
for this parameter without being registered. If unspecified or
omitted, the default is <spanx style="verb">client_secret_basic</spanx>,
denoting HTTP Basic Authentication Scheme as specified in Section
2.3.1 of OAuth 2.0.</t>
<t hangText="scope"><vspace blankLines="0"/>Space separated list of
scope values (as described in <xref target="RFC6749">OAuth 2.0
Section 3.3</xref>) that the client can use when requesting access
tokens. The semantics of values in this list is service specific. If
omitted, an authorization server MAY register a Client with a
default set of scopes.</t>
<t hangText="grant_types"><vspace blankLines="0"/>Array of OAuth 2.0
grant types that the Client may use. These grant types are defined
as follows:<list style="symbols">
<t><spanx style="verb">authorization_code</spanx>: The
Authorization Code Grant described in OAuth 2.0 Section 4.1</t>
<t><spanx style="verb">implicit</spanx>: The Implicit Grant
described in OAuth 2.0 Section 4.2</t>
<t><spanx style="verb">password</spanx>: The Resource Owner
Password Credentials Grant described in OAuth 2.0 Section
4.3</t>
<t><spanx style="verb">client_credentials</spanx>: The Client
Credentials Grant described in OAuth 2.0 Section 4.4</t>
<t><spanx style="verb">refresh_token</spanx>: The Refresh Token
Grant described in OAuth 2.0 Section 6.</t>
<t><spanx style="verb">urn:ietf:params:oauth:grant-type:jwt-bearer</spanx>:
The JWT Bearer Grant defined in <xref target="OAuth.JWT">OAuth
JWT Bearer Token Profiles</xref>.</t>
<t><spanx style="verb">urn:ietf:params:oauth:grant-type:saml2-bearer</spanx>:
The SAML 2 Bearer Grant defined in <xref
target="OAuth.SAML2">OAuth SAML 2 Bearer Token
Profiles</xref>.</t>
</list>Authorization Servers MAY allow for other values as defined
in 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 in
the grant type, the value of this parameter MUST be the same as the
value of the <spanx style="verb">grant_type</spanx> parameter passed
to the token endpoint defined in the extension.</t>
<t hangText="response_types"><vspace blankLines="0"/>Array of the
OAuth 2.0 response types that the Client may use. These response
types are defined as follows:<list style="symbols">
<t><spanx style="verb">code</spanx>: The Authorization Code
response described in OAuth 2.0 Section 4.1.</t>
<t><spanx style="verb">token</spanx>: The Implicit response
described in OAuth 2.0 Section 4.2.</t>
</list>Authorization servers MAY allow for other values as defined
in response type extensions to OAuth 2.0. The extension process is
described in OAuth 2.0 Section 2.5. If the authorization endpoint is
used by the grant type, the value of this parameter MUST be the same
as the value of the <spanx style="verb">response_type</spanx>
parameter passed to the authorization endpoint defined in the
extension.</t>
<t hangText="jwks_uri"><vspace blankLines="0"/>URL for the Client's
<xref target="JWK">JSON Web Key Set</xref> document representing the
client's public keys. The value of this field MUST point to a valid
JWK Set. These keys MAY be used for higher level protocols that
require signing or encryption.</t>
<t hangText="software_id"><vspace blankLines="0"/>A identifier for
the software that comprises a client. Unlike <spanx style="verb">client_id</spanx>,
which is issued by the authorization server and generally varies
between instances, the <spanx style="verb">software_id</spanx> is
asserted by the client software and is intended to be shared between
all copies of the client software. The value for this field MAY be a
<xref target="RFC4122">UUID</xref>. The identifier SHOULD NOT change
when software version changes or when a new installation instance is
detected. Authorization servers MUST treat this field as
self-asserted by the client and MUST NOT make any trusted decisions
on the value of this field alone.</t>
<t hangText="software_version"><vspace blankLines="0"/>A version
identifier for the software that comprises a client. The value of
this field is a string that is intended to be compared using string
equality matching. The value of the <spanx style="verb">software_version</spanx>
SHOULD change on any update to the client software. Authorization
servers MUST treat this field as self-asserted by the client and
MUST NOT make any trusted decisions on the value of this field
alone.</t>
</list></t>
<section anchor="GrantTypesAndResponseTypes"
title="Relationship Between Grant Types and Response Types">
<t>The <spanx style="verb">grant_types</spanx> and <spanx
style="verb">response_types</spanx> values described above are
partially orthogonal, as they refer to arguments passed to different
endpoints in the OAuth protocol. However, they are related in that the
<spanx style="verb">grant_types</spanx> available to a client
influence the <spanx style="verb">response_types</spanx> that the
client is allowed to use, and vice versa. For instance, a <spanx
style="verb">grant_types</spanx> value that includes <spanx
style="verb">authorization_code</spanx> implies a <spanx style="verb">response_types</spanx>
value that includes <spanx style="verb">code</spanx>, as both values
are defined as part of the OAuth 2.0 authorization code grant. As
such, a server supporting these fields SHOULD take steps to ensure
that a client cannot register itself into an inconsistent state.</t>
<t>The correlation between the two fields is listed in the table
below.</t>
<texttable>
<ttcol>grant_types value includes:</ttcol>
<ttcol>response_types value includes:</ttcol>
<c>authorization_code</c>
<c>code</c>
<c>implicit</c>
<c>token</c>
<c>password</c>
<c>(none)</c>
<c>client_credentials</c>
<c>(none)</c>
<c>refresh_token</c>
<c>(none)</c>
<c>urn:ietf:params:oauth:grant-type:jwt-bearer</c>
<c>(none)</c>
<c>urn:ietf:params:oauth:grant-type:saml2-bearer</c>
<c>(none)</c>
</texttable>
<t>Extensions and profiles of this document that introduce new values
to either the <spanx style="verb">grant_types</spanx> or <spanx
style="verb">response_types</spanx> parameter MUST document all
correspondences between these two parameter types.</t>
</section>
<section anchor="HumanReadableClientMetadata"
title="Human Readable Client Metadata">
<t>Human-readable client metadata values and client metadata values
that reference human-readable values MAY be represented in multiple
languages and scripts. For example, the values of fields such as
<spanx style="verb">client_name</spanx>, <spanx style="verb">tos_uri</spanx>,
<spanx style="verb">policy_uri</spanx>, <spanx style="verb">logo_uri</spanx>,
and <spanx style="verb">client_uri</spanx> might have multiple
locale-specific values in some client registrations.</t>
<t>To specify the languages and scripts, <xref
target="RFC5646">BCP47</xref> language tags are added to client
metadata member names, delimited by a # character. Since JSON member
names are case sensitive, it is RECOMMENDED that language tag values
used in Claim Names be spelled using the character case with which
they are registered in the <xref target="IANA.Language">IANA Language
Subtag Registry</xref>. In particular, normally language names are
spelled with lowercase characters, region names are spelled with
uppercase characters, and languages are spelled with mixed case
characters. However, since BCP47 language tag values are case
insensitive, implementations SHOULD interpret the language tag values
supplied in a case insensitive manner. Per the recommendations in
BCP47, language tag values used in metadata member names should only
be as specific as necessary. For instance, using <spanx style="verb">fr</spanx>
might be sufficient in many contexts, rather than <spanx style="verb">fr-CA</spanx>
or <spanx style="verb">fr-FR</spanx>.</t>
<t>For example, a client could represent its name in English as <spanx
style="verb">"client_name#en": "My Client"</spanx> and its name in
Japanese as <spanx style="verb">"client_name#ja-Jpan-JP": "\u30AF\u30E9\u30A4\u30A2\u30F3\u30C8\u540D"</spanx>
within the same registration request. The authorization server MAY
display any or all of these names to the resource owner during the
authorization step, choosing which name to display based on system
configuration, user preferences or other factors.</t>
<t>If any human-readable field is sent without a language tag, parties
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
as-is wherever it is presented in a user interface. To facilitate
interoperability, it is RECOMMENDED that clients and servers use a
human-readable field without any language tags in addition to any
language-specific fields, and it is RECOMMENDED that any
human-readable fields sent without language tags contain values
suitable for display on a wide variety of systems.</t>
<t>Implementer's Note: Many JSON libraries make it possible to
reference members of a JSON object as members of an object construct
in the native programming environment of the library. However, while
the <spanx style="verb">#</spanx> 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 in many programming environments.
Therefore, implementations will need to use alternative access forms
for these claims. For instance, in JavaScript, if one parses the JSON
as follows, <spanx style="verb">var j = JSON.parse(json);</spanx>,
then the member <spanx style="verb">client_name#en-us</spanx> can be
accessed using the JavaScript syntax <spanx style="verb">j["client_name#en-us"]</spanx>.</t>
</section>
</section>
<section anchor="RegistrationEndpoint"
title="Client Registration Endpoint">
<t>The client registration endpoint is an OAuth 2.0 endpoint defined in
this document that is designed to allow a client to be registered with
the authorization server. The client registration endpoint MUST accept
HTTP POST messages with request parameters encoded in the entity body
using the <spanx style="verb">application/json</spanx> format. The
client registration endpoint MUST be protected by a transport-layer
security mechanism, and the server MUST support TLS 1.2 <xref
target="RFC5246">RFC 5246</xref> and/or TLS 1.0 <xref target="RFC2246"/>
and MAY support additional transport-layer mechanisms meeting its
security requirements. When using TLS, the Client MUST perform a TLS/SSL
server certificate check, per <xref target="RFC6125">RFC
6125</xref>.</t>
<t>The client registration endpoint MAY be an OAuth 2.0 protected
resource and accept an initial access token in the form of an <xref
target="RFC6749">OAuth 2.0 </xref> access token to limit registration to
only previously authorized parties. The method by which the initial
access token is obtained by the registrant is generally out-of-band and
is out of scope for this specification. The method by which the initial
access token is verified and validated by the client registration
endpoint is out of scope for this specification.</t>
<t>To support open registration and facilitate wider interoperability,
the client registration endpoint SHOULD allow initial registration
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
otherwise limited to prevent a denial-of-service attack on the client
registration endpoint.</t>
<t>To allow the registrant to manage the client's information, the
client registration endpoint issues a request access token as an <xref
target="RFC6750">OAuth 2.0 Bearer Token</xref> to securely authorize
calls to the <xref target="AccessEndpoint">client configuration
endpoint</xref>.</t>
<t>The client registration endpoint MUST ignore all parameters it does
not understand.</t>
<section anchor="RegistrationRequest"
title="Client Registration Request">
<t>This operation registers a new client to the authorization server.
The authorization server assigns this client a unique client
identifier, optionally assigns a client secret, and associates the
metadata given in the request with the issued client identifier. The
request includes any parameters described in <xref
target="client-metadata">Client Metadata</xref> that the client wishes
to specify for itself during the registration. The authorization
server MAY provision default values for any items omitted in the
client metadata.</t>
<t>To register, the client or developer sends an HTTP POST to the
client registration endpoint with a content type of <spanx
style="verb">application/json</spanx>. The HTTP Entity Payload is a
<xref target="RFC4627">JSON</xref> document consisting of a JSON
object and all parameters as top-level members of that JSON
object.</t>
<t>For example, if the server supports open registration (with no
initial access token), the client could send the following
registration request to the client registration endpoint:</t>
<figure>
<preamble>Following is a non-normative example request (with line
wraps for display purposes only):</preamble>
<artwork><![CDATA[
POST /register HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: server.example.com
{
"redirect_uris":["https://client.example.org/callback",
"https://client.example.org/callback2"],
"client_name":"My Example Client",
"client_name#ja-Jpan-JP":
"\u30AF\u30E9\u30A4\u30A2\u30F3\u30C8\u540D",
"token_endpoint_auth_method":"client_secret_basic",
"scope":"read write dolphin",
"logo_uri":"https://client.example.org/logo.png",
"jwks_uri":"https://client.example.org/my_public_keys.jwks"
}
]]></artwork>
</figure>
<t/>
<t>Alternatively, if the server supports authorized registration, the
developer or the client will be provisioned with an initial access
token (the method by which the initial access token is obtained is out
of scope for this specification). The developer or client sends the
following authorized registration request to the client registration
endpoint. Note that the initial access token sent in this example as
an <xref target="RFC6750">OAuth 2.0 Bearer Token</xref>, but any OAuth
2.0 token type could be used by an authorization server:</t>
<figure>
<preamble>Following is a non-normative example request (with line
wraps for display purposes only):</preamble>
<artwork><![CDATA[
POST /register HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer ey23f2.adfj230.af32-developer321
Host: server.example.com
{
"redirect_uris":["https://client.example.org/callback",
"https://client.example.org/callback2"],
"client_name":"My Example Client",
"client_name#ja-Jpan-JP":
"\u30AF\u30E9\u30A4\u30A2\u30F3\u30C8\u540D",
"token_endpoint_auth_method":"client_secret_basic",
"scope":"read write dolphin",
"logo_uri":"https://client.example.org/logo.png",
"jwks_uri":"https://client.example.org/my_public_keys.jwks"
}
]]></artwork>
</figure>
<t/>
</section>
<section anchor="RegistrationResponse"
title="Client Registration Response">
<t>Upon successful registration, the authorization server generates a
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
server responds with an HTTP 201 Created code and a body of type
<spanx style="verb">application/json</spanx> with content described in
<xref target="client-info-response">Client Information
Response</xref>.</t>
<t>Upon an unsuccessful registration, the authorization server
responds with an error as described in <xref
target="client-registration-error">Client Registration
Error</xref>.</t>
</section>
</section>
<section anchor="AccessEndpoint" title="Client Configuration Endpoint">
<t>The client configuration endpoint is an OAuth 2.0 protected resource
that is provisioned by the server to facilitate viewing, updating, and
deleting a client's registered information. The location of this
endpoint is communicated to the client through the <spanx style="verb">registration_client_uri</spanx>
member of the <xref target="client-info-response">Client Information
Response</xref>. The client MUST use its registration access token in
all calls to this endpoint as an <xref target="RFC6750">OAuth 2.0 Bearer
Token</xref>.</t>
<t>Operations on this endpoint are switched through the use of different
<xref target="RFC2616">HTTP methods</xref>. If an authorization server
does not support a particular method on the client configuration
endpoint, it MUST respond with the appropriate error code.</t>
<section anchor="client-configuration-endpoint-uri"
title="Forming the Client Configuration Endpoint URL">
<t>The authorization server MUST provide the client with the fully
qualified URL in the <spanx style="verb">registration_client_uri</spanx>
element of the <xref target="client-info-response">Client Information
Response</xref>. The authorization server MUST 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 construct this URL from
component pieces.</t>
<t>Depending on deployment characteristics, the client configuration
endpoint URL may take any number of forms. It is RECOMMENDED that this
endpoint URL be formed through the use of a server-constructed URL
string which combines the client registration endpoint's URL and the
issued <spanx style="verb">client_id</spanx> for this client, with the
latter as either a path parameter or a query parameter. For example, a
client with the client identifier <spanx style="verb">s6BhdRkqt3</spanx>
could be given a client configuration endpoint URL of <spanx
style="verb">https://server.example.com/register/s6BhdRkqt3</spanx>
(path parameter) or of <spanx style="verb">https://server.example.com/register?client_id=s6BhdRkqt3</spanx>
(query parameter). In both of these cases, the client simply uses the
URL as given by the authorization server.</t>
<t>These common patterns can help the server to more easily determine
the client to which the request pertains, which MUST be matched
against the client to which the registration access token was issued.
If desired, the server MAY simply return the client registration
endpoint URL as the client configuration endpoint URL and change
behavior based on the authentication context provided by the
registration access token.</t>
</section>
<section anchor="ReadRequest" title="Client Read Request">
<t>To read the current configuration of the client on the
authorization server, the client makes an HTTP GET request to the
client configuration endpoint, authenticating with its registration
access token.</t>
<figure>
<preamble>Following is a non-normative example request (with line
wraps for display purposes only):</preamble>
<artwork><![CDATA[GET /register/s6BhdRkqt3 HTTP/1.1
Accept: application/json
Host: server.example.com
Authorization: Bearer reg-23410913-abewfq.123483
]]></artwork>
</figure>
<t/>
<t>Upon successful read of the information for a currently active
client, the authorization server responds with an HTTP 200 OK with
content type of <spanx style="verb">application/json</spanx> and a
payload as described in <xref target="client-info-response">Client
Information Response</xref>. Some values in the response, including
the <spanx style="verb">client_secret</spanx> and <spanx style="verb">registration_access_token</spanx>,
MAY be different from those in the initial registration response. If
the authorization server includes a new client secret and/or
registration access token in its response, the client MUST immediately
discard its previous client secret and/or registration access token.
The value of the <spanx style="verb">client_id</spanx> MUST NOT change
from the initial registration response.</t>
<t>If the registration access token used to make this request is not
valid, the server MUST respond with an error as described in <xref
target="RFC6750">OAuth Bearer Token Usage</xref>.</t>
<t>If the client does not exist on this server, the server MUST
respond with HTTP 401 Unauthorized and the registration access token
used to make this request SHOULD be immediately revoked.</t>
<t>If the client does not have permission to read its record, the
server MUST return an HTTP 403 Forbidden.</t>
</section>
<section anchor="UpdateRequest" title="Client Update Request">
<t>This operation updates a previously-registered client with new
metadata at the authorization server. This request is authenticated by
the registration access token issued to the client.</t>
<t>The client sends an HTTP PUT to the client configuration endpoint
with a content type of <spanx style="verb">application/json</spanx>.
The HTTP entity payload is a <xref target="RFC4627">JSON</xref>
document consisting of a JSON object and all parameters as top- level
members of that JSON object.</t>
<t>This request MUST include all fields described in <xref
target="client-metadata">Client Metadata</xref> as returned to the
client from a previous register, read, or update operation. The client
MUST NOT include the <spanx style="verb">registration_access_token</spanx>,
<spanx style="verb">registration_client_uri</spanx>, <spanx
style="verb">client_secret_expires_at</spanx>, or <spanx style="verb">client_id_issued_at</spanx>
fields described in <xref target="client-info-response">Client
Information Response</xref>.</t>
<t>Valid values of client metadata fields in this request MUST
replace, not augment, the values previously associated with this
client. Omitted fields MUST be treated as null or empty values by the
server.</t>
<t>The client MUST include its <spanx style="verb">client_id</spanx>
field in the request, and it MUST be the same as its currently-issued
client identifier. If the client includes the <spanx style="verb">client_secret</spanx>
field in the request, the value of this field MUST match the
currently-issued client secret for that client. The client MUST NOT be
allowed to overwrite its existing client secret with its own chosen
value.</t>
<t>For all metadata fields, the authorization server MAY replace any
invalid values with suitable default values, and it MUST return any
such fields to the client in the response.</t>
<t>For example, a client could send the following request to the
client registration endpoint to update the client registration in the
above example with new information:</t>
<figure>
<preamble>Following is a non-normative example request (with line
wraps for display purposes only):</preamble>
<artwork><![CDATA[PUT /register/s6BhdRkqt3 HTTP/1.1
Accept: application/json
Host: server.example.com
Authorization: Bearer reg-23410913-abewfq.123483
{
"client_id":"s6BhdRkqt3",
"client_secret": "cf136dc3c1fc93f31185e5885805d",
"redirect_uris":["https://client.example.org/callback",
"https://client.example.org/alt"],
"scope": "read write dolphin",
"grant_types": ["authorization_code", "refresh_token"]
"token_endpoint_auth_method": "client_secret_basic",
"jwks_uri": "https://client.example.org/my_public_keys.jwks"
"client_name":"My New Example",
"client_name#fr":"Mon Nouvel Exemple",
"logo_uri":"https://client.example.org/newlogo.png"
"logo_uri#fr":"https://client.example.org/fr/newlogo.png"
}
]]></artwork>
</figure>
<t/>
<t>Upon successful update, the authorization server responds with an
HTTP 200 OK Message with content type <spanx style="verb">application/json</spanx>
and a payload as described in <xref
target="client-info-response">Client Information Response</xref>. Some
values in the response, including the <spanx style="verb">client_secret</spanx>
and r<spanx style="verb">egistration_access_token</spanx>, MAY be
different from those in the initial registration response. If the
authorization server includes a new client secret and/or registration
access token in its response, the client MUST immediately discard its
previous client secret and/or registration access token. The value of
the <spanx style="verb">client_id</spanx> MUST NOT change from the
initial registration response.</t>
<t>If the registration access token used to make this request is not
valid, the server MUST respond with an error as described in <xref
target="RFC6750">OAuth Bearer Token Usage</xref>.</t>
<t>If the client does not exist on this server, the server MUST
respond with HTTP 401 Unauthorized, and the registration access token
used to make this request SHOULD be immediately revoked.</t>
<t>If the client is not allowed to update its records, the server MUST
respond with HTTP 403 Forbidden.</t>
<t>If the client attempts to set an invalid metadata field and the
authorization server does not set a default value, the authorization
server responds with an error as described in <xref
target="client-registration-error">Client Registration Error
Response</xref>.</t>
</section>
<section anchor="DeleteRequest" title="Client Delete Request">
<t>To deprovision itself on the authorization server, the client makes
an HTTP DELETE request to the client configuration endpoint. This
request is authenticated by the registration access token issued to
the client.</t>
<figure>
<preamble>Following is a non-normative example request (with line
wraps for display purposes only):</preamble>
<artwork><![CDATA[DELETE /register/s6BhdRkqt3 HTTP/1.1
Host: server.example.com
Authorization: Bearer reg-23410913-abewfq.123483