806806
807807aud
808808
809- > **Transmitter -Supplied**, A string or an array of strings containing an
809+ > **Receiver -Supplied**, A string or an array of strings containing an
810810 audience claim as defined in JSON Web Token (JWT){{RFC7519}} that identifies
811811 the Event Receiver(s) for the Event Stream. This property cannot be updated.
812812 If multiple Receivers are specified then the Transmitter SHOULD know that
@@ -865,6 +865,12 @@ min_verification_interval
865865 MAY respond with a 429 status code. An Event Transmitter SHOULD NOT respond
866866 with a 429 status code if an Event Receiver is not exceeding this frequency.
867867
868+ description
869+
870+ > **Receiver-Supplied**, An optinal string to describe the properties of the stream.
871+ This is useful in multi stream systems to identify the stream for human actors. The
872+ transmitter may truncate the string beyond allowed max length.
873+
868874TODO : consider adding a IANA Registry for stream configuration metadata, similar
869875to Section 7.1.1 of {{RFC8414}}. This would allow other specs to add to
870876the stream configuration.
@@ -904,6 +910,10 @@ Host: transmitter.example.com
904910Authorization : Bearer eyJ0b2tlbiI6ImV4YW1wbGUifQo=
905911
906912{
913+ " aud " : [
914+ " http://receiver.example.com/web" ,
915+ " http://receiver.example.com/mobile"
916+ ],
907917 " delivery " : {
908918 " method " : " urn:ietf:rfc:8935" ,
909919 " endpoint_url " : " https://receiver.example.com/events"
@@ -912,7 +922,8 @@ Authorization: Bearer eyJ0b2tlbiI6ImV4YW1wbGUifQo=
912922 " urn:example:secevent:events:type_2" ,
913923 " urn:example:secevent:events:type_3" ,
914924 " urn:example:secevent:events:type_4"
915- ]
925+ ],
926+ " description" : "Stream for Receiver A using events type_2, type_3, type_4"
916927}
917928~~~
918929{: # figcreatestreamreq title="Example: Create Event Stream Request"}
@@ -947,7 +958,8 @@ Content-Type: application/json
947958 " events_delivered " : [
948959 " urn:example:secevent:events:type_2" ,
949960 " urn:example:secevent:events:type_3"
950- ]
961+ ],
962+ " description" : "Stream for Receiver A using events type_2, type_3, type_4"
951963}
952964~~~
953965{: # figcreatestreamresp title="Example: Create Stream Response"}
@@ -1017,7 +1029,8 @@ Cache-Control: no-store
10171029 " events_delivered " : [
10181030 " urn:example:secevent:events:type_2" ,
10191031 " urn:example:secevent:events:type_3"
1020- ]
1032+ ],
1033+ " description" : "Stream for Receiver A using events type_2, type_3, type_4"
10211034}
10221035~~~
10231036{: title="Example: Read Stream Configuration Response" # figreadconfigresp}
@@ -1090,7 +1103,8 @@ Cache-Control: no-store
10901103 " events_delivered " : [
10911104 " urn:example:secevent:events:type_2" ,
10921105 " urn:example:secevent:events:type_3"
1093- ]
1106+ ],
1107+ " description" : "Stream for Receiver A using events type_2, type_3, type_4"
10941108 }
10951109]
10961110~~~
@@ -1192,6 +1206,7 @@ Authorization: Bearer eyJ0b2tlbiI6ImV4YW1wbGUifQo=
11921206 " urn:example:secevent:events:type_3" ,
11931207 " urn:example:secevent:events:type_4"
11941208 ],
1209+ " description" : "Stream for Receiver B using events type_2, type_3, type_4"
11951210}
11961211~~~
11971212{: title="Example: Update Stream Configuration Request" # figupdateconfigreq}
@@ -1227,7 +1242,8 @@ Cache-Control: no-store
12271242 " events_delivered " : [
12281243 " urn:example:secevent:events:type_2" ,
12291244 " urn:example:secevent:events:type_3"
1230- ]
1245+ ],
1246+ " description" : "Stream for Receiver B using events type_2, type_3, type_4"
12311247}
12321248~~~
12331249{: title="Example: Update Stream Configuration Response" # figupdateconfigresp}
@@ -1274,10 +1290,7 @@ Authorization: Bearer eyJ0b2tlbiI6ImV4YW1wbGUifQo=
12741290{
12751291 " stream_id " : " f67e39a0a4d34d56b3aa1bc4cff0069f" ,
12761292 " iss " : " https://tr.example.com" ,
1277- " aud " : [
1278- " http://receiver.example.com/web" ,
1279- " http://receiver.example.com/mobile"
1280- ],
1293+ " aud " : " http://receiver.example.com/stream" ,
12811294 " delivery " : {
12821295 " method " : " urn:ietf:rfc:8935" ,
12831296 " endpoint_url " : " https://receiver.example.com/events"
@@ -1286,7 +1299,8 @@ Authorization: Bearer eyJ0b2tlbiI6ImV4YW1wbGUifQo=
12861299 " urn:example:secevent:events:type_2" ,
12871300 " urn:example:secevent:events:type_3" ,
12881301 " urn:example:secevent:events:type_4"
1289- ]
1302+ ],
1303+ " description" : "Stream for Receiver C"
12901304}
12911305~~~
12921306{: title="Example: Replace Stream Configuration Request" # figreplaceconfigreq}
@@ -1301,10 +1315,7 @@ Cache-Control: no-store
13011315{
13021316 " stream_id " : " f67e39a0a4d34d56b3aa1bc4cff0069f" ,
13031317 " iss " : " https://tr.example.com" ,
1304- " aud " : [
1305- " http://receiver.example.com/web" ,
1306- " http://receiver.example.com/mobile"
1307- ],
1318+ " aud " : " http://receiver.example.com/stream" ,
13081319 " delivery " : {
13091320 " method " : " urn:ietf:rfc:8935" ,
13101321 " endpoint_url " : " https://receiver.example.com/events"
@@ -1322,7 +1333,8 @@ Cache-Control: no-store
13221333 " events_delivered " : [
13231334 " urn:example:secevent:events:type_2" ,
13241335 " urn:example:secevent:events:type_3"
1325- ]
1336+ ],
1337+ " description" : "Stream for Receiver C"
13261338}
13271339~~~
13281340{: title="Example: Replace Stream Configuration Response" # figreplaceconfigresp}
0 commit comments