Single sign-on with your Identity Provider via SAML 2.0

Single sign-on is supported via SAML 2.0 integration with an Identity Provider (IdP). There are teams using this in conjunction with Auth0, Okta, Keycloak, PingFederate, and Microsoft Azure Active Directory.

To configure SAML integration:

  • Add structurizr.authentication=saml to your file.
  • Register the Structurizr on-premises application with your Identity Provider. When doing this, you will need a “Reply URL”, which is of the form {structurizr.url}/login/saml2/sso (e.g. http://localhost:8080/login/saml2/sso).
  • Add a structurizr.saml.metadata property to your file, set to the URL where your IdP XML metadata can be found.
  • Map the IdP username to a SAML attribute named
  • Map the IdP roles/groups to a SAML attribute named

If your identity provider requires signed SAML requests:

  1. Place a copy of the signing certificate and private key into your Structurizr data directory (e.g. signing.cer and signing.key).
  2. Add two more additional properties to your file:
    • structurizr.saml.signing.certificate=signing.cer
    • structurizr.saml.signing.privateKey=signing.key

Optional properties that can be set include:

  • structurizr.saml.entityId: the SAML Entity ID that you are using to identify the Structurizr on-premises installation (configured with your Identity Provider when setting up the application/client)
  • structurizr.saml.registrationId: the SAML registration ID (default: structurizr)
  • structurizr.saml.attribute.username: the name of the SAML attribute used to obtain the user’s username (default:
  • structurizr.saml.attribute.role: the name of the SAML attribute used to obtain the user’s roles (default:

See Spring Security - SAML 2.0 Login Overview for more information about how SAML integration works. If you would like to test the SAML feature of the on-premises installation, here is some configuration equivalent to that found in the Spring Security samples:

# Okta (

(rp-certificate.crt and rp-private.key should be saved in your Structurizr data directory, next to your file)


The variation between identity providers and how organisations configure identity providers can make it difficult to configure SAML integration, and even the smallest misconfiguration can cause errors, most of which you’ll see in the logs as a HTTP 405 (Request method 'POST' not supported) or HTTP 500 message. Some recommended steps to resolve this are:

  1. Configure a non-secure (i.e. HTTP) localhost instance of the on-premises installation against your IdP to ascertain whether the problems you are seeing are related to your hosting environment (i.e. HTTPS, load balancers, reverse proxies, DNS, etc).
  2. Debug the SAML handshake with one of the available browser plugins.
  3. Enable debug on the on-premises installation to see the underlying error message (see Configuration - Logging).


  • If you make any changes to the SAML configuration, you will need to restart the on-premises installation.