Skip to content

Commit dc034f6

Browse files
committed
incorporated Shayne\'s feedback
1 parent c50def7 commit dc034f6

File tree

1 file changed

+5
-77
lines changed

1 file changed

+5
-77
lines changed

openid-sharedsignals-framework-1_0.md

Lines changed: 5 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ Subject Principals are identified by Subject Members defined below.
247247
A Subject Member of a SSF event describes a subject of the event. A top-level claim named `sub_id` MUST be used to describe the primary subject of the event.
248248

249249
### Existing CAEP and RISC Events
250-
Event types already defined in the CAEP ({{CAEP}}) and RISC ({{RISC}}) specifications MAY use a `subject` field within the `events` claim of the SSF event to describe the primary Subject Principal of the event. SSF Transmitters SHOULD include the top-level `sub_id` claim even for these existing event types.
250+
Event types already defined in the CAEP ({{CAEP}}) and RISC ({{RISC}}) specifications MAY use a `subject` field within the `events` claim of the SSF event to describe the primary Subject Principal of the event. SSF Transmitters MUST include the top-level `sub_id` claim even for these existing event types.
251251

252252
### New Event Types
253253
New event types MUST use the top-level `sub_id` claim and MUST NOT use the `subject` field in the `events` claim to describe the primary Subject Principal.
@@ -1522,37 +1522,6 @@ Cache-Control: no-store
15221522
~~~
15231523
{: title="Example: Check Stream Status Response" #figstatusresp}
15241524

1525-
The following is a non-normative example request to check an event stream's
1526-
status for a specific subject:
1527-
1528-
~~~ http
1529-
GET /ssf/status?stream_id=f67e39a0a4d34d56b3aa1bc4cff0069f&subject=<url-encoded-subject> HTTP/1.1
1530-
Host: transmitter.example.com
1531-
Authorization: Bearer eyJ0b2tlbiI6ImV4YW1wbGUifQo=
1532-
~~~
1533-
{: title="Example: Check Stream Status Request with Subject" #figstatuswithsubjectreq}
1534-
1535-
The following is a non-normative example response with a Subject claim:
1536-
1537-
~~~
1538-
HTTP/1.1 200 OK
1539-
Content-Type: application/json
1540-
Cache-Control: no-store
1541-
1542-
{
1543-
"status": "enabled",
1544-
"sub_id": {
1545-
"format": "complex",
1546-
"tenant" : {
1547-
"format" : "iss_sub",
1548-
"iss" : "http://example.com/idp1",
1549-
"sub" : "1234"
1550-
}
1551-
}
1552-
}
1553-
~~~
1554-
{: title="Example: Check Stream Status Response" #figstatuswithsubjectresp}
1555-
15561525
Errors are signaled with HTTP status codes as follows:
15571526

15581527
| Code | Description |
@@ -1619,14 +1588,7 @@ Authorization: Bearer eyJ0b2tlbiI6ImV4YW1wbGUifQo=
16191588
{
16201589
"stream_id": "f67e39a0a4d34d56b3aa1bc4cff0069f",
16211590
"status": "paused",
1622-
"sub_id": {
1623-
"format": "complex",
1624-
"tenant" : {
1625-
"format" : "iss_sub",
1626-
"iss" : "http://example.com/idp1",
1627-
"sub" : "1234"
1628-
}
1629-
},
1591+
"stream_id": "f67e39a0a4d34d56b3aa1bc4cff0069f",
16301592
"reason": "Disabled by administrator action."
16311593
}
16321594
~~~
@@ -1642,10 +1604,6 @@ Cache-Control: no-store
16421604
{
16431605
"stream_id": "f67e39a0a4d34d56b3aa1bc4cff0069f",
16441606
"status": "paused",
1645-
"sub_id": {
1646-
"format" : "email",
1647-
"email" : "user@example.com"
1648-
}
16491607
}
16501608
~~~
16511609
{: title="Example: Update Stream Status Response" #figupdatestatusresp}
@@ -1960,42 +1918,12 @@ As with any SSF Event, this event has a top-level `sub_id` claim:
19601918

19611919
sub_id
19621920

1963-
> REQUIRED. The top-level `sub_id` claim specifies the Subject Principal for whom the status has been updated.
1964-
If the event applies to the entire stream, the value of the `sub_id` field
1965-
MUST be of format `opaque`, and its `id` value MUST be the unique ID of the
1966-
stream.
1921+
> REQUIRED. The top-level `sub_id` claim specifies the Stream Id for which the status has been updated. The value of the `sub_id` field MUST be of format `opaque`, and its `id` value MUST be the unique ID of the stream.
19671922

19681923
> Note that the subject that identifies a stream itself is always implicitly
19691924
added to the stream and MAY NOT be removed from the stream.
19701925

1971-
Below is a non-normative example of a `stream-updated` event with a specific subject.
1972-
1973-
~~~ json
1974-
{
1975-
"jti": "123456",
1976-
"iss": "https://transmitter.example.com",
1977-
"aud": "receiver.example.com",
1978-
"iat": 1493856000,
1979-
"sub_id": {
1980-
"format" : "complex",
1981-
"tenant" : {
1982-
"format": "iss_sub",
1983-
"iss" : "http://example.com/idp1",
1984-
"sub" : "1234"
1985-
}
1986-
},
1987-
"events": {
1988-
"https://schemas.openid.net/secevent/ssf/event-type/stream-updated": {
1989-
"status": "paused",
1990-
"reason": "License is not valid"
1991-
}
1992-
}
1993-
}
1994-
~~~
1995-
{: title="Example: Stream Updated SET with tenant principal" #figstreamupdatedset}
1996-
1997-
> Below is a non-normative example of a `stream-updated` event with a stream
1998-
subject.
1926+
> Below is a non-normative example of a `stream-updated` event.
19991927

20001928
~~~ json
20011929
{
@@ -2015,7 +1943,7 @@ Below is a non-normative example of a `stream-updated` event with a specific sub
20151943
}
20161944
}
20171945
~~~
2018-
{: title="Example: Stream Updated SET with stream as the subject of single-stream Transmitter" #figstreamupdatedstreamset}
1946+
{: title="Example: Stream Updated SET" #figstreamupdatedset}
20191947

20201948
# Authorization {#management-api-auth}
20211949
HTTP API calls from a Receiver to a Transmitter SHOULD be authorized by

0 commit comments

Comments
 (0)