Page History

...

• 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)

  • The entity ID of the service in the SAML federation.
  • Example: "https://example.com/math".

• logo REQUIRED (str, URL)

  • The URL of the service’s logo.
  • Example: "https://example.com/math/logo.svg".

• 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.

• sso_url OPTIONAL (str, URL)

  • The URL for the service’s SSO entry point.
  • Example: "https://example.com/bjj/sso".

If sso_type is "entity_id"

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

• entity_id REQUIRED (str, URL)

  • The entity ID of the service in the SAML federation.
  • Example: "https://example.com/math".

• 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: "https://example.com/math/Shibboleth.sso/Login?".
  sso_url OPTIONAL (str, URL)
  • The URL where the SAML SSO request is sent.
  • Example: "https://example.com/math/Shibboleth.sso/SAML2/POST".

• target_parameter OPTIONAL (str)

  • The parameter used to pass a target address after authentication.
  • Example: "Target".

...

• 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
    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" },

• target_parameter OPTIONAL (str, can be empty)

  • The parameter used to pass a target address after authentication.
  • Can be empty ("") if not used.

• sso_url OPTIONAL (str, URL)

  • The URL for the service’s SSO entry point.
  • Example: "https://example.com/bjj/sso".

• entity_id REQUIRED (str, URL)

  • The entity ID of the service in the SAML federation.
  • Example: "https://example.com/bjj".