Connect SimpleSAMLphp

Learn how to configure a new SimpleSAMLphp SSO Connection

Introduction

Each SSO Identity Provider requires specific information to create and configure a new Connection. Often, the information required to create a Connection will differ by Identity Provider.

To create a SimpleSAMLphp SAML Connection, you'll need the Identity Provider Metadata URL that is available from your Enterprise customer's SimpleSAMLphp instance.

WorkOS Provides

WorkOS provides the ACS URL, the SP Metadata Link and the SP Entity ID. They are readily available in your Connection's Settings in the WorkOS Dashboard.

The ACS URL is the location an Identity Provider redirects its authentication response to. The SP Metadata link contains a metadata file that your Enterprise customer can use to set up the SAML integration. The SP Entity ID is a URI used to identify the issuer of a SAML request, response, or assertion.

Overview

And then, you provide the IdP Metadata URL.

Normally, this will come from your Enterprise customer's IT Management team when they set up your application's SAML configuration in their SimpleSAMLphp instance. But, should that not be the case during your setup, here's how to obtain it.

1

Configure SAML Application with Service Provider Details

Follow the SimpleSAMLphp documentation to set up SimpleSAMLphp as an Identity Provider and add a new SP.

Copy and paste the ACS URL and SP Entity ID into the corresponding fields for Service Provider configuration. You can find more on how to structure this under "Adding SPs to the IdP" in the SimpleSAMLphp documentation linked above.

The necessary SP metadata can also be found in the SP metadata URL provided in the WorkOS Dashboard.

2

Configure SAML Attributes

You will need to send the following 4 required attributes in the SAML Response: firstName, lastName, email, and id.

Ensure the following attribute mapping is set:

  • A user's first name -> firstName
  • A user's last name -> lastName
  • A user's email address -> email
  • A unique identifier representing a user -> id
3

Obtain Identity Provider Metadata

Obtain the IdP Metadata URL. As noted in the "Adding this IdP to other SPs" section of the SimpleSAMLphp documentation, the IdP metadata URL should be available from /saml2/idp/metadata.php.

NOTE: Alternatively, you can manually configure the connection by providing the IdP URI (Entity ID), IdP SSO URL and X.509 Certificate.

Your Connection will then be Active and good to go!