Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Version history


VersionDateNotes
0.12025-Q1First pilot draft
0.22026-02-05

Explicit target handling added
Introduced target_value to explicitly define the value sent via target_parameter. If either field is present, both are now required.

Support for relative target paths
target_value now supports absolute URIs as well as absolute-path references starting with /, optionally including query and fragment.

Improved validation of link map login URLs
In link_mapping, login URLs are now strictly required to be HTTPS, while IdP entityID keys may be any non-empty string (e.g. HTTPS URIs or URNs), due to legacy SAML entityID requirements.

Summary

...

0.32026-03-01

IntroducedIdP Discovery Metadata feed. Refactored document structure for consistency and clarity.

Summary

This technical profile defines two independent JSON-based metadata feeds used within the SSO infrastructure:

  1. SP SSO Links Metadata Feed – Describes Service Providers (SPs) and

...

  1. how SSO can be initiated.

  2. IdP Discovery Metadata Feed – Provides a simplified Identity Provider (IdP) catalog in JSON format for UI presentation, discovery services, and portal implementations.

The feeds are independent and may be implemented separately.

Both feeds:

  • MUST use application/json

  • MUST use UTF-8 encoding

  • MUST validate against their respective JSON Schemas defined in this document

SP SSO Links Metadata

The SP SSO Links Metadata feed provides information about how SSO can be initiated for Service Providers within the federation.

It supports two SSO types:

  • EntityID-based login: Relies EntityID-based login: Relies on the identity provider’s entityID and parameters such as idp_parameter, target_parameter, and an SP-initiated login URL.

  • Link map-based login: Uses explicit mappings between known IdP entityIDs and proprietary login URLs.

Each metadata entry includes descriptive and branding information about the organization and its services, including display names, logos, and landing pages, facilitating consistent presentation in discovery services and login portals.

Metadata requirements

...

SP SSO Links Data Model

The SP SSO Links Metadata feed MUST be a JSON array.


Each array element MUST be a JSON object containing organization_info and sso_links.

Organization Information (organization_info)

This section contains metadata about the organization offering the SSO services.

The organization_info object MUST contain the following properties:

...

FieldRequiredTypeDescription
descriptionYESstringA short description of the organization and its services

...

display_nameYESstring

...

A user-friendly name

...

of the organization

...

logotypeYESstring (URI

...

)The URL of the

...

organization's logo

...

...

name

...

YESstringThe official legal name of the organization

...

urlYESstring (URI

...

)The official website of the organization

All properties are REQUIRED.
Additional properties MUST NOT be included.

Example

Code Block
languagejs
{
	"description":

...

List of SSO Links (sso_links)

This section contains a list of services that support SSO authentication.

...

description REQUIRED (str)

  • A short description of the service.
  • Example: "Example Digital Math Service is the number one digital math companion in Schengen".

...

disabled OPTIONAL (bool)

  • Indicates whether the SSO link is disabled. If omitted, the value is presumed to be false.
  • Possible values:
    • true → The service is disabled and not available to users.
    • false → The service is active and can be used.
  • Example: false (the service is active).

...

display_name REQUIRED (str)

  • The name of the service displayed to users.
  • Example: "Math Rocket".

...

entity_id REQUIRED (str, URL)

...

logo REQUIRED (str, URL)

...

sso_type REQUIRED (str)

  • The type of SSO configuration used for the service.
  • Possible values:
    • "entity_id" → Standard SAML SSO using an entity ID.
    • "link_map" → Direct mapping between Identity Providers (IdPs) and specific login URLs.
  • Example: "entity_id" for traditional SAML SSO.
 "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"
}

List of SSO Links (sso_links)

This section contains a list of services that support SSO authentication.

sso_links MUST be an array containing one object per service.

...

Each SSO link object MUST contain the following properties unless otherwise specified:

