<!DOCTYPE html>
<html lang="en" class="Internet-Draft">
<head>
<meta charset="utf-8">
<meta content="Common,Latin" name="scripts">
<meta content="initial-scale=1.0" name="viewport">
<title>OpenID Federation Extended Subordinate Listing</title>
<meta content="Giuseppe De Marco" name="author">
<meta content="Michael Fraser" name="author">
<meta content="Lukasz Jaromin" name="author">
<meta content="Michael B. Jones" name="author">
<meta content="
This specification acts as an extension to the . It outlines methods to interact with a given Federation with a potentially large number of registered Entities, as well as mechanisms to retrieve multiple entity statements along with associated details in a single request.
" name="description">
<meta content="xml2rfc 3.16.0" name="generator">
<meta content="security" name="keyword">
<meta content="openid" name="keyword">
<meta content="openid-federation-extended-listing-00" name="ietf.draft">
<!-- Generator version information:
xml2rfc 3.16.0
Python 3.10.2
appdirs 1.4.4
ConfigArgParse 1.5.3
google-i18n-address 2.5.2
html5lib 1.1
intervaltree 3.1.0
Jinja2 3.1.2
lxml 4.9.2
MarkupSafe 2.1.2
pycountry 22.3.5
PyYAML 6.0
requests 2.28.2
setuptools 57.5.0
six 1.16.0
wcwidth 0.2.6
-->
<link href="./openid-federation-extended-listing-00.xml" rel="alternate" type="application/rfc+xml">
<link href="#copyright" rel="license">
<style type="text/css">/*
NOTE: Changes at the bottom of this file overrides some earlier settings.
Once the style has stabilized and has been adopted as an official RFC style,
this can be consolidated so that style settings occur only in one place, but
for now the contents of this file consists first of the initial CSS work as
provided to the RFC Formatter (xml2rfc) work, followed by itemized and
commented changes found necessary during the development of the v3
formatters.
*/
/* fonts */
@import url('https://fonts.googleapis.com/css?family=Noto+Sans'); /* Sans-serif */
@import url('https://fonts.googleapis.com/css?family=Noto+Serif'); /* Serif (print) */
@import url('https://fonts.googleapis.com/css?family=Roboto+Mono'); /* Monospace */
:root {
--font-sans: 'Noto Sans', Arial, Helvetica, sans-serif;
--font-serif: 'Noto Serif', 'Times', 'Times New Roman', serif;
--font-mono: 'Roboto Mono', Courier, 'Courier New', monospace;
}
@viewport {
zoom: 1.0;
width: extend-to-zoom;
}
@-ms-viewport {
width: extend-to-zoom;
zoom: 1.0;
}
/* general and mobile first */
html {
}
body {
max-width: 90%;
margin: 1.5em auto;
color: #222;
background-color: #fff;
font-size: 14px;
font-family: var(--font-sans);
line-height: 1.6;
scroll-behavior: smooth;
}
.ears {
display: none;
}
/* headings */
#title, h1, h2, h3, h4, h5, h6 {
margin: 1em 0 0.5em;
font-weight: bold;
line-height: 1.3;
}
#title {
clear: both;
border-bottom: 1px solid #ddd;
margin: 0 0 0.5em 0;
padding: 1em 0 0.5em;
}
.author {
padding-bottom: 4px;
}
h1 {
font-size: 26px;
margin: 1em 0;
}
h2 {
font-size: 22px;
margin-top: -20px; /* provide offset for in-page anchors */
padding-top: 33px;
}
h3 {
font-size: 18px;
margin-top: -36px; /* provide offset for in-page anchors */
padding-top: 42px;
}
h4 {
font-size: 16px;
margin-top: -36px; /* provide offset for in-page anchors */
padding-top: 42px;
}
h5, h6 {
font-size: 14px;
}
#n-copyright-notice {
border-bottom: 1px solid #ddd;
padding-bottom: 1em;
margin-bottom: 1em;
}
/* general structure */
p {
padding: 0;
margin: 0 0 1em 0;
text-align: left;
}
div, span {
position: relative;
}
div {
margin: 0;
}
.alignRight.art-text {
background-color: #f9f9f9;
border: 1px solid #eee;
border-radius: 3px;
padding: 1em 1em 0;
margin-bottom: 1.5em;
}
.alignRight.art-text pre {
padding: 0;
}
.alignRight {
margin: 1em 0;
}
.alignRight > *:first-child {
border: none;
margin: 0;
float: right;
clear: both;
}
.alignRight > *:nth-child(2) {
clear: both;
display: block;
border: none;
}
svg {
display: block;
}
svg[font-family~="serif" i], svg [font-family~="serif" i] {
font-family: var(--font-serif);
}
svg[font-family~="sans-serif" i], svg [font-family~="sans-serif" i] {
font-family: var(--font-sans);
}
svg[font-family~="monospace" i], svg [font-family~="monospace" i] {
font-family: var(--font-mono);
}
.alignCenter.art-text {
background-color: #f9f9f9;
border: 1px solid #eee;
border-radius: 3px;
padding: 1em 1em 0;
margin-bottom: 1.5em;
}
.alignCenter.art-text pre {
padding: 0;
}
.alignCenter {
margin: 1em 0;
}
.alignCenter > *:first-child {
display: table;
border: none;
margin: 0 auto;
}
/* lists */
ol, ul {
padding: 0;
margin: 0 0 1em 2em;
}
ol ol, ul ul, ol ul, ul ol {
margin-left: 1em;
}
li {
margin: 0 0 0.25em 0;
}
.ulCompact li {
margin: 0;
}
ul.empty, .ulEmpty {
list-style-type: none;
}
ul.empty li, .ulEmpty li {
margin-top: 0.5em;
}
ul.ulBare, li.ulBare {
margin-left: 0em !important;
}
ul.compact, .ulCompact,
ol.compact, .olCompact {
line-height: 100%;
margin: 0 0 0 2em;
}
/* definition lists */
dl {
}
dl > dt {
float: left;
margin-right: 1em;
}
/*
dl.nohang > dt {
float: none;
}
*/
dl > dd {
margin-bottom: .8em;
min-height: 1.3em;
}
dl.compact > dd, .dlCompact > dd {
margin-bottom: 0em;
}
dl > dd > dl {
margin-top: 0.5em;
margin-bottom: 0em;
}
/* links */
a {
text-decoration: none;
}
a[href] {
color: #22e; /* Arlen: WCAG 2019 */
}
a[href]:hover {
background-color: #f2f2f2;
}
figcaption a[href],
a[href].selfRef {
color: #222;
}
/* XXX probably not this:
a.selfRef:hover {
background-color: transparent;
cursor: default;
} */
/* Figures */
tt, code, pre {
background-color: #f9f9f9;
font-family: var(--font-mono);
}
pre {
border: 1px solid #eee;
margin: 0;
padding: 1em;
}
img {
max-width: 100%;
}
figure {
margin: 0;
}
figure blockquote {
margin: 0.8em 0.4em 0.4em;
}
figcaption {
font-style: italic;
margin: 0 0 1em 0;
}
@media screen {
pre {
overflow-x: auto;
max-width: 100%;
max-width: calc(100% - 22px);
}
}
/* aside, blockquote */
aside, blockquote {
margin-left: 0;
padding: 1.2em 2em;
}
blockquote {
background-color: #f9f9f9;
color: #111; /* Arlen: WCAG 2019 */
border: 1px solid #ddd;
border-radius: 3px;
margin: 1em 0;
}
cite {
display: block;
text-align: right;
font-style: italic;
}
/* tables */
table {
width: 100%;
margin: 0 0 1em;
border-collapse: collapse;
border: 1px solid #eee;
}
th, td {
text-align: left;
vertical-align: top;
padding: 0.5em 0.75em;
}
th {
text-align: left;
background-color: #e9e9e9;
}
tr:nth-child(2n+1) > td {
background-color: #f5f5f5;
}
table caption {
font-style: italic;
margin: 0;
padding: 0;
text-align: left;
}
table p {
/* XXX to avoid bottom margin on table row signifiers. If paragraphs should
be allowed within tables more generally, it would be far better to select on a class. */
margin: 0;
}
/* pilcrow */
a.pilcrow {
color: #666; /* Arlen: AHDJ 2019 */
text-decoration: none;
visibility: hidden;
user-select: none;
-ms-user-select: none;
-o-user-select:none;
-moz-user-select: none;
-khtml-user-select: none;
-webkit-user-select: none;
-webkit-touch-callout: none;
}
@media screen {
aside:hover > a.pilcrow,
p:hover > a.pilcrow,
blockquote:hover > a.pilcrow,
div:hover > a.pilcrow,
li:hover > a.pilcrow,
pre:hover > a.pilcrow {
visibility: visible;
}
a.pilcrow:hover {
background-color: transparent;
}
}
/* misc */
hr {
border: 0;
border-top: 1px solid #eee;
}
.bcp14 {
font-variant: small-caps;
}
.role {
font-variant: all-small-caps;
}
/* info block */
#identifiers {
margin: 0;
font-size: 0.9em;
}
#identifiers dt {
width: 3em;
clear: left;
}
#identifiers dd {
float: left;
margin-bottom: 0;
}
/* Fix PDF info block run off issue */
@media print {
#identifiers dd {
float: none;
}
}
#identifiers .authors .author {
display: inline-block;
margin-right: 1.5em;
}
#identifiers .authors .org {
font-style: italic;
}
/* The prepared/rendered info at the very bottom of the page */
.docInfo {
color: #666; /* Arlen: WCAG 2019 */
font-size: 0.9em;
font-style: italic;
margin-top: 2em;
}
.docInfo .prepared {
float: left;
}
.docInfo .prepared {
float: right;
}
/* table of contents */
#toc {
padding: 0.75em 0 2em 0;
margin-bottom: 1em;
}
nav.toc ul {
margin: 0 0.5em 0 0;
padding: 0;
list-style: none;
}
nav.toc li {
line-height: 1.3em;
margin: 0.75em 0;
padding-left: 1.2em;
text-indent: -1.2em;
}
/* references */
.references dt {
text-align: right;
font-weight: bold;
min-width: 7em;
}
.references dd {
margin-left: 8em;
overflow: auto;
}
.refInstance {
margin-bottom: 1.25em;
}
.references .ascii {
margin-bottom: 0.25em;
}
/* index */
.index ul {
margin: 0 0 0 1em;
padding: 0;
list-style: none;
}
.index ul ul {
margin: 0;
}
.index li {
margin: 0;
text-indent: -2em;
padding-left: 2em;
padding-bottom: 5px;
}
.indexIndex {
margin: 0.5em 0 1em;
}
.index a {
font-weight: 700;
}
/* make the index two-column on all but the smallest screens */
@media (min-width: 600px) {
.index ul {
-moz-column-count: 2;
-moz-column-gap: 20px;
}
.index ul ul {
-moz-column-count: 1;
-moz-column-gap: 0;
}
}
/* authors */
address.vcard {
font-style: normal;
margin: 1em 0;
}
address.vcard .nameRole {
font-weight: 700;
margin-left: 0;
}
address.vcard .label {
font-family: var(--font-sans);
margin: 0.5em 0;
}
address.vcard .type {
display: none;
}
.alternative-contact {
margin: 1.5em 0 1em;
}
hr.addr {
border-top: 1px dashed;
margin: 0;
color: #ddd;
max-width: calc(100% - 16px);
}
/* temporary notes */
.rfcEditorRemove::before {
position: absolute;
top: 0.2em;
right: 0.2em;
padding: 0.2em;
content: "The RFC Editor will remove this note";
color: #9e2a00; /* Arlen: WCAG 2019 */
background-color: #ffd; /* Arlen: WCAG 2019 */
}
.rfcEditorRemove {
position: relative;
padding-top: 1.8em;
background-color: #ffd; /* Arlen: WCAG 2019 */
border-radius: 3px;
}
.cref {
background-color: #ffd; /* Arlen: WCAG 2019 */
padding: 2px 4px;
}
.crefSource {
font-style: italic;
}
/* alternative layout for smaller screens */
@media screen and (max-width: 1023px) {
body {
padding-top: 2em;
}
#title {
padding: 1em 0;
}
h1 {
font-size: 24px;
}
h2 {
font-size: 20px;
margin-top: -18px; /* provide offset for in-page anchors */
padding-top: 38px;
}
#identifiers dd {
max-width: 60%;
}
#toc {
position: fixed;
z-index: 2;
top: 0;
right: 0;
padding: 0;
margin: 0;
background-color: inherit;
border-bottom: 1px solid #ccc;
}
#toc h2 {
margin: -1px 0 0 0;
padding: 4px 0 4px 6px;
padding-right: 1em;
min-width: 190px;
font-size: 1.1em;
text-align: right;
background-color: #444;
color: white;
cursor: pointer;
}
#toc h2::before { /* css hamburger */
float: right;
position: relative;
width: 1em;
height: 1px;
left: -164px;
margin: 6px 0 0 0;
background: white none repeat scroll 0 0;
box-shadow: 0 4px 0 0 white, 0 8px 0 0 white;
content: "";
}
#toc nav {
display: none;
padding: 0.5em 1em 1em;
overflow: auto;
height: calc(100vh - 48px);
border-left: 1px solid #ddd;
}
}
/* alternative layout for wide screens */
@media screen and (min-width: 1024px) {
body {
max-width: 724px;
margin: 42px auto;
padding-left: 1.5em;
padding-right: 29em;
}
#toc {
position: fixed;
top: 42px;
right: 42px;
width: 25%;
margin: 0;
padding: 0 1em;
z-index: 1;
}
#toc h2 {
border-top: none;
border-bottom: 1px solid #ddd;
font-size: 1em;
font-weight: normal;
margin: 0;
padding: 0.25em 1em 1em 0;
}
#toc nav {
display: block;
height: calc(90vh - 84px);
bottom: 0;
padding: 0.5em 0 0;
overflow: auto;
}
img { /* future proofing */
max-width: 100%;
height: auto;
}
}
/* pagination */
@media print {
body {
width: 100%;
}
p {
orphans: 3;
widows: 3;
}
#n-copyright-notice {
border-bottom: none;
}
#toc, #n-introduction {
page-break-before: always;
}
#toc {
border-top: none;
padding-top: 0;
}
figure, pre {
page-break-inside: avoid;
}
figure {
overflow: scroll;
}
.breakable pre {
break-inside: auto;
}
h1, h2, h3, h4, h5, h6 {
page-break-after: avoid;
}
h2+*, h3+*, h4+*, h5+*, h6+* {
page-break-before: avoid;
}
pre {
white-space: pre-wrap;
word-wrap: break-word;
font-size: 10pt;
}
table {
border: 1px solid #ddd;
}
td {
border-top: 1px solid #ddd;
}
}
/* This is commented out here, as the string-set: doesn't
pass W3C validation currently */
/*
.ears thead .left {
string-set: ears-top-left content();
}
.ears thead .center {
string-set: ears-top-center content();
}
.ears thead .right {
string-set: ears-top-right content();
}
.ears tfoot .left {
string-set: ears-bottom-left content();
}
.ears tfoot .center {
string-set: ears-bottom-center content();
}
.ears tfoot .right {
string-set: ears-bottom-right content();
}
*/
@page :first {
padding-top: 0;
@top-left {
content: normal;
border: none;
}
@top-center {
content: normal;
border: none;
}
@top-right {
content: normal;
border: none;
}
}
@page {
size: A4;
margin-bottom: 45mm;
padding-top: 20px;
/* The following is commented out here, but set appropriately by in code, as
the content depends on the document */
/*
@top-left {
content: 'Internet-Draft';
vertical-align: bottom;
border-bottom: solid 1px #ccc;
}
@top-left {
content: string(ears-top-left);
vertical-align: bottom;
border-bottom: solid 1px #ccc;
}
@top-center {
content: string(ears-top-center);
vertical-align: bottom;
border-bottom: solid 1px #ccc;
}
@top-right {
content: string(ears-top-right);
vertical-align: bottom;
border-bottom: solid 1px #ccc;
}
@bottom-left {
content: string(ears-bottom-left);
vertical-align: top;
border-top: solid 1px #ccc;
}
@bottom-center {
content: string(ears-bottom-center);
vertical-align: top;
border-top: solid 1px #ccc;
}
@bottom-right {
content: '[Page ' counter(page) ']';
vertical-align: top;
border-top: solid 1px #ccc;
}
*/
}
/* Changes introduced to fix issues found during implementation */
/* Make sure links are clickable even if overlapped by following H* */
a {
z-index: 2;
}
/* Separate body from document info even without intervening H1 */
section {
clear: both;
}
/* Top align author divs, to avoid names without organization dropping level with org names */
.author {
vertical-align: top;
}
/* Leave room in document info to show Internet-Draft on one line */
#identifiers dt {
width: 8em;
}
/* Don't waste quite as much whitespace between label and value in doc info */
#identifiers dd {
margin-left: 1em;
}
/* Give floating toc a background color (needed when it's a div inside section */
#toc {
background-color: white;
}
/* Make the collapsed ToC header render white on gray also when it's a link */
@media screen and (max-width: 1023px) {
#toc h2 a,
#toc h2 a:link,
#toc h2 a:focus,
#toc h2 a:hover,
#toc a.toplink,
#toc a.toplink:hover {
color: white;
background-color: #444;
text-decoration: none;
}
}
/* Give the bottom of the ToC some whitespace */
@media screen and (min-width: 1024px) {
#toc {
padding: 0 0 1em 1em;
}
}
/* Style section numbers with more space between number and title */
.section-number {
padding-right: 0.5em;
}
/* prevent monospace from becoming overly large */
tt, code, pre {
font-size: 95%;
}
/* Fix the height/width aspect for ascii art*/
.sourcecode pre,
.art-text pre {
line-height: 1.12;
}
/* Add styling for a link in the ToC that points to the top of the document */
a.toplink {
float: right;
margin-right: 0.5em;
}
/* Fix the dl styling to match the RFC 7992 attributes */
dl > dt,
dl.dlParallel > dt {
float: left;
margin-right: 1em;
}
dl.dlNewline > dt {
float: none;
}
/* Provide styling for table cell text alignment */
table td.text-left,
table th.text-left {
text-align: left;
}
table td.text-center,
table th.text-center {
text-align: center;
}
table td.text-right,
table th.text-right {
text-align: right;
}
/* Make the alternative author contact information look less like just another
author, and group it closer with the primary author contact information */
.alternative-contact {
margin: 0.5em 0 0.25em 0;
}
address .non-ascii {
margin: 0 0 0 2em;
}
/* With it being possible to set tables with alignment
left, center, and right, { width: 100%; } does not make sense */
table {
width: auto;
}
/* Avoid reference text that sits in a block with very wide left margin,
because of a long floating dt label.*/
.references dd {
overflow: visible;
}
/* Control caption placement */
caption {
caption-side: bottom;
}
/* Limit the width of the author address vcard, so names in right-to-left
script don't end up on the other side of the page. */
address.vcard {
max-width: 30em;
margin-right: auto;
}
/* For address alignment dependent on LTR or RTL scripts */
address div.left {
text-align: left;
}
address div.right {
text-align: right;
}
/* Provide table alignment support. We can't use the alignX classes above
since they do unwanted things with caption and other styling. */
table.right {
margin-left: auto;
margin-right: 0;
}
table.center {
margin-left: auto;
margin-right: auto;
}
table.left {
margin-left: 0;
margin-right: auto;
}
/* Give the table caption label the same styling as the figcaption */
caption a[href] {
color: #222;
}
@media print {
.toplink {
display: none;
}
/* avoid overwriting the top border line with the ToC header */
#toc {
padding-top: 1px;
}
/* Avoid page breaks inside dl and author address entries */
.vcard {
page-break-inside: avoid;
}
}
/* Tweak the bcp14 keyword presentation */
.bcp14 {
font-variant: small-caps;
font-weight: bold;
font-size: 0.9em;
}
/* Tweak the invisible space above H* in order not to overlay links in text above */
h2 {
margin-top: -18px; /* provide offset for in-page anchors */
padding-top: 31px;
}
h3 {
margin-top: -18px; /* provide offset for in-page anchors */
padding-top: 24px;
}
h4 {
margin-top: -18px; /* provide offset for in-page anchors */
padding-top: 24px;
}
/* Float artwork pilcrow to the right */
@media screen {
.artwork a.pilcrow {
display: block;
line-height: 0.7;
margin-top: 0.15em;
}
}
/* Make pilcrows on dd visible */
@media screen {
dd:hover > a.pilcrow {
visibility: visible;
}
}
/* Make the placement of figcaption match that of a table's caption
by removing the figure's added bottom margin */
.alignLeft.art-text,
.alignCenter.art-text,
.alignRight.art-text {
margin-bottom: 0;
}
.alignLeft,
.alignCenter,
.alignRight {
margin: 1em 0 0 0;
}
/* In print, the pilcrow won't show on hover, so prevent it from taking up space,
possibly even requiring a new line */
@media print {
a.pilcrow {
display: none;
}
}
/* Styling for the external metadata */
div#external-metadata {
background-color: #eee;
padding: 0.5em;
margin-bottom: 0.5em;
display: none;
}
div#internal-metadata {
padding: 0.5em; /* to match the external-metadata padding */
}
/* Styling for title RFC Number */
h1#rfcnum {
clear: both;
margin: 0 0 -1em;
padding: 1em 0 0 0;
}
/* Make .olPercent look the same as <ol><li> */
dl.olPercent > dd {
margin-bottom: 0.25em;
min-height: initial;
}
/* Give aside some styling to set it apart */
aside {
border-left: 1px solid #ddd;
margin: 1em 0 1em 2em;
padding: 0.2em 2em;
}
aside > dl,
aside > ol,
aside > ul,
aside > table,
aside > p {
margin-bottom: 0.5em;
}
/* Additional page break settings */
@media print {
figcaption, table caption {
page-break-before: avoid;
}
}
/* Font size adjustments for print */
@media print {
body { font-size: 10pt; line-height: normal; max-width: 96%; }
h1 { font-size: 1.72em; padding-top: 1.5em; } /* 1*1.2*1.2*1.2 */
h2 { font-size: 1.44em; padding-top: 1.5em; } /* 1*1.2*1.2 */
h3 { font-size: 1.2em; padding-top: 1.5em; } /* 1*1.2 */
h4 { font-size: 1em; padding-top: 1.5em; }
h5, h6 { font-size: 1em; margin: initial; padding: 0.5em 0 0.3em; }
}
/* Sourcecode margin in print, when there's no pilcrow */
@media print {
.artwork,
.artwork > pre,
.sourcecode {
margin-bottom: 1em;
}
}
/* Avoid narrow tables forcing too narrow table captions, which may render badly */
table {
min-width: 20em;
}
/* ol type a */
ol.type-a { list-style-type: lower-alpha; }
ol.type-A { list-style-type: upper-alpha; }
ol.type-i { list-style-type: lower-roman; }
ol.type-I { list-style-type: lower-roman; }
/* Apply the print table and row borders in general, on request from the RPC,
and increase the contrast between border and odd row background slightly */
table {
border: 1px solid #ddd;
}
td {
border-top: 1px solid #ddd;
}
tr {
break-inside: avoid;
}
tr:nth-child(2n+1) > td {
background-color: #f8f8f8;
}
/* Use style rules to govern display of the TOC. */
@media screen and (max-width: 1023px) {
#toc nav { display: none; }
#toc.active nav { display: block; }
}
/* Add support for keepWithNext */
.keepWithNext {
break-after: avoid-page;
break-after: avoid-page;
}
/* Add support for keepWithPrevious */
.keepWithPrevious {
break-before: avoid-page;
}
/* Change the approach to avoiding breaks inside artwork etc. */
figure, pre, table, .artwork, .sourcecode {
break-before: auto;
break-after: auto;
}
/* Avoid breaks between <dt> and <dd> */
dl {
break-before: auto;
break-inside: auto;
}
dt {
break-before: auto;
break-after: avoid-page;
}
dd {
break-before: avoid-page;
break-after: auto;
orphans: 3;
widows: 3
}
span.break, dd.break {
margin-bottom: 0;
min-height: 0;
break-before: auto;
break-inside: auto;
break-after: auto;
}
/* Undo break-before ToC */
@media print {
#toc {
break-before: auto;
}
}
/* Text in compact lists should not get extra bottom margin space,
since that would makes the list not compact */
ul.compact p, .ulCompact p,
ol.compact p, .olCompact p {
margin: 0;
}
/* But the list as a whole needs the extra space at the end */
section ul.compact,
section .ulCompact,
section ol.compact,
section .olCompact {
margin-bottom: 1em; /* same as p not within ul.compact etc. */
}
/* The tt and code background above interferes with for instance table cell
backgrounds. Changed to something a bit more selective. */
tt, code {
background-color: transparent;
}
p tt, p code, li tt, li code {
background-color: #f8f8f8;
}
/* Tweak the pre margin -- 0px doesn't come out well */
pre {
margin-top: 0.5px;
}
/* Tweak the compact list text */
ul.compact, .ulCompact,
ol.compact, .olCompact,
dl.compact, .dlCompact {
line-height: normal;
}
/* Don't add top margin for nested lists */
li > ul, li > ol, li > dl,
dd > ul, dd > ol, dd > dl,
dl > dd > dl {
margin-top: initial;
}
/* Elements that should not be rendered on the same line as a <dt> */
/* This should match the element list in writer.text.TextWriter.render_dl() */
dd > div.artwork:first-child,
dd > aside:first-child,
dd > figure:first-child,
dd > ol:first-child,
dd > div.sourcecode:first-child,
dd > table:first-child,
dd > ul:first-child {
clear: left;
}
/* fix for weird browser behaviour when <dd/> is empty */
dt+dd:empty::before{
content: "\00a0";
}
/* Make paragraph spacing inside <li> smaller than in body text, to fit better within the list */
li > p {
margin-bottom: 0.5em
}
/* Don't let p margin spill out from inside list items */
li > p:last-of-type:only-child {
margin-bottom: 0;
}
</style>
<link href="rfc-local.css" rel="stylesheet" type="text/css">
</head>
<body class="xml2rfc">
<script src="metadata.min.js"></script>
<table class="ears">
<thead><tr>
<td class="left"></td>
<td class="center">openid-federation-extended-listing</td>
<td class="right">August 2024</td>
</tr></thead>
<tfoot><tr>
<td class="left">De Marco, et al.</td>
<td class="center">Standards Track</td>
<td class="right">[Page]</td>
</tr></tfoot>
</table>
<div id="external-metadata" class="document-information"></div>
<div id="internal-metadata" class="document-information">
<dl id="identifiers">
<dt class="label-workgroup">Workgroup:</dt>
<dd class="workgroup">OpenID Connect A/B</dd>
<dt class="label-published">Published:</dt>
<dd class="published">
<time datetime="2024-08-02" class="published">2 August 2024</time>
</dd>
<dt class="label-authors">Authors:</dt>
<dd class="authors">
<div class="author">
<div class="author-name">G. De Marco</div>
<div class="org">Dipartimento per la trasformazione digitale</div>
</div>
<div class="author">
<div class="author-name">M. Fraser</div>
<div class="org">Raidiam</div>
</div>
<div class="author">
<div class="author-name">L. Jaromin</div>
<div class="org">Raidiam</div>
</div>
<div class="author">
<div class="author-name">M.B. Jones</div>
<div class="org">Self-Issued Consulting</div>
</div>
</dd>
</dl>
</div>
<h1 id="title">OpenID Federation Extended Subordinate Listing</h1>
<section id="section-abstract">
<h2 id="abstract"><a href="#abstract" class="selfRef">Abstract</a></h2>
<p id="section-abstract-1">This specification acts as an extension to the <span>[<a href="#OpenID.Federation" class="cite xref">OpenID.Federation</a>]</span>. It outlines methods to interact with a given Federation with a potentially large number of registered Entities, as well as mechanisms to retrieve multiple entity statements along with associated details in a single request.<a href="#section-abstract-1" class="pilcrow">¶</a></p>
</section>
<div id="toc">
<section id="section-toc.1">
<a href="#" onclick="scroll(0,0)" class="toplink">▲</a><h2 id="name-table-of-contents">
<a href="#name-table-of-contents" class="section-name selfRef">Table of Contents</a>
</h2>
<nav class="toc"><ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.1">
<p id="section-toc.1-1.1.1"><a href="#section-1" class="auto internal xref">1</a>. <a href="#name-introduction" class="internal xref">Introduction</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.1.2.1">
<p id="section-toc.1-1.1.2.1.1" class="keepWithNext"><a href="#section-1.1" class="auto internal xref">1.1</a>. <a href="#name-response-size" class="internal xref">Response Size</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.1.2.2">
<p id="section-toc.1-1.1.2.2.1" class="keepWithNext"><a href="#section-1.2" class="auto internal xref">1.2</a>. <a href="#name-bulk-retrieval" class="internal xref">Bulk Retrieval</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.1.2.3">
<p id="section-toc.1-1.1.2.3.1" class="keepWithNext"><a href="#section-1.3" class="auto internal xref">1.3</a>. <a href="#name-requirements-notation-and-c" class="internal xref">Requirements Notation and Conventions</a></p>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2">
<p id="section-toc.1-1.2.1"><a href="#section-2" class="auto internal xref">2</a>. <a href="#name-terminology" class="internal xref">Terminology</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.3">
<p id="section-toc.1-1.3.1"><a href="#section-3" class="auto internal xref">3</a>. <a href="#name-extended-subordinate-listin" class="internal xref">Extended Subordinate Listing Endpoint</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.3.2.1">
<p id="section-toc.1-1.3.2.1.1"><a href="#section-3.1" class="auto internal xref">3.1</a>. <a href="#name-extended-subordinate-listing" class="internal xref">Extended Subordinate Listing Request</a></p>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.4">
<p id="section-toc.1-1.4.1"><a href="#section-4" class="auto internal xref">4</a>. <a href="#name-extended-subordinate-listing-" class="internal xref">Extended Subordinate Listing Response</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.5">
<p id="section-toc.1-1.5.1"><a href="#section-5" class="auto internal xref">5</a>. <a href="#name-federation-entity-property" class="internal xref">Federation Entity Property</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.6">
<p id="section-toc.1-1.6.1"><a href="#section-6" class="auto internal xref">6</a>. <a href="#name-examples" class="internal xref">Examples</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.7">
<p id="section-toc.1-1.7.1"><a href="#section-7" class="auto internal xref">7</a>. <a href="#name-normative-references" class="internal xref">Normative References</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.8">
<p id="section-toc.1-1.8.1"><a href="#section-8" class="auto internal xref">8</a>. <a href="#name-informative-references" class="internal xref">Informative References</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.9">
<p id="section-toc.1-1.9.1"><a href="#appendix-A" class="auto internal xref">Appendix A</a>. <a href="#name-document-history" class="internal xref">Document History</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.10">
<p id="section-toc.1-1.10.1"><a href="#appendix-B" class="auto internal xref"></a><a href="#name-authors-addresses" class="internal xref">Authors' Addresses</a></p>
</li>
</ul>
</nav>
</section>
</div>
<div id="introduction">
<section id="section-1">
<h2 id="name-introduction">
<a href="#section-1" class="section-number selfRef">1. </a><a href="#name-introduction" class="section-name selfRef">Introduction</a>
</h2>
<p id="section-1-1">The extending listing endpoint has been created to address two outstanding issues identified in <span>[<a href="#OpenID.Federation" class="cite xref">OpenID.Federation</a>]</span>.<a href="#section-1-1" class="pilcrow">¶</a></p>
<div id="response-size">
<section id="section-1.1">
<h3 id="name-response-size">
<a href="#section-1.1" class="section-number selfRef">1.1. </a><a href="#name-response-size" class="section-name selfRef">Response Size</a>
</h3>
<p id="section-1.1-1">The standard <code>federation_list_endpoint</code> has limitations when entities are able to issue entity statements for an exceptionally large number of entities. Limitations can be encountered both when attempting to process receiving such a large response as well as more technical limitations such as response sizes of infrastructure. Pagination has been proposed as a solution for this.<a href="#section-1.1-1" class="pilcrow">¶</a></p>
</section>
</div>
<div id="bulk-retrieval">
<section id="section-1.2">
<h3 id="name-bulk-retrieval">
<a href="#section-1.2" class="section-number selfRef">1.2. </a><a href="#name-bulk-retrieval" class="section-name selfRef">Bulk Retrieval</a>
</h3>
<p id="section-1.2-1">For certain usecases, such as mass registration, consumers may encounter challenges when attempting to retrieve information on multiple entities. A flow with the standard <code>federation_list_endpoint</code> may involve a request to the list endpoint followed by a series of subsequent requests to retrieve an entity statement for each listed entity resulting in an N+1 operation. The extended listing endpoint seeks to solve this by providing a mechanism to include additional metadata for entities in the provided list.<a href="#section-1.2-1" class="pilcrow">¶</a></p>
</section>
</div>
<div id="requirements-notation-and-conventions">
<section id="section-1.3">
<h3 id="name-requirements-notation-and-c">
<a href="#section-1.3" class="section-number selfRef">1.3. </a><a href="#name-requirements-notation-and-c" class="section-name selfRef">Requirements Notation and Conventions</a>
</h3>
<p id="section-1.3-1">The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 <span>[<a href="#RFC2119" class="cite xref">RFC2119</a>]</span> <span>[<a href="#RFC8174" class="cite xref">RFC8174</a>]</span> when, and only when, they appear in all capitals, as shown here.<a href="#section-1.3-1" class="pilcrow">¶</a></p>
</section>
</div>
</section>
</div>
<div id="terminology">
<section id="section-2">
<h2 id="name-terminology">
<a href="#section-2" class="section-number selfRef">2. </a><a href="#name-terminology" class="section-name selfRef">Terminology</a>
</h2>
<p id="section-2-1">This specification uses the terms "Entity Identifier", "Subordinate Statement", "Trust Anchor", "Intermediate", "Federation Entity", "Entity", "federation_list_endpoint", and "Immediate Subordinate Entity" as defined in <span>[<a href="#OpenID.Federation" class="cite xref">OpenID.Federation</a>]</span>, "NumericDate" as defined in <span>[<a href="#RFC7591" class="cite xref">RFC7591</a>]</span>.<a href="#section-2-1" class="pilcrow">¶</a></p>
</section>
</div>
<div id="extended-subordinate-listing-endpoint">
<section id="section-3">
<h2 id="name-extended-subordinate-listin">
<a href="#section-3" class="section-number selfRef">3. </a><a href="#name-extended-subordinate-listin" class="section-name selfRef">Extended Subordinate Listing Endpoint</a>
</h2>
<p id="section-3-1">The extended subordinate listing endpoint is exposed by Federation Entities acting as a Trust Anchor or Intermediate. The endpoint lists the Immediate Subordinate Entities about which the Trust Anchor or Intermediate issues Subordinate Statements.<a href="#section-3-1" class="pilcrow">¶</a></p>
<p id="section-3-2">While similar to the <code>federation_list_endpoint</code>, the extended list endpoint provides pagination of the result, extensive details about Immediate Subordinate Entities, and flexibility in the definition of custom filters.<a href="#section-3-2" class="pilcrow">¶</a></p>
<p id="section-3-3">This endpoint is particularly valuable in scenarios where a federation contains one or more Intermediates that manage a large number of Immediate Subordinate Entities. To efficiently handle potentially large datasets, the endpoint incorporates pagination functionality. This allows clients to retrieve the data in manageable chunks.<a href="#section-3-3" class="pilcrow">¶</a></p>
<p id="section-3-4">By segmenting the data into pages, the endpoint facilitates the efficient transmission and processing of data and also adds to the client's ability to navigate through the information. As pagination enables consumers of this endpoint to retrieve a section of the larger superset of data, some form of ordering on the response MUST be established by the issuing entity. No recommendation is made on which key the ordering is based upon and is left up to the choice of implementing entities.<a href="#section-3-4" class="pilcrow">¶</a></p>
<p id="section-3-5">The selected pagination type offers a mix of consistency and performance characteristics appropriate for the intended use of the endpoint. The size of the dataset does not impact performance. Changes made to previously fetched pages do not affect the overall result consistency, while any changes in pages yet to be fetched will be reflected in the overall result list.<a href="#section-3-5" class="pilcrow">¶</a></p>
<p id="section-3-6">The endpoint is accessible via the <code>federation_extended_list_endpoint</code> URL, which is published in the <code>federation_metadata</code>.<a href="#section-3-6" class="pilcrow">¶</a></p>
<div id="extended-subordinate-listing-request">
<section id="section-3.1">
<h3 id="name-extended-subordinate-listing">
<a href="#section-3.1" class="section-number selfRef">3.1. </a><a href="#name-extended-subordinate-listing" class="section-name selfRef">Extended Subordinate Listing Request</a>
</h3>
<p id="section-3.1-1">This endpoint follows the same rules that are defined in the <code>federation_list_endpoint</code> regarding client authentication, HTTP methods used, and the way parameters are passed.<a href="#section-3.1-1" class="pilcrow">¶</a></p>
<p id="section-3.1-2">The endpoint accepts all parameters defined in the <code>federation_list_endpoint</code> in addition to the parameters defined in the table below.<a href="#section-3.1-2" class="pilcrow">¶</a></p>
<table class="center" id="table-1">
<caption><a href="#table-1" class="selfRef">Table 1</a></caption>
<thead>
<tr>
<th class="text-left" rowspan="1" colspan="1">
<strong>Parameter</strong>
</th>
<th class="text-left" rowspan="1" colspan="1">
<strong>Availability</strong>
</th>
<th class="text-left" rowspan="1" colspan="1">
<strong>Type</strong>
</th>
<th class="text-left" rowspan="1" colspan="1">
<strong>Value</strong>
</th>
</tr>
</thead>
<tbody>
<tr>
<td class="text-left" rowspan="1" colspan="1">from_entity_id</td>
<td class="text-left" rowspan="1" colspan="1">OPTIONAL</td>
<td class="text-left" rowspan="1" colspan="1">Entity Identifier</td>
<td class="text-left" rowspan="1" colspan="1">If this parameter is present, the resulting list MUST be the subset of the overall ordered response starting from the index of the entity referenced with this paramter. The list's size MUST NOT exceed the server's chosen upper limit.<br>
<br>
If the Entity Identifier that equals value of this parameter does not exist the HTTP status code 400 is returned and the content type <code>application/json</code> with the error code <code>entity_id_not_found</code>. TBD: Recommend client behavior on error.</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">limit</td>
<td class="text-left" rowspan="1" colspan="1">OPTIONAL</td>
<td class="text-left" rowspan="1" colspan="1">Positive Integer</td>
<td class="text-left" rowspan="1" colspan="1">Requested number of results included in the response.<br>
<br>
If this parameter is present, the number of results in the returned list must not be greater than the minimum of the server's upper limit and the value of this parameter.<br>
<br>
If this parameter is not present the server MUST fall back on the upper limit.</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">updated_after</td>
<td class="text-left" rowspan="1" colspan="1">OPTIONAL</td>
<td class="text-left" rowspan="1" colspan="1">NumericDate</td>
<td class="text-left" rowspan="1" colspan="2">Epoch time constraining the response to include only Entity identifiers with updates at or after this time. <br>
<br>
When absent, there is no cutoff for how long ago updates occurred to Entities being listed.<br>
<br>
When present the <code>registered</code>, <code>updated</code>, <code>revoked</code> MUST be included in the response unless the <code>audit_timestamps</code> parameter is set to <code>false</code>.</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">updated_before</td>
<td class="text-left" rowspan="1" colspan="1">OPTIONAL</td>
<td class="text-left" rowspan="1" colspan="1">NumericDate</td>
<td class="text-left" rowspan="1" colspan="2">Epoch time constraining the response to include only Entity identifiers with updates at or before this time.<br>
<br>
When absent, there is no cutoff before which updates occurred to listed Entities.<br>
<br>
When present the <code>registered</code>, <code>updated</code>, <code>revoked</code> MUST be included in the response unless the <code>audit_timestamps</code> parameter is set to <code>false</code>.</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">claims</td>
<td class="text-left" rowspan="1" colspan="1">OPTIONAL</td>
<td class="text-left" rowspan="1" colspan="1">Array</td>
<td class="text-left" rowspan="1" colspan="2">List of claims to be included in the response for each returned Immediate Subordinate Entity.<br>
<br>
If this parameter is NOT present or it is an empty array, the signed entity statement MUST be the only claim for each Immediate Subordinate Entity<br>
<br>
If this parameter is present and it is NOT an empty array each JSON object that represents the Immediate Subordinate Entity MUST include the requested claims for a subordinate entity statement if available.<br>
<br>
Entities that expose the extended subordinate listing endpoint MUST support all top level statement claims defined in <span>[<a href="#OpenID.Federation" class="cite xref">OpenID.Federation</a>]</span>. TBD: Support of requests for discrete entity metdata attributes.</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">audit_timestamps</td>
<td class="text-left" rowspan="1" colspan="1">OPTIONAL</td>
<td class="text-left" rowspan="1" colspan="1">Boolean</td>
<td class="text-left" rowspan="1" colspan="1">Request parameter to control presence of the <code>registered</code>, <code>updated</code>, <code>revoked</code> audit timestamps attributes for all returned Immediate Subordiates.<br>
<br>
If this parameter absent the audit timestamp attributes mentioned above MUST NOT be present unless <code>updated_after</code> and/or <code>updated_before</code> parameters are present.<br>
<br>
If this parameter is present and set to <code>true</code> the response MUST include the above mentioned audit timestamp attributes for each Immediate Subordinate Entity included in the response.<br>
<br>
If this parameter is present and set to <code>false</code> the response MUST NOT include the above mentioned audit timestamp attributes for each Immediate Subordinate Entity included in the response. even irrespective whether the <code>updated_after</code> and/or <code>updated_before</code> request parameters are pressent.<br>
<br>
</td>
</tr>
</tbody>
</table>
<p id="section-3.1-4"><em>Table 1: Additional request parameters accepted by the extended subordinate listing endpoint in addition to the those speficied by the <code>federation_list_endpoint</code></em><a href="#section-3.1-4" class="pilcrow">¶</a></p>
<p id="section-3.1-5">Below are non-normative examples of an HTTP GET request to the federation extended list endpoint:<a href="#section-3.1-5" class="pilcrow">¶</a></p>
<div class="alignLeft art-text artwork" id="section-3.1-6">
<pre>GET /list_extended HTTP/1.1
Host: trust-anchor.star-federation.example.net
</pre><a href="#section-3.1-6" class="pilcrow">¶</a>
</div>
<p id="section-3.1-7"><em>Figure 1: Initial request without parameters to list immediate subordinates. Typically an initial request.</em><a href="#section-3.1-7" class="pilcrow">¶</a></p>
<div class="alignLeft art-text artwork" id="section-3.1-8">
<pre>GET /list_extended?from_entity_id=https://rp0.example.net/oidc/rp HTTP/1.1
Host: trust-anchor.star-federation.example.net
</pre><a href="#section-3.1-8" class="pilcrow">¶</a>
</div>
<p id="section-3.1-9"><em>Figure 2: Request with <code>from_entity_id</code> parameter to list immediate subordinate contained in a subseqent page.</em><a href="#section-3.1-9" class="pilcrow">¶</a></p>
<div class="alignLeft art-text artwork" id="section-3.1-10">
<pre>GET /list_extended?updated_after=946681201&entity_type=openid_relying_party HTTP/1.1
Host: trust-anchor.star-federation.example.net
</pre><a href="#section-3.1-10" class="pilcrow">¶</a>
</div>
<p id="section-3.1-11"><em>Figure 3: Request to list entities of a certain type and updated since certain point in time.</em><a href="#section-3.1-11" class="pilcrow">¶</a></p>
<div class="alignLeft art-text artwork" id="section-3.1-12">
<pre>GET /list_extended?claims=trust_marks HTTP/1.1
Host: trust-anchor.star-federation.example.net
</pre><a href="#section-3.1-12" class="pilcrow">¶</a>
</div>
<p id="section-3.1-13"><em>Figure 4: Request to list all entities and only include trust marks in the response.</em><a href="#section-3.1-13" class="pilcrow">¶</a></p>
</section>
</div>
</section>
</div>
<div id="extended-subordinate-listing-response">
<section id="section-4">
<h2 id="name-extended-subordinate-listing-">
<a href="#section-4" class="section-number selfRef">4. </a><a href="#name-extended-subordinate-listing-" class="section-name selfRef">Extended Subordinate Listing Response</a>
</h2>
<p id="section-4-1">A successful response MUST use the HTTP status code 200 with the content type <code>application/json</code>. The response body is a JSON object containing data specified in the table below.<a href="#section-4-1" class="pilcrow">¶</a></p>
<table class="center" id="table-2">
<caption><a href="#table-2" class="selfRef">Table 2: Top-level attributes included in the subordinate JSON object returned in the response body</a></caption>
<thead>
<tr>
<th class="text-left" rowspan="1" colspan="1">
<strong>Attribute</strong>
</th>
<th class="text-left" rowspan="1" colspan="1">
<strong>Availability</strong>
</th>
<th class="text-left" rowspan="1" colspan="1">
<strong>Type</strong>
</th>
<th class="text-left" rowspan="1" colspan="1">
<strong>Value</strong>
</th>
</tr>
</thead>
<tbody>
<tr>
<td class="text-left" rowspan="1" colspan="1">immediate_subordinate_entities</td>
<td class="text-left" rowspan="1" colspan="1">REQUIRED</td>
<td class="text-left" rowspan="1" colspan="1">Array</td>
<td class="text-left" rowspan="1" colspan="1">Array of JSON objects, each describing an Immediate Subordinate Entity using the structure defined in the table below</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">next_entity_id</td>
<td class="text-left" rowspan="1" colspan="1">OPTIONAL</td>
<td class="text-left" rowspan="1" colspan="1">Entity Identifier</td>
<td class="text-left" rowspan="1" colspan="1">Entity Identifier for the next element in the result list where the next page begins. This attribute is mandatory when additional results are available beyond those included in the returned <code>immediate_subordinate_entities</code> array.</td>
</tr>
</tbody>
</table>
<p id="section-4-4">Each JSON object in the returned <code>immediate_subordinate_entities</code> array MAY contain attributes from the sets defined for Entity Statements and Metadata in <span>[<a href="#OpenID.Federation" class="cite xref">OpenID.Federation</a>]</span> as well as those defined in the table below.<a href="#section-4-4" class="pilcrow">¶</a></p>
<table class="center" id="table-3">
<caption><a href="#table-3" class="selfRef">Table 3: Structure of the Immediate Entity JSON object in the <code>immediate_subordinate_entities</code> array</a></caption>
<thead>
<tr>
<th class="text-left" rowspan="1" colspan="1">
<strong>Attribute</strong>
</th>
<th class="text-left" rowspan="1" colspan="1">
<strong>Availability</strong>
</th>
<th class="text-left" rowspan="1" colspan="1">
<strong>Type</strong>
</th>
<th class="text-left" rowspan="1" colspan="1">
<strong>Value</strong>
</th>
</tr>
</thead>
<tbody>
<tr>
<td class="text-left" rowspan="1" colspan="1">id</td>
<td class="text-left" rowspan="1" colspan="1">REQUIRED</td>
<td class="text-left" rowspan="1" colspan="1">Entity Identifier</td>
<td class="text-left" rowspan="1" colspan="1">Entity Identifier for the subject entity of the current record.</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">entity_statement</td>
<td class="text-left" rowspan="1" colspan="1">OPTIONAL</td>
<td class="text-left" rowspan="1" colspan="1">String</td>
<td class="text-left" rowspan="1" colspan="1">Signed entity statement for the subordinate entity as issued by the entity that exposes the extended subordinate listing endpoint.<br>
<br>
This <code>entity_statement</code> attribute MUST be returned if the <code>claims</code> parameter is NOT present in the request or it is present but the array is empty.<br>
<br>
This <code>entity_statement</code> attribute MUST NOT be returned if the <code>claims</code> parameter is NOT present in the request or it is present but the array is empty.</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">trust_marks, metadata, and/or other selected statement claims</td>
<td class="text-left" rowspan="1" colspan="1">OPTIONAL</td>
<td class="text-left" rowspan="1" colspan="1">N/A</td>
<td class="text-left" rowspan="1" colspan="1">Selected Immediate Subrodianate claims as requested with the <code>claims</code> request attribute. <br>
<br>
These attributes MUST NOT be returned if the <code>claims</code> parameter is NOT present in the request or it is present but the array is empty.</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">registered</td>
<td class="text-left" rowspan="1" colspan="1">OPTIONAL</td>
<td class="text-left" rowspan="1" colspan="1">Number</td>
<td class="text-left" rowspan="1" colspan="1">Time when the Entity was registered with the issuing party using NumericDate format.</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">updated</td>
<td class="text-left" rowspan="1" colspan="1">OPTIONAL</td>
<td class="text-left" rowspan="1" colspan="1">Number</td>
<td class="text-left" rowspan="1" colspan="1">Time when the Entity was updated using the time format defined for the <code>iat</code> claim in <span>[<a href="#RFC7519" class="cite xref">RFC7519</a>]</span>. This parameter may indicate that the Federation Entity Keys or metadatapolicies or constraints about this Entity was updated.</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">revoked</td>
<td class="text-left" rowspan="1" colspan="1">OPTIONAL</td>
<td class="text-left" rowspan="1" colspan="1">Number</td>
<td class="text-left" rowspan="1" colspan="1">Time when the Entity was revoked using the time format defined for the <code>iat</code> claim in <span>[<a href="#RFC7519" class="cite xref">RFC7519</a>]</span>.</td>
</tr>
</tbody>
</table>
<p id="section-4-7">The following are non-normative examples of a JSON response from the Federation Extended List Endpoint:<a href="#section-4-7" class="pilcrow">¶</a></p>
<div class="alignLeft art-text artwork" id="section-4-8">
<pre>GET /list_extended HTTP/1.1
200 OK
Content-Type: application/json
{
"immediate_subordinate_entities": [
{
"id": "https://rp0.example.net/oidc/rp",
"entity_statement": "eyJ0eXAiOiJlbnRpdHktc3RhdGVtZW50K2p3dCIsImFsZyI6IlJTMjU2Iiwia2lkIjoiQlh2ZnJ..."
},
{
"id": "https://rp0.example.net/oidc/rp",
"entity_statement": "eyH1eZUkOgKlbnRpdHktc4RhdGVtZW50K2p3dCIsImFsZyI6IlJTMjU4Iiwia2lkIjoiQlh2ZnJ..."
}
]
}
</pre><a href="#section-4-8" class="pilcrow">¶</a>
</div>
<p id="section-4-9"><em>Figure 5: Example extended list endpoint response that includes entity statements.</em><a href="#section-4-9" class="pilcrow">¶</a></p>
<div class="alignLeft art-text artwork" id="section-4-10">
<pre>GET /list_extended?audit_timestamps=true&claims=entity_statement HTTP/1.1
200 OK
Content-Type: application/json
{
"immediate_subordinate_entities": [
{
"id": "https://rp0.example.net/oidc/rp",
"entity_statement": "eyH1eZUkOgKlbnRpdHktc4RhdGVtZW50K2p3dCIsImFsZyI6IlJTMjU4Iiwia2lkIjoiQlh2ZnJ...",
"registered":1704217689,
"updated":1704217789,
"revoked":1704217800
},
]
}
</pre><a href="#section-4-10" class="pilcrow">¶</a>
</div>
<p id="section-4-11"><em>Figure 6: Example extended list endpoint response that includes an entity statement and audit timestampts</em><a href="#section-4-11" class="pilcrow">¶</a></p>
<div class="alignLeft art-text artwork" id="section-4-12">
<pre>GET /list_extended?claims=entity_statement,trust_marks HTTP/1.1
200 OK
Content-Type: application/json
{
"immediate_subordinate_entities": [
{
"id": "https://rp1.example.net/oidc/rp",
"trust_marks": [
{
"id": "https://www.spid.gov.it/certification/rp",
"entity_statement": "eyH1eZUkOgKlbnRpdHktc4RhdGVtZW50K2p3dCIsImFsZyI6IlJTMjU4Iiwia2lkIjoiQlh2ZnJ...",
"trust_mark": "eyJraWQiOiJmdWtDdUtTS3hwWWJjN09lZUk3Ynlya3N5a0E1bDhP..."
}
]
}
]
}
</pre><a href="#section-4-12" class="pilcrow">¶</a>
</div>
<p id="section-4-13"><em>Figure 7: Example extended list endpoint response that includes entity statements and trust marks</em><a href="#section-4-13" class="pilcrow">¶</a></p>
</section>
</div>
<div id="federation-entity-property">
<section id="section-5">
<h2 id="name-federation-entity-property">
<a href="#section-5" class="section-number selfRef">5. </a><a href="#name-federation-entity-property" class="section-name selfRef">Federation Entity Property</a>
</h2>
<p id="section-5-1">In order for entities to advertise the new endpoint, a new property has been defined adding to the existing set of Federation Entity Metadata as defined in <span>[<a href="#OpenID.Federation" class="cite xref">OpenID.Federation</a>]</span>.<a href="#section-5-1" class="pilcrow">¶</a></p>
<table class="center" id="table-4">
<thead>
<tr>
<th class="text-left" rowspan="1" colspan="1">
<strong>Metadata</strong>
</th>
<th class="text-left" rowspan="1" colspan="1">
<strong>Availability</strong>
</th>
<th class="text-left" rowspan="1" colspan="1">
<strong>Description</strong>
</th>
</tr>
</thead>
<tbody>
<tr>
<td class="text-left" rowspan="1" colspan="1">federation_extended_list_endpoint</td>
<td class="text-left" rowspan="1" colspan="1">OPTIONAL</td>
<td class="text-left" rowspan="1" colspan="1">The extended list endpoint as described above. All constraints and restrictions on the listing of this endpoint are identical to that defined for the <code>federation_list_endpoint</code> as defined in OpenID Federation 1.0</td>
</tr>
</tbody>
</table>
</section>
</div>
<div id="examples">
<section id="section-6">
<h2 id="name-examples">
<a href="#section-6" class="section-number selfRef">6. </a><a href="#name-examples" class="section-name selfRef">Examples</a>
</h2>
<p id="section-6-1">This section contains non-normative examples that demonstrate how to use the Extended Subordinates Listing Endpoint to retrieve subsets of subordinates.<a href="#section-6-1" class="pilcrow">¶</a></p>
<div class="alignLeft art-text artwork" id="section-6-2">
<pre>GET /list_extended HTTP/1.1
200 OK
Content-Type: application/json
{
"immediate_subordinate_entities": [
{
"id": "https://0.example.net/",
"entity_statement": "eyJ0eXAiOiJlbnRpdHktc3RhdGVtZW50K2p3dCIsImFsZyI6IlJTMjU2Iiwia2lkIjoiQlh2ZnJ..."
},
{
"id": "https://1.example.net/",
"entity_statement": "eyH1eZUkOgKlbnRpdHktc4RhdGVtZW50K2p3dCIsImFsZyI6IlJTMjU4Iiwia2lkIjoiQlh2ZnJ..."
},
...
{
"id": "https://999.example.net/",
"entity_statement": "eyK2aKUkOgKlbnRpdHktc4RhdGVtZW50K2p3dCIsImFsZyI6IlJTMjU4Iiwia2lkIjoiQlh2ZnJ..."
}
],
"next_entity_id": "https://1000.example.net/"
}
</pre><a href="#section-6-2" class="pilcrow">¶</a>
</div>
<p id="section-6-3"><em>Figure 8: A Trust Anchor returns the results list consisting of thousand immediate entities, along with the next entity id that the next page starts with, in response to the request to list all immediate subordinates.</em><a href="#section-6-3" class="pilcrow">¶</a></p>
<div class="alignLeft art-text artwork" id="section-6-4">
<pre>GET /list_extended?from_entity_id=https://1000.example.net/ HTTP/1.1
200 OK
Content-Type: application/json
{
"immediate_subordinate_entities": [
{
"id": "https://1000.example.net/",
"entity_statement": "eyK2aKUkOgKlbnRpdHktc4RhdGVtZW50K2p3dCIsImFsZyI6IlJTMjU4Iiwia2lkIjoiQlh2ZnJ..."
},
{
"id": "https://1001.example.net/",
"entity_statement": "eyH4aKUkOgKlbnRpdHktc4RhdGVtZW50K2p3dCIsImFsZyI6IlJTMjU4Iiwia2lkIjoiQlh2ZnJ..."
},
{
"id": "https://1003.example.net/",
"entity_statement": "eyW9aKUkOgKlbnRpdHktc4RhdGVtZW50K2p3dCIsImFsZyI6IlJTMjU4Iiwia2lkIjoiQlh2ZnJ..."
}
]
}
</pre><a href="#section-6-4" class="pilcrow">¶</a>
</div>
<p id="section-6-5"><em>Figure 9: A Trust Anchor returns all entities starting from the entity provided as a parameter.</em><a href="#section-6-5" class="pilcrow">¶</a></p>
<div class="alignLeft art-text artwork" id="section-6-6">
<pre>GET /list_extended?updated_after=946681201&entity_type=openid_relying_party&audit_timestamps=true HTTP/1.1
200 OK
Content-Type: application/json
{
"immediate_subordinate_entities": [
{
"id": "https://123.example.net/",
"entity_statement": "eyJ0eXAiOiJlbnRpdHktc3RhdGVtZW50K2p3dCIsImFsZyI6IlJTMjU2Iiwia2lkIjoiQlh2ZnJ...",
"registered": 1704217689,
"updated": 1704217789,
"revoked": 1704217800
},
{
"id": "https://323.example.net/",
"entity_statement": "eyW9aKUkOgKlbnRpdHktc4RhdGVtZW50K2p3dCIsImFsZyI6IlJTMjU4Iiwia2lkIjoiQlh2ZnJ...",
"registered": 1704217689,
"updated": 1704217789,
"revoked": 1704217800
},
...
{
"id": "https://342.example.net/",
"entity_statement": "eyK2aKUkOgKlbnRpdHktc4RhdGVtZW50K2p3dCIsImFsZyI6IlJTMjU4Iiwia2lkIjoiQlh2ZnJ...",
"registered": 1704217689,
"updated": 1704217789,
"revoked": 1704217800
}
],
"next_entity_id": "https://736.example.net/"
}
</pre><a href="#section-6-6" class="pilcrow">¶</a>
</div>
<p id="section-6-7"><em>Figure 10: Get list of immediate subordiates updated after certain moment in time. The response contains more than one page.</em><a href="#section-6-7" class="pilcrow">¶</a></p>
</section>
</div>
<section id="section-7">
<h2 id="name-normative-references">
<a href="#section-7" class="section-number selfRef">7. </a><a href="#name-normative-references" class="section-name selfRef">Normative References</a>
</h2>
<dl class="references">
<dt id="RFC2119">[RFC2119]</dt>
<dd>
<span class="refAuthor">Bradner, S.</span>, <span class="refTitle">"Key words for use in RFCs to Indicate Requirement Levels"</span>, <span class="seriesInfo">BCP 14</span>, <span class="seriesInfo">RFC 2119</span>, <span class="seriesInfo">DOI 10.17487/RFC2119</span>, <time datetime="1997-03" class="refDate">March 1997</time>, <span><<a href="https://www.rfc-editor.org/info/rfc2119">https://www.rfc-editor.org/info/rfc2119</a>></span>. </dd>
<dd class="break"></dd>
<dt id="RFC7519">[RFC7519]</dt>
<dd>
<span class="refAuthor">Jones, M.</span>, <span class="refAuthor">Bradley, J.</span>, and <span class="refAuthor">N. Sakimura</span>, <span class="refTitle">"JSON Web Token (JWT)"</span>, <span class="seriesInfo">RFC 7519</span>, <span class="seriesInfo">DOI 10.17487/RFC7519</span>, <time datetime="2015-05" class="refDate">May 2015</time>, <span><<a href="https://www.rfc-editor.org/info/rfc7519">https://www.rfc-editor.org/info/rfc7519</a>></span>. </dd>
<dd class="break"></dd>
<dt id="RFC7591">[RFC7591]</dt>
<dd>
<span class="refAuthor">Richer, J., Ed.</span>, <span class="refAuthor">Jones, M.</span>, <span class="refAuthor">Bradley, J.</span>, <span class="refAuthor">Machulak, M.</span>, and <span class="refAuthor">P. Hunt</span>, <span class="refTitle">"OAuth 2.0 Dynamic Client Registration Protocol"</span>, <span class="seriesInfo">RFC 7591</span>, <span class="seriesInfo">DOI 10.17487/RFC7591</span>, <time datetime="2015-07" class="refDate">July 2015</time>, <span><<a href="https://www.rfc-editor.org/info/rfc7591">https://www.rfc-editor.org/info/rfc7591</a>></span>. </dd>
<dd class="break"></dd>
<dt id="RFC8174">[RFC8174]</dt>
<dd>
<span class="refAuthor">Leiba, B.</span>, <span class="refTitle">"Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words"</span>, <span class="seriesInfo">BCP 14</span>, <span class="seriesInfo">RFC 8174</span>, <span class="seriesInfo">DOI 10.17487/RFC8174</span>, <time datetime="2017-05" class="refDate">May 2017</time>, <span><<a href="https://www.rfc-editor.org/info/rfc8174">https://www.rfc-editor.org/info/rfc8174</a>></span>. </dd>
<dd class="break"></dd>
</dl>
</section>
<section id="section-8">
<h2 id="name-informative-references">
<a href="#section-8" class="section-number selfRef">8. </a><a href="#name-informative-references" class="section-name selfRef">Informative References</a>
</h2>
<dl class="references">
<dt id="OpenID.Federation">[OpenID.Federation]</dt>
<dd>
<span class="refAuthor">Ed., R. H.</span>, <span class="refAuthor">Jones, M. B.</span>, <span class="refAuthor">Solberg, A.</span>, <span class="refAuthor">Bradley, J.</span>, <span class="refAuthor">Marco, G. D.</span>, and <span class="refAuthor">V. Dzhuvinov</span>, <span class="refTitle">"OpenID Federation 1.0"</span>, <time datetime="2024-05-31" class="refDate">31 May 2024</time>, <span><<a href="https://openid.net/specs/openid-federation-1_0.html">https://openid.net/specs/openid-federation-1_0.html</a>></span>. </dd>
<dd class="break"></dd>
</dl>
</section>
<div id="document-history">
<section id="appendix-A">
<h2 id="name-document-history">
<a href="#appendix-A" class="section-number selfRef">Appendix A. </a><a href="#name-document-history" class="section-name selfRef">Document History</a>
</h2>
<p id="appendix-A-1">[[ To be removed from the final specification ]]<a href="#appendix-A-1" class="pilcrow">¶</a></p>
<p id="appendix-A-2">-00<a href="#appendix-A-2" class="pilcrow">¶</a></p>
<ul class="compact">
<li class="compact" id="appendix-A-3.1">Initial version<a href="#appendix-A-3.1" class="pilcrow">¶</a>
</li>
</ul>
</section>
</div>
<div id="authors-addresses">
<section id="appendix-B">
<h2 id="name-authors-addresses">
<a href="#name-authors-addresses" class="section-name selfRef">Authors' Addresses</a>
</h2>
<address class="vcard">
<div dir="auto" class="left"><span class="fn nameRole">Giuseppe De Marco</span></div>
<div dir="auto" class="left"><span class="org">Dipartimento per la trasformazione digitale</span></div>
<div class="email">
<span>Email:</span>
<a href="mailto:gi.demarco@innovazione.gov.it" class="email">gi.demarco@innovazione.gov.it</a>
</div>
</address>
<address class="vcard">
<div dir="auto" class="left"><span class="fn nameRole">Michael Fraser</span></div>
<div dir="auto" class="left"><span class="org">Raidiam</span></div>
<div class="email">
<span>Email:</span>
<a href="mailto:michael.fraser@raidiam.com" class="email">michael.fraser@raidiam.com</a>
</div>
</address>
<address class="vcard">
<div dir="auto" class="left"><span class="fn nameRole">Lukasz Jaromin</span></div>
<div dir="auto" class="left"><span class="org">Raidiam</span></div>
<div class="email">
<span>Email:</span>
<a href="mailto:lukasz.jaromin@raidiam.com" class="email">lukasz.jaromin@raidiam.com</a>
</div>
</address>
<address class="vcard">
<div dir="auto" class="left"><span class="fn nameRole">Michael B. Jones</span></div>
<div dir="auto" class="left"><span class="org">Self-Issued Consulting</span></div>
<div class="email">
<span>Email:</span>
<a href="mailto:michael_b_jones@hotmail.com" class="email">michael_b_jones@hotmail.com</a>
</div>
</address>
</section>
</div>
<script>const toc = document.getElementById("toc");
toc.querySelector("h2").addEventListener("click", e => {
toc.classList.toggle("active");
});
toc.querySelector("nav").addEventListener("click", e => {
toc.classList.remove("active");
});
</script>
</body>
</html>