> For the complete documentation index, see [llms.txt](https://docs.screendesk.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.screendesk.io/security/saml-sso.md).

# Sign-in and SSO

Let members sign in with your SAML identity provider, enforce it, and provision members with SCIM.

**Settings → Sign-in & SSO** connects Screendesk to your identity provider. It works with Okta, Microsoft Entra ID, Google Workspace, OneLogin and any other SAML 2.0 provider. Only admins see this page.

{% embed url="<https://app.screendesk.io/recordings/2b47e26a-23b1-46b2-91c2-422b44ef19a5>" %}

{% hint style="info" %}
**Plans:** Enterprise.
{% endhint %}

The page has three parts, in the order you set them up:

1. **SAML single sign-on**: connect your identity provider.
2. **Signing in**: enforce SAML, and decide who gets an account at first sign-in.
3. **SCIM provisioning**: let your identity provider add and remove members.

Step-by-step guides: [Okta](https://docs.screendesk.io/security/saml-sso/saml-sso-with-okta.md), [Microsoft Entra ID](https://docs.screendesk.io/security/saml-sso/saml-sso-with-azure-ad.md), [Google Workspace](https://docs.screendesk.io/security/saml-sso/saml-sso-with-google-workspace.md).

***

### 1. Add Screendesk to your identity provider

Create a SAML app in your identity provider with these values. Each one has a copy button on the settings page.

| Value                     | Also called                              | What to enter                                                                                                                   |
| ------------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| **ACS URL**               | Single sign-on URL, Reply URL, Recipient | `https://app.screendesk.io/saml_callback`                                                                                       |
| **Entity ID**             | Audience URI, Identifier, SP entity ID   | `urn:screendesk.io:saml`                                                                                                        |
| **Name ID format**        |                                          | `urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress` (the member's email)                                                   |
| **Default relay state**   |                                          | Unique to your workspace: copy it from the settings page. It's used when someone starts from your identity provider's app list. |
| **Attributes** (optional) |                                          | `email`, `first_name`, `last_name`. They name the accounts created at first sign-in.                                            |

If your identity provider can import settings, give it the **Metadata URL**, `https://app.screendesk.io/saml/metadata`, or click **Download metadata XML**.

<figure><img src="https://3820804400-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfW6XSzJSKsNyZnOkSJPt%2Fuploads%2Fmm9vOZnr6j5LfD4ePna9%2Fdocs-panel-sso.png?alt=media" alt="Settings, Sign-in &#x26; SSO, the values to give your identity provider"><figcaption></figcaption></figure>

### 2. Connect your identity provider

Click **Connect identity provider** and paste in what your identity provider gives you once the app is created:

| Field                           | Also called                                                                                                                          |
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| **Email domain**                | Your company's domain, such as `yourcompany.com`. People with an address there who choose SAML sign-in go to your identity provider. |
| **Sign-on URL**                 | SSO URL, Login URL, SAML 2.0 endpoint                                                                                                |
| **Identity provider entity ID** | Issuer, Identity provider identifier                                                                                                 |
| **X.509 certificate**           | The signing certificate, as a .pem, .cer or .crt file opened as text                                                                 |

Save it. The page then shows the certificate's name, expiry date and SHA-256 fingerprint, and a **Sign-in link** members can bookmark to skip the email step.

Screendesk refuses sign-ins signed with any other certificate. When the certificate is 30 days from expiring, or has expired, the page warns you: paste in the new one when your identity provider starts using it.

### Test it

Open the **Sign-in link** in a private window, or go to the Screendesk sign-in page, choose **Use Single Sign-On**, then **Continue with SAML**, and enter an address at your domain. You should land on your identity provider, then back in Screendesk.

***

### Signing in

#### Enforce SAML SSO

Once your identity provider is connected, turn on **Enforce SAML SSO** so members can only sign in through it: no password sign-in and no password reset. Screendesk asks you to confirm.

* People already signed in stay signed in until their next sign-in.
* The workspace owner keeps their password, so the workspace can't be locked out if your identity provider is down.

{% hint style="warning" %}
Try the sign-in link in a private window before you enforce SAML.
{% endhint %}

#### Create accounts at first sign-in

On by default. People your identity provider lets in join as members the first time they sign in. People who already have a Screendesk account confirm by email first.

Turn it off to allow only people you invite or provision with SCIM. Anyone else sees *Ask your IT administrator to provision an account for you.*

***

### SCIM provisioning

With SCIM 2.0, your identity provider adds, updates and removes members for you. It works with or without SAML.

| Setting                                                 | Value                                            |
| ------------------------------------------------------- | ------------------------------------------------ |
| **SCIM base URL** (Tenant URL, SCIM connector base URL) | `https://app.screendesk.io/api/v2/scim`          |
| **Authentication**                                      | Bearer token, in the HTTP `Authorization` header |
| **Bearer token** (API token, Secret token)              | Reveal it on the settings page                   |
| **Unique identifier**                                   | `userName`, the member's email                   |

What syncs:

* **Users** are created, updated (`PUT`) and deleted. Deleting someone in your identity provider deletes their Screendesk account.
* **Roles** come from a `roles` attribute with `admin`, `editor` or `member` set to true. Anyone without one joins as a member.

{% hint style="warning" %}
Groups and `PATCH` updates aren't supported yet. Okta and Microsoft Entra ID send `PATCH` to deactivate someone, so when a person leaves, also remove them in **Settings → Members**.
{% endhint %}

***

### FAQ

<details>

<summary>What happens to existing members when I connect SAML?</summary>

Nothing at first. They can keep signing in with a password until you turn on **Enforce SAML SSO**.

</details>

<details>

<summary>Can I use more than one email domain?</summary>

A workspace has one SSO domain. Contact <support@screendesk.io> if you need more.

</details>

<details>

<summary>Can people start from our identity provider's app list?</summary>

Yes. Set the **Default relay state** from the settings page in your identity provider's SAML app.

</details>

<details>

<summary>Are SSO changes recorded?</summary>

Yes. Changing the SAML settings and turning enforcement on or off are recorded in the [Audit log](https://docs.screendesk.io/security/audit-logs.md).

</details>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.screendesk.io/security/saml-sso.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
