SSO setup

Setting up SAML login

  1. Set SAML_DATABASE_URL to a Postgres database. Please use a different database than the main Cal instance since the migrations are separate for this database. For example postgresql://postgres:@localhost:5450/cal-saml. If you are using a self-signed certificate for Postgres then use the sslmode=no-verify query param in the database URL. For example postgresql://postgres:@localhost:5450/cal-saml?sslmode=no-verify.

  2. Set SAML_ADMINS to a comma separated list of admin emails from where the SAML metadata can be uploaded and configured.

  3. Create a SAML application with your Identity Provider (IdP) using the instructions here - SAML Setup

  4. Remember to configure access to the IdP SAML app for all your users (who need access to Cal).

  5. You will need the XML metadata from your IdP later, so keep it accessible.

  6. Log in to one of the admin accounts configured in SAML_ADMINS and then navigate to Settings -> Security.

  7. You should see a SAML configuration section, copy and paste the XML metadata from step 5 and click on Save.

  8. Your provisioned users can now log into Cal using SAML.

SAML Registration with Identity Providers

This guide explains the settings you need to use to configure SAML with your Identity Provider. Once this is set up you should get an XML metadata file that should then be uploaded on your self-hosted instance.

Note: Please do not add a trailing slash at the end of the URLs. Create them exactly as shown below.

Assertion consumer service URL / Single Sign-On URL / Destination URL: https://<url for your self-hosted instance>/api/auth/saml/callback [Replace the placeholder with the URL for your self-hosted Cal instance]

Entity ID / Identifier / Audience URI / Audience Restriction:

Response: Signed

Assertion Signature: Signed

Signature Algorithm: RSA-SHA256

Assertion Encryption: Unencrypted

Mapping Attributes / Attribute Statements: -> id -> email -> firstName -> lastName

Was this page helpful?