FieldRequiredTypeDescription
descriptionYESstringA short description of the service
display_nameYESstringThe name of the service displayed to users
entity_idYESstring (URI)The SAML entityID of the service
logoYESstring (URI)The URL of the service's logo
sso_typeYESstringThe type of SSO configuration
disabledNObooleanIndicates whether the SSO link is disabled
target_parameterNOstring

...

The parameter used to pass a target address

...

target_value

...

NOstringThe value used to pass a target address

...

...

Field Details

description (REQUIRED, string)

A short description of the service.

Example:

...

If either target_parameter or target_value is present, the other MUST also be present. target_value MAY be an absolute URI or an absolute-path reference starting with / optionally including query and fragment (relative to the service’s own origin).

If sso_type is "entity_id"

These fields are required for a standard SAML SSO setup using the entity ID as parameter for identifying the IdP.

...

idp_parameter REQUIRED (str)

  • The parameter used to pass the IdP’s entity ID in the SSO request.
  • Example: "entityID".


"Example Digital Math Service is the number one digital math companion in Schengen"

...

display_name (REQUIRED, string)

The name of the service displayed to users.

Example:
"Math Rocket"

...

entity_id (REQUIRED, string, URI)

The entity ID of the service in the SAML federation.

Example:

sp_init REQUIRED (str, URL)

...

"https://example.com/math

...

"

...

logo (REQUIRED, string, URI)

The URL of the service’s logo.

Example:
"https://example.com/math/logo.svg"

...

sso_type (REQUIRED, string)

Defines how SSO is initiated for the service.

Allowed values:

  • "entity_id" – Standard SAML SSO using an entity ID.

  • "link_map" – Direct mapping between Identity Providers (IdPs) and specific login URLs.

Example:

"sso_type": "entity_id"

...

disabled (OPTIONAL, boolean)

Indicates whether the SSO link is disabled.

If omitted, the value MUST be interpreted as false.

Allowed values:

  • true – The service is disabled and MUST NOT be presented to users.

  • false – The service is active.

Example:

"disabled": false

...

target_parameter (OPTIONAL, string)

The parameter used to pass a target address after authentication.

Example:

"target_parameter": "Target"

...

target_value (OPTIONAL, string)

The value used to pass a target address after authentication.

Example:

...

Fields used when the service uses direct mapping between IdPs and specific login URLs 

link_mapping REQUIRED (object)

...

languagejs

...

"target_value":

"https://example.com/

...

math/resource"

If either target_parameter or target_value is present, the other MUST also be present.

target_value MAY be:

  • An absolute URI, or

  • An absolute-path reference beginning with /, optionally including query and fragment components, interpreted relative to the service’s own origin.

If sso_type is "entity_id"

These fields are required for a standard SAML SSO setup using the entity ID as parameter for identifying the IdP.

Example metadata

...

languagejs

...

  • idp_parameter REQUIRED (str)

    • The parameter used to pass the IdP’s entity ID in the SSO request.
    • Example: "entityID".
  • sp_init REQUIRED (str, URL)

    • The URL for SP-initiated authentication.
    • Example:

...

Fields used when the service uses direct mapping between IdPs and specific login URLs 

  • link_mapping REQUIRED (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
      languagejs
      "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
languagejs
[
  {
    "organization_info": {
    },
    "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",
        "logodescription": "https://example.com/math/logo.svgAn example description of the service provider organization",
      "display_name": "Example Service Provider",
      "sp_initlogotype": "https://example.com/math/Shibboleth.sso/Login?logo.svg",
        "sso_typename": "entity_id",
        "target_parameter": "TargetExample Service Provider AB",
        "target_valueurl": "https://example.com/math/resource"
    },
   }, "sso_links": [
      {
        "description": "Example Digital Brazilian Jiu-JitsuMath Service is the number one digital BJJmath teachercompanion in Schengen",
        "disabled": false,
        "display_name": "Example Digital Brazilian Jiu-Jitsu ServiceMath Rocket",
        "entity_id": "https://example.com/bjjmath",
        "linkidp_mappingparameter": {
  "entityID",
        "https://idp.example1.comlogo": "https://example.com/bjj/login?idp=example1-idpmath/logo.svg",
          "https://idp.example2.comsp_init": "https://example.com/math/bjjShibboleth.sso/login?idp=example2-idp"Login?",
          "https://idp.example3.comsso_type": "https://example.com/bjj/login?idp=example3-idp"entity_id",
        }"target_parameter": "Target",
        "logotarget_value": "https://example.com/bjjmath/logo.pngresource",
      },
  "sso_type": "link_map"
    {
        "description": "Example Digital Brazilian Jiu-Jitsu Service is the number one digital BJJ teacher in Schengen",
         }"disabled": false,
    ]
  }
]

