Version history
| Version | Date | Notes |
|---|---|---|
| 0.1 | 2025-Q1 | First pilot draft |
| 0.2 | 2026-02-05 | Explicit target handling added Support for relative target paths Improved validation of link map login URLs |
| 0.3 | 2026-03-01 | IntroducedIdP Discovery Metadata feed. Refactored document structure for consistency and clarity. |
| 0.3.1 | 2026-03-09 | Updating JSON schemas to version |
| Table of Contents | ||
|---|---|---|
|
...
link_mappingREQUIRED (object)- A mapping where each IdP’s entity ID is used as a key, and the value is the specific login URL for that IdP.
- Example:
Code Block language js "link_mapping": { "https://idp.example1.com": "https://example.com/bjj/login?idp=example1-idp", "https://idp.example2.com": "https://example.com/bjj/login?idp=example2-idp", "https://idp.example3.com": "https://example.com/bjj/login?idp=example3-idp" },
Example metadata
| Code Block | ||
|---|---|---|
| ||
[
{
"organization_info": {
"description": "An example description of the service provider organization",
"display_name": "Example Service Provider",
"logotype": "https://example.com/logo.svg",
"name": "Example Service Provider AB",
"url": "https://example.com"
},
"sso_links": [
{
"description": "Example Digital Math Service is the number one digital math companion in Schengen",
"disabled": false,
"display_name": "Math Rocket",
"entity_id": "https://example.com/math",
"idp_parameter": "entityID",
"logo": "https://example.com/math/logo.svg",
"sp_init": "https://example.com/math/Shibboleth.sso/Login?",
"sso_type": "entity_id",
"target_parameter": "Target",
"target_value": "https://example.com/math/resource"
},
{
"description": "Example Digital Brazilian Jiu-Jitsu Service is the number one digital BJJ teacher in Schengen",
"disabled": false,
"display_name": "Example Digital Brazilian Jiu-Jitsu Service",
"entity_id": "https://example.com/bjj",
"link_mapping": {
"https://idp.example1.com": "https://example.com/bjj/login?idp=example1-idp",
"https://idp.example2.com": "https://example.com/bjj/login?idp=example2-idp",
"https://idp.example3.com": "https://example.com/bjj/login?idp=example3-idp"
},
"logo": "https://example.com/bjj/logo.png",
"sso_type": "link_map"
}
]
}
] |
JSON schema
JSON schema for validating SP SSO links metadata:The SSO links metadata MUST validate against the JSON schema found at https://fed.skolfederation.se/pilot/schemas/sso-links-metadata-schema-0_1.json.
| Code Block | ||
|---|---|---|
| ||
{
"$schema": "httphttps://json-schema.org/draft/2020-0712/schema#schema",
"type$id": "array",
"https://fed.skolfederation.se/pilot/schemas/sso-links-metadata-schema-0_1.json",
"title": "Skolfederation SSO Links Metadata",
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"properties": {
"organization_info": {
"type": "object",
"properties": {
"description": {
"type": "string" },
"display_nameminLength": { "type": "string" 1
},
"logotypedisplay_name": { "type": "string", "format": "uri" },
"name": { "type": "string" },
"url": { "typeminLength": "string", "format": "uri" }
1
},
"requiredlogotype": ["description", "display_name", "logotype", "name", "url"] {
"type": "string",
"additionalPropertiesformat": false"uri",
},
"sso_linkspattern": {"^https://"
"type": "array" },
"itemsname": {
"type": "objectstring",
"propertiesminLength": {1
"description": { "type": "string" },
"disabledurl": { "type": "boolean" },
"display_name": { "type": "string" },
"entity_id": { "type": "string", "format": "uri" },
"idp_parameterpattern": { "type": "string" },^https://"
}
"logo": { "type": "string", "format": "uri" },
"required": [
"sp_init": { "type": "string", "format": "uridescription" },
"ssodisplay_typename":,
{ "type": "string", "enum": ["entity_id", "link_map"] },
"logotype",
"target_parameter": { "type": "string" },
name",
"target_valueurl":
{ "$ref": "#/definitions/uriOrRelativePath" },
],
"link_mappingadditionalProperties": {false
},
"sso_links": {
"type": "objectarray",
"minPropertiesminItems": 1,
"patternPropertiesitems": {
".*": { "type": "stringobject",
"format": "uri", "pattern": "^https://" }
"properties": {
},
"description": {
"additionalPropertiestype": false"string",
"propertyNames": { "type": "string", "minLength": 1 }
},
}, "disabled": {
"required": ["description", "display_name", "entity_id", "logotype",: "sso_typeboolean"],
"anyOf "default": [false
{},
"propertiesdisplay_name": { "sso_type": { "const
"type": "entity_id" } }string",
"requiredminLength": ["idp_parameter", "sp_init"]1
},
"entity_id": {
"propertiestype": { "sso_type": { "const": "link_map" } },string",
"requiredformat": ["link_mappinguri"]
},
],"idp_parameter": {
"allOftype": ["string",
{
"minLength": 1
"if": { "required": ["target_parameter"] },
"then"logo": {
"required": ["target_value"] }
},
"type": "string",
{
"ifformat": { "required": ["target_value"] }uri",
"thenpattern": { "required": ["target_parameter"] }^https://"
},
],
"sp_init": {
"additionalProperties": false
}"type": "string",
}
},
"requiredformat": ["organization_infouri", "sso_links"],
"additionalProperties": false
},
"definitions": {
"uriOrRelativePathpattern": {"^https://"
"anyOf": [
},
{ "sso_type": "string", "format": "uri" },
{
{ "type": "string",
"pattern "enum": "^/(?!/)[^\\s]*$" }
[
]
}
}
} |
IdP Discovery Metadata
Purpose
The IdP Discovery Metadata feed provides a structured JSON representation of Identity Providers intended for consumption by:
Discovery services (WAYF / inverse discovery)
Login portals
Federation UI implementations
IdP selection interfaces
The purpose of this feed is to enable consistent and predictable presentation of Identity Providers across user-facing services.
This feed does not replace SAML metadata.
SAML metadata remains the authoritative source for federation trust and protocol configuration.
The IdP Discovery Metadata feed may be generated from one or more authoritative sources, including but not limited to federation SAML metadata.
IdP Discovery Metadata Structure
The IdP Discovery Metadata feed MUST be a JSON array containing one object per Identity Provider.
Each IdP object MUST contain the following fields:
| Field | Required | Type | Description |
|---|---|---|---|
entity_id | YES | string (URI) | The SAML entityID of the IdP in the federation |
description | YES | string | A short description of the organization and its services |
display_name | YES | string | A user-friendly name for display purposes |
logotype | YES | string (URI) | URL to the organization's logo |
name | YES | string | The official legal name of the organization |
url | YES | string (URI) | The official website of the organization |
All properties are REQUIRED.
Additional properties MUST NOT be included.
Example IdP Metadata Feed
"entity_id",
"link_map"
]
},
"target_parameter": {
"type": "string",
"minLength": 1
},
"target_value": {
"$ref": "#/$defs/uriOrRelativePath"
},
"link_mapping": {
"type": "object",
"minProperties": 1,
"patternProperties": {
"^.+$": {
"type": "string",
"format": "uri",
"pattern": "^https://"
}
},
"propertyNames": {
"type": "string",
"minLength": 1
},
"additionalProperties": false
}
},
"required": [
"description",
"display_name",
"entity_id",
"logo",
"sso_type"
],
"dependentRequired": {
"target_parameter": [
"target_value"
],
"target_value": [
"target_parameter"
]
},
"oneOf": [
{
"properties": {
"sso_type": {
"const": "entity_id"
}
},
"required": [
"idp_parameter",
"sp_init"
],
"not": {
"required": [
"link_mapping"
]
}
},
{
"properties": {
"sso_type": {
"const": "link_map"
}
},
"required": [
"link_mapping"
],
"not": {
"anyOf": [
{
"required": [
"idp_parameter"
]
},
{
"required": [
"sp_init"
]
}
]
}
}
],
"additionalProperties": false
}
}
},
"required": [
"organization_info",
"sso_links"
],
"additionalProperties": false
},
"$defs": {
"uriOrRelativePath": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "string",
"pattern": "^/(?!/)[^\\s]*$"
}
]
}
}
} |
IdP Discovery Metadata
The IdP Discovery Metadata feed provides a structured JSON representation of Identity Providers intended for consumption by:
Discovery services (WAYF / inverse discovery)
Login portals
Federation UI implementations
IdP selection interfaces
The purpose of this feed is to enable consistent and predictable presentation of Identity Providers across user-facing services.
This feed does not replace SAML metadata.
SAML metadata remains the authoritative source for federation trust and protocol configuration.
The IdP Discovery Metadata feed may be generated from one or more authoritative sources, including but not limited to federation SAML metadata.
...
IdP Discovery Metadata Data Model
The IdP Discovery Metadata feed MUST be a JSON array containing one object per Identity Provider.
Each IdP object MUST contain the following fields:
| Field | Required | Type | Description |
|---|---|---|---|
entity_id | YES | string (URI) | The SAML entityID of the IdP in the federation |
description | YES | string | A short description of the organization and its services |
display_name | YES | string | A user-friendly name for display purposes |
logotype | YES | string (URI) | URL to the organization's logo |
name | YES | string | The official legal name of the organization |
url | YES | string (URI) | The official website of the organization |
All properties are REQUIRED.
Additional properties MUST NOT be included.
...
Example metadata
| Code Block | ||
|---|---|---|
| ||
[
{
"entity_id": "https://idp1.example.com/idp",
"description": "Example Organization One Identity Provider for staff and student login.",
"display_name": "Example Organization One",
"logotype": "https://idp1.example.com/static/logo.svg",
"name": "Example Organization One AB",
"url": "https://www.example.com"
},
{
"entity_id": "https://idp2.example.com/idp",
"description": "Example Organization Two Identity Provider used for federated authentication.",
"display_name": "Example Organization Two",
"logotype": "https://idp2.example.com/static/logo.svg",
"name": "Example Organization Two AB",
"url": "https://org2.example.com"
},
{
| ||
| Code Block | ||
| ||
[ { "entity_id": "https://idpidp3.example.secom/idp", "description": "Example MunicipalityOrganization Three Identity Provider forsupporting staff and student loginaccess.", "display_name": "Example Organization MunicipalityThree", "logotype": "https://idpidp3.example.secom/static/logo.svg", "name": "Example Organization MunicipalityThree AB", "url": "https://wwworg3.example.secom" } ] |
...
...
JSON schema
The IdP Discovery feed MUST validate against the following JSON Schema (Draft-07):JSON schema found at https://fed.skolfederation.se/pilot/schemas/idp-discovery-feed-schema-0_1.json
| Code Block |
|---|
{
"$schema": "httphttps://json-schema.org/draft-07/schema#",
/2020-12/schema",
"$id": "https://fed.skolfederation.se/pilot/schemas/idp-discovery-feed-schema-0_1.json",
"title": "Skolfederation IdP Discovery metadata feed",
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"properties": {
"entity_id": {
"type": "string",
"format": "uri"
},
"description": {
"type": "string",
"minLength": 1
},
"display_name": {
"type": "string",
"minLength": 1
},
"logotype": {
"logotype": {
"type": "string",
"format": "uri"
},
,
"pattern": "^https://"
},
"name": {
"type": "string",
"minLength": 1
},
"url": {
"type": "string",
"format": "uri"
}
},
,
"pattern": "^https://"
}
},
"required": [
"entity_id",
"description",
"display_name",
"logotype",
"name",
"url"
],
"additionalProperties": false
}
} |
...
Validation and Encoding Requirements
...