---
description: Here you can find instructions on how to configure authentication via SAML.
---

# SSO

## Overview

Purify can be configured to use SSO (based on SAML) instead of local authentication.

Under the hood [passport-saml](https://github.com/bergie/passport-saml) is used to make it possible.

## Configuration

You need to provide a set of credentials via `.env` file:

```bash
SAML_CALLBACK_URL=https://<purify_fqdn>/api/auth/saml/callback
SAML_IDP_URL=https://dev-xxxx-xxx.us.auth0.com/xxx/xxxxx
SAML_ENTITY_ID=urn:dev-xxxx-xxx.us.auth0.com


SAML_LOCAL_KEY_PATH=/etc/certs/key.pem
# or
#SAML_LOCAL_KEY_ONELINE=MIIJQwIBADANBgkqhkiG9....

SAML_IDP_CERT_PATH=/etc/certs/idp.pem
# or
#SAML_IDP_CERT_ONELINE=MIIDDTCCAfWgAwIBAgIJcr....

SAML_EMAIL_FIELD_NAME=email
SAML_USERNAME_FIELD_NAME=name
```

`SAML_LOCAL_KEY` can be set in two ways:&#x20;

* `SAML_LOCAL_KEY_PATH` via path of the mounted file into the docker container
* `SAML_LOCAL_KEY_ONELINE` alternatively a single line private key without start/end lines where all rows are joined into single line, see example from of [singleline private key](https://github.com/bergie/passport-saml/blob/master/test/static/singleline_acme_tools_com.key).

The same work for `SAML_IDP_CERT_PATH` and `SAML_IDP_CERT_ONELINE`.

And set:

```bash
USE_SAML=true
```

## Action

Restart Purify and try to login, the login screen will be changed to:

![](https://88240658-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M3I4ZhftILe_kBZUamw%2F-MKVYx8nn6iyWPG0Zv-5%2F-MKVZpAnS84NNHiRQZNm%2FScreenshot%202020-10-25%20at%2018.24.24.png?alt=media\&token=e7ea04fd-8323-401e-a2da-026db93650d8)

Some users, such as admins, may need to bypass single sign-on to complete work tasks. To enable this, when creating users, check the box:

![](https://88240658-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M3I4ZhftILe_kBZUamw%2F-MKVYx8nn6iyWPG0Zv-5%2F-MKV_XZFuE1kNOZMsYKG%2FScreenshot%202020-10-25%20at%2018.27.31.png?alt=media\&token=6ebdaef5-528c-4e0a-a346-ae2c7c38bf43)