JSON schema

JSON schema for validating metadata:

Code Block
languagejs
{
  "$schemadisplay_name": "http://json-schema.org/draft-07/schema#",
  "type": "arrayExample Digital Brazilian Jiu-Jitsu Service",
   "items": {
    "typeentity_id": "objecthttps://example.com/bjj",
    "properties": {
      "organizationlink_infomapping": {
          "typehttps://idp.example1.com": "objecthttps://example.com/bjj/login?idp=example1-idp",
          "propertieshttps://idp.example2.com": {"https://example.com/bjj/login?idp=example2-idp",
          "descriptionhttps://idp.example3.com": { "type": "string"https://example.com/bjj/login?idp=example3-idp"
        },
        "logo":  "display_name": { "type": "string" },
  https://example.com/bjj/logo.png",
        "logotype": { "sso_type": "string", "format": "uri" },link_map"
      }
    ]
  }
]

JSON schema

JSON schema for validating SP SSO links metadata:

Code Block
languagejs
{
  "$schema": "http://json-schema.org/draft-07/schema#""name": { "type": "string" },
        "type": "array",
  "urlitems": {
    "type": "stringobject",
    "formatproperties": "uri" }{
        },"organization_info": {
        "requiredtype": ["description", "display_name", "logotype", "name", "url"],"object",
        "additionalPropertiesproperties": false{
      },
      "sso_linksdescription": {
        "type": "arraystring" },
          "itemsdisplay_name": {
          "type": "objectstring" },
          "propertieslogotype": {
 "type": "string", "format": "uri" },
          "descriptionname": { "type": "string" },
            "disabledurl": { "type": "booleanstring" },
 "format": "uri" }
         "display_name": { "type": "string" },
            "entity_idrequired": {["description", "typedisplay_name":, "stringlogotype", "formatname":, "uriurl" }],
        "additionalProperties": false
    "idp_parameter  },
      "sso_links": {
        "type": "stringarray" },
        "items": {
        "logo": { "type": "stringobject",
    "format      "properties": "uri" },{
            "sp_initdescription": { "type": "string", "format": "uri" },
            "sso_typedisabled": { "type": "string", "enum": ["entity_id", "link_map"]boolean" },
            "targetdisplay_parametername": { "type": "string" },
            "targetentity_valueid": { "$ref"type": "string", "format": "#/definitions/uriOrRelativePathuri" },
            "linkidp_mappingparameter": {
              "type": "objectstring" },
            "logo": { "minPropertiestype": 1"string",
              "patternProperties": {
    "format": "uri" },
            ".*sp_init": { "type": "string", "format": "uri", "pattern": "^https://" }
 },
            "sso_type": { "type": "string", "enum": ["entity_id", "link_map"] },
            "target_parameter": { "additionalPropertiestype": "string" false},
              "propertyNamestarget_value": { "type$ref": "string", "minLength": 1 }
#/definitions/uriOrRelativePath" },
            "link_mapping": {
              }
"type": "object",
             } "minProperties": 1,
              "requiredpatternProperties": ["description", "display_name", "entity_id{
                ".*": { "type": "string", "logoformat",: "sso_typeuri"],
 "pattern": "^https://" }
       "anyOf": [
      },
      {
        "additionalProperties": false,
      "properties        "propertyNames": { "sso_type": {"string", "constminLength": "entity_id"1 }
 },
           }
          },
          "required": ["description", ["idp_parameter", "sp_init"]
            },
            {
              "properties": { "sso_type": { "const": "link_map" } },
              "required": ["link_mapping"]
            }
          ],
          "allOf": [
            {
              "if": { "required": ["target_parameter"] },
              "then": { "required": ["target_value"] }
            },
            {
              "if": { "required": ["target_value"] },
              "then": { "required": ["target_parameter"] }
            }
          ],
          "additionalProperties": false
        }
      }
    },
    "required": ["organization_info", "sso_links"],
    "additionalProperties": false
  },
  "definitions": {
    "uriOrRelativePath": {
      "anyOf": [
        { "type": "string", "format": "uri" },
        { "type": "string", "pattern": "^/(?!/)[^\\s]*$" }
      ]
    }
  }
}"display_name", "entity_id", "logo", "sso_type"],
          "anyOf": [
            {
              "properties": { "sso_type": { "const": "entity_id" } },
              "required": ["idp_parameter", "sp_init"]
            },
            {
              "properties": { "sso_type": { "const": "link_map" } },
              "required": ["link_mapping"]
            }
          ],
          "allOf": [
            {
              "if": { "required": ["target_parameter"] },
              "then": { "required": ["target_value"] }
            },
            {
              "if": { "required": ["target_value"] },
              "then": { "required": ["target_parameter"] }
            }
          ],
          "additionalProperties": false
        }
      }
    },
    "required": ["organization_info", "sso_links"],
    "additionalProperties": false
  },
  "definitions": {
    "uriOrRelativePath": {
      "anyOf": [
        { "type": "string", "format": "uri" },
        { "type": "string", "pattern": "^/(?!/)[^\\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:

FieldRequiredTypeDescription
entity_idYESstring (URI)The SAML entityID of the IdP in the federation
descriptionYESstringA short description of the organization and its services
display_nameYESstringA user-friendly name for display purposes
logotypeYESstring (URI)URL to the organization's logo
nameYESstringThe official legal name of the organization
urlYESstring (URI)The official website of the organization

All properties are REQUIRED.

Additional properties MUST NOT be included.

...

Example IdP Metadata Feed


Code Block
languagejs
[
	{
		"entity_id": "https://idp.example.se/idp",
		"description": "Example Municipality Identity Provider for staff and student login.",
		"display_name": "Example Municipality",
		"logotype": "https://idp.example.se/static/logo.svg",
		"name": "Example Municipality AB",
		"url": "https://www.example.se"
	}
]


...

JSON Schema – IdP Discovery Feed

The IdP Discovery feed MUST validate against the following JSON Schema (Draft-07):

Code Block
{
	"$schema": "http://json-schema.org/draft-07/schema#",
	"title": "IdP Discovery metadata feed",
	"type": "array",
	"items": {
		"type": "object",
		"properties": {
			"entity_id": {
				"type": "string",
				"format": "uri"
			},
			"description": {
				"type": "string",
				"minLength": 1
			},
			"display_name": {
				"type": "string",
				"minLength": 1
			},
			"logotype": {
				"type": "string",
				"format": "uri"
			},
			"name": {
				"type": "string",
				"minLength": 1
			},
			"url": {
				"type": "string",
				"format": "uri"
			}
		},
		"required": [
			"entity_id",
			"description",
			"display_name",
			"logotype",
			"name",
			"url"
		],
		"additionalProperties": false
	}
}


...

Validation and Encoding Requirements

For both metadata feeds:

  • Content-Type MUST be application/json

  • Encoding MUST be UTF-8

  • Feeds MUST validate against their respective JSON Schemas