Skip to content

Commit a4fde6f

Browse files
authored
Issue 163 - add field to configuration data indicating expected subject behavior for new streams (#168)
* Issue 163 - add field to configuration data indicating expected subject behavior for new streams * Add default_subjects to example * Fix language based on PR feedback * Clarify language * Fix spacing
1 parent 64229a3 commit a4fde6f

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

openid-sharedsignals-framework-1_0.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -587,6 +587,19 @@ authorization_schemes
587587
security considerations, make the authorization_schemes attribute
588588
publicly accessible without prior authentication.
589589

590+
default_subjects
591+
592+
> OPTIONAL. A string indicating the default behavior of newly created streams. If present,
593+
the value MUST be either "ALL" or "NONE". If not provided, the Transmitter behavior in
594+
this regard is unspecified.
595+
> - "ALL" indicates that any subjects that are appropriate for the stream are added to
596+
the stream by default. The Receiver MAY remove subjects from the stream via the
597+
`remove_subject_endpoint`, causing events for those subjects to _not_ be transmitted.
598+
The Receiver MAY re-add any subjects removed this way via the `add_subject_endpoint`.
599+
> - "NONE" indicates that no subjects are added by default. The Receiver MAY add subjects
600+
to the stream via the `add_subject_endpoint`, causing only events for those subjects
601+
to be transmitted. The Receiver MAY remove subjects added this way via the
602+
`remove_subject_endpoint`.
590603

591604
TODO: consider adding a IANA Registry for metadata, similar to Section 7.1.1 of
592605
{{RFC8414}}. This would allow other specs to add to the metadata.
@@ -719,7 +732,8 @@ Content-Type: application/json
719732
{
720733
"spec_urn": "urn:ietf:rfc:8705"
721734
}
722-
]
735+
],
736+
"default_subjects": "NONE"
723737
}
724738
~~~
725739
{: #figdiscoveryresponse title="Example: Transmitter Configuration Response"}
@@ -2158,7 +2172,7 @@ multiple Receivers would lead to unintended data disclosure.
21582172
{: title="Example: SET with array 'aud' claim" #figarrayaud}
21592173

21602174
### The "txn" claim {#txn-claim}
2161-
Transmitters SHOULD set the "txn" claim value in Security Event Tokens (SETs). If the value is present, it MUST be unique to the underlying event that caused the Transmitter to generate the Security Event Token (SET). The Transmitter, however, may use the same value in the "txn" claim across different Security Events Tokens (SETs), such as session revoked and credential change, to indicate that the SETs originated from the same underlying cause or reason.
2175+
Transmitters SHOULD set the "txn" claim value in Security Event Tokens (SETs). If the value is present, it MUST be unique to the underlying event that caused the Transmitter to generate the Security Event Token (SET). The Transmitter, however, may use the same value in the "txn" claim across different Security Events Tokens (SETs), such as session revoked and credential change, to indicate that the SETs originated from the same underlying cause or reason.
21622176

21632177
### The "events" claim {#events-claim}
21642178
The "events" claim SHOULD contain only one event. Multiple event type URIs are

0 commit comments

Comments
 (0)