# SimpleSAMLphp SAML single sign-on

<!-- Generated by scripts/generate.ts. Do not edit. -->

Register this app as a SAML 2.0 service provider on your SimpleSAMLphp server from our metadata, release the user attributes and share your identity provider metadata with us.

:::caution[Verification]
Not yet verified on a real SimpleSAMLphp tenant. It was written from the public SimpleSAMLphp documentation, so labels in the admin console may differ slightly.
:::

The values in braces, such as `{metadata_url}`, are specific to your connection. The setup link from the application you are connecting shows them with a copy button. The same steps appear there.

## Steps

<ol class="idp-steps">

<li class="idp-step">

<a id="load-sp"></a>

### Register this app as a service provider

On your SimpleSAMLphp server, add this app as a SAML 2.0 service provider by loading its metadata from `{metadata_url}`. The metadata carries the ACS URL, the entity ID and our signing certificate, so you do not type them in.

<div class="setup-values">

Paste into SimpleSAMLphp:

- SP metadata URL: `{metadata_url}`

</div>

:::caution[Labels not confirmed in step 1]
Written generically from the protocol specifications; no public SimpleSAMLphp admin page was checked for the console's own labels and menu paths.
:::

</li>

<li class="idp-step">

<a id="check-sp"></a>

### Check the entity ID and ACS URL

Confirm that the service provider's entity ID is `{sp_entity_id}` and its ACS URL is `{acs_url}`. If you configure service providers by hand instead of from metadata, enter these two values.

<div class="setup-values">

Paste into SimpleSAMLphp:

- SP entity ID: `{sp_entity_id}`
- ACS URL: `{acs_url}`

</div>

Fixes: [`saml_destination_mismatch`](/errors/saml_destination_mismatch/), [`saml_audience_mismatch`](/errors/saml_audience_mismatch/)

</li>

<li class="idp-step">

<a id="name-id"></a>

### Release a persistent name ID

Release a persistent name ID to this service provider, so each user keeps the same identifier over time. If your policy prefers it, release the email address as the name ID instead.

Fixes: [`saml_nameid_missing`](/errors/saml_nameid_missing/)

</li>

<li class="idp-step">

<a id="attributes"></a>

### Release the user attributes

Release mail (urn:oid:0.9.2342.19200300.100.1.3), givenName (urn:oid:2.5.4.42) and sn (urn:oid:2.5.4.4) to this service provider. To send groups, also release isMemberOf (urn:oid:1.3.6.1.4.1.5923.1.5.1.1).

Fixes: [`saml_email_missing`](/errors/saml_email_missing/)

</li>

<li class="idp-step">

<a id="signing"></a>

### Sign responses with SHA-256

Make sure SimpleSAMLphp signs the SAML response, the assertion or both, and uses SHA-256 (RSA-SHA256) as the signature algorithm.

Fixes: [`saml_signature_missing`](/errors/saml_signature_missing/), [`saml_signature_algorithm_weak`](/errors/saml_signature_algorithm_weak/)

</li>

<li class="idp-step">

<a id="metadata"></a>

### Share the identity provider metadata

Add your server's identity provider metadata to this setup. It is usually published at an address of the form "https://your-host/simplesaml/saml2/idp/metadata.php". Do this again whenever the signing certificate changes, unless this setup reads it from the URL.

Fixes: [`saml_signature_invalid`](/errors/saml_signature_invalid/), [`saml_issuer_mismatch`](/errors/saml_issuer_mismatch/)

</li>

<li class="idp-step">

<a id="test"></a>

### Test the connection

Run a test sign-in in this setup, signing in as a user you assigned to the app.

</li>

</ol>

<a id="standby"></a>

## Optional: add the standby ACS URL

If our main network ever has an outage, sign-ins can continue through a standby address. Our metadata at `{metadata_url}` lists it as a second ACS URL, so a server that loads the metadata accepts it. Reload the metadata if you entered the values by hand, check that `{standby_acs_url}` is listed, then confirm in this setup that you added it.

<div class="setup-values">

Paste into SimpleSAMLphp:

- SP metadata URL: `{metadata_url}`
- Standby ACS URL: `{standby_acs_url}`

</div>

This step is optional. See [standby route behavior](/trust/standby/) for what the standby address does during an outage.

## Sources

- [Profiles for the OASIS Security Assertion Markup Language (SAML) V2.0](https://docs.oasis-open.org/security/saml/v2.0/saml-profiles-2.0-os.pdf), read on 2026-10-29
- [Metadata for the OASIS Security Assertion Markup Language (SAML) V2.0](https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf), read on 2026-10-29
