{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Namespace:","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}},{"type":"strong"}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]},{"text":"urn:mace:shibboleth:2.0:metadata","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":"Schema:","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}},{"type":"strong"}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}}]},{"text":"http://shibboleth.net/schema/idp/shibboleth-metadata.xsd","type":"text","marks":[{"type":"textColor","attrs":{"color":"#222222"}},{"type":"link","attrs":{"href":"http://shibboleth.net/schema/idp/shibboleth-metadata.xsd"}}]}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"minLevel":{"value":"1"},"maxLevel":{"value":"3"}},"macroMetadata":{"macroId":{"value":"5c466cedc54abdf5400a3d2262b7c083"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"2a8e26d1-7328-47a0-ad0b-c5891292eb69"}},{"type":"heading","attrs":{"level":2},"content":[{"text":"Overview","type":"text"}]},{"type":"expand","attrs":{"title":"V4.0"},"content":[{"type":"paragraph","content":[{"text":"The ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]},{"text":"EntityRoleWhiteList","type":"text","marks":[{"type":"code"}]},{"text":" filter removes unwanted role descriptors from entity metadata. Depending on the size and composition of the input, metadata filtered in this way may have a significantly reduced memory footprint.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]}]},{"type":"expand","attrs":{"title":"V4.1+"},"content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"EntityRole","type":"text","marks":[{"type":"code"}]},{"text":" filter removes unwanted role descriptors from entity metadata. Depending on the size and composition of the input, metadata filtered in this way may have a significantly reduced memory footprint.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"For example, suppose an IdP loads (and reloads) metadata from a remote HTTP source using a ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]},{"text":"FileBackedHTTPMetadataProvider","type":"text","marks":[{"type":"link","attrs":{"href":"https://shibboleth.atlassian.net/wiki/spaces/IDP4/pages/1265631639"}}]},{"text":". Since the IdP is focused on the ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" elements in the metadata aggregate, all other role descriptors may be removed. See below for an ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]},{"text":"explicit example","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}},{"type":"link","attrs":{"href":"#EntityRoleFilter-Examples"}}]},{"text":".","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Filter order is important!","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"This filter changes the content of the metadata and so a filter of this type should appear after any ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://shibboleth.atlassian.net/wiki/spaces/IDP4/pages/1265631654"}},{"text":" in the overall sequence of filters.","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Reference","type":"text"}]},{"type":"expand","attrs":{"title":"XML Attributes"},"content":[{"type":"table","attrs":{"layout":"full-width","localId":"ec43379c-cd23-4d48-8e53-fa06fd114c5a"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[267.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[102.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[85.0]},"content":[{"type":"paragraph","content":[{"text":"Default","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[747.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[267.0]},"content":[{"type":"paragraph","content":[{"text":"removeRolelessEntityDescriptors","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[102.0]},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[85.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[747.0]},"content":[{"type":"paragraph","content":[{"text":"Controls whether to keep entity descriptors that contain no roles. Note: If false, the resulting output may not be schema-valid since an ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" element must include at least one role descriptor child element.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[267.0]},"content":[{"type":"paragraph","content":[{"text":"removeEmptyEntitiesDescriptors","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[102.0]},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[85.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[747.0]},"content":[{"type":"paragraph","content":[{"text":"Controls whether to keep entities descriptors that contain no entity descriptors. Note: If false, the resulting output may not be schema-valid since an ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" element must include at least one child element.","type":"text"}]}]}]}]},{"type":"paragraph"},{"type":"panel","attrs":{"panelType":"error"},"content":[{"type":"paragraph","content":[{"text":"Affiliation descriptors are removed by default","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"An ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" element that contains an ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" child element is handled the same way as an ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" element that contains no role descriptors. That is, if ","type":"text"},{"text":"removeRolelessEntityDescriptors","type":"text","marks":[{"type":"code"}]},{"text":" is true, both are filtered from the input.","type":"text"}]}]}]},{"type":"expand","attrs":{"title":"XML Elements"},"content":[{"type":"table","attrs":{"layout":"default","localId":"4ca33c50-a74e-4e53-b2e2-d27ce7f02f64"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[105.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[100.0]},"content":[{"type":"paragraph","content":[{"text":"Cardinality","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[675.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[105.0]},"content":[{"type":"paragraph","content":[{"text":"","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[100.0]},"content":[{"type":"paragraph","content":[{"text":"0 or more","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[675.0]},"content":[{"type":"paragraph","content":[{"text":"The textual content is the XML QName of the role to be retained.","type":"text"}]},{"type":"paragraph","content":[{"text":"Note that property replacement cannot be used on this element.","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"error"},"content":[{"type":"paragraph","content":[{"text":"Don't forget to configure a child element","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"If you forget to configure a ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" child element, the filter will retain no roles; that is, an empty ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" element of this type will remove all roles (and therefore all entities) from the input. This is probably not what you want.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Examples","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]},{"type":"paragraph","content":[{"text":"The following example retains all ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" elements in the input:","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]},{"type":"expand","attrs":{"title":"V4.0"},"content":[{"type":"heading","attrs":{"level":5},"content":[{"text":"Retain SP roles unsafe-only","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n md:SPSSODescriptor\n","type":"text"}]}]},{"type":"expand","attrs":{"title":"V4.1+"},"content":[{"type":"heading","attrs":{"level":5},"content":[{"text":"Retain SP roles unsafe-only","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n md:SPSSODescriptor\n","type":"text"}]}]},{"type":"paragraph","content":[{"text":"If a particular entity in the input contains no","type":"text"},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" child element, all role descriptors are removed from the entity. If the value of the ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]},{"text":"removeRolelessEntityDescriptors","type":"text","marks":[{"type":"code"}]},{"text":" attribute is true (which it is by default), the entity itself is removed as well.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]},{"type":"paragraph","content":[{"text":"If the value of the ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]},{"text":"removeEmptyEntitiesDescriptors","type":"text","marks":[{"type":"code"}]},{"text":" attribute is true (which it is by default), any ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" element that contains neither an ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" element nor an ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" element is removed as well.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]}],"version":1}

Browser not supported