> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mediamonster.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Single sign-on & directory sync

> Sign your team in with your identity provider over SAML, and add and remove people automatically with SCIM.

A workspace on **Kraken** or **Behemoth** can sign its people in through your company's identity provider (IdP), and let that IdP add and remove people for you. Both live in Workspace settings, at [mediamonster.app/team/settings](https://mediamonster.app/team/settings), under **Single sign-on** and **Directory sync**. Only the workspace's owner and admins see them.

> [!NOTE]
>
> Single sign-on and directory sync come with the plans that seat a team. On Cyclops and Minotaur Workspace settings shows a link to the plans instead.

## Single sign-on (SAML)

Any IdP that speaks SAML 2.0 works: Okta, Microsoft Entra ID, Google Workspace, OneLogin, JumpCloud and others.

### Set it up

**1. Make a SAML app in your IdP**

Use the **Entity ID** and **ACS URL** shown under **Single sign-on** in Workspace settings. Send the person's email address as the NameID, or as an `email` attribute.

**2. Save your domains and metadata URL**

Enter the email domains your people sign in with (for example `studio.com`) and your IdP's metadata URL, which has to start with `https://`. Click **Save**. Public mail services such as `gmail.com` can't be claimed.

**3. Verify each domain**

Add the DNS TXT record the page shows for each domain. Its name is `_mediamonster-sso.<your domain>`, and its value starts with `mediamonster-sso=`. Then click **Check DNS**. A domain can be verified by one workspace only.

**4. Tell us**

We connect your IdP to our sign-in service by hand. [Contact support](https://docs.mediamonster.app/help/support.md) with your workspace's name once your domains are verified. The status changes from **Waiting for setup** to **On** when it is live.

If you change the metadata URL after single sign-on is on, the status goes back to **Waiting for setup** until we have updated the connection. Your people can still sign in while it waits, but nobody new joins the workspace automatically and single sign-on isn't required.

### Signing in

On the sign-in page, click **Sign in with SSO** and enter a work email. Mediamonster sends you to your IdP, and back once you have signed in. An address at a domain nobody has set up is told so, by name.

The first time someone at a verified domain signs in with single sign-on, they join the workspace as a **Member** and the app opens in it. If the workspace has no seats left, they are told so and can still use their own workspace.

> [!WARNING]
>
> A single sign-on account is a separate account from any password or Google account on the same address. Its workspaces, files and credits aren't shared with the older account. If someone already works in the workspace under a password account, remove that account from the workspace once they have signed in with single sign-on.

### Require single sign-on

The workspace's owner can click **Require** under **Require single sign-on**. From then on, nobody at your verified domains can sign in with a password, an email code, or Google, Discord or X. That includes the owner if their address is at one of those domains. It applies to every account at those domains, whether or not it is in the workspace.

Requiring it needs single sign-on to be **On** and at least one verified domain. Click **Stop requiring** to allow passwords again.

## Directory sync (SCIM)

Directory sync lets your IdP add people to the workspace, update their names and addresses, and take them out when they leave. It speaks SCIM 2.0.

**1. Verify a domain**

The directory can only add people at your verified domains, so set up **Single sign-on** first, at least as far as verifying a domain.

**2. Make a token**

Under **Directory sync**, click **Make a token**. It is shown once. Only the workspace's owner can make or revoke it. Making another replaces the last one, which stops working at once.

**3. Connect your IdP**

In your IdP's provisioning settings, enter the **SCIM base URL** from the page and the token as a bearer token. Turn on creating users, updating user attributes and deactivating users.

What the directory can do:

| In your IdP | In the workspace |
| - | - |
| Assign someone to the app | They join as a **Member**, now if they have an account at that address, otherwise the first time they sign in |
| Change their name or email | Their directory entry is updated |
| Unassign or deactivate them | They are taken out of the workspace. Their own account, workspace and files are left alone |
| Reactivate them | They join again |

A role can be sent in the `roles` attribute as `member` or `admin`. The directory can never make someone the owner or remove the owner.

Endpoints, all under the base URL:

| Endpoint | Methods |
| - | - |
| `/Users` | `GET` (with `filter`, `startIndex`, `count`), `POST` |
| `/Users/{id}` | `GET`, `PUT`, `PATCH`, `DELETE` |
| `/ServiceProviderConfig` | `GET` |
| `/ResourceTypes` | `GET` |

Filters support `eq`, `ne`, `co`, `sw`, `ew` and `pr` on `userName`, `externalId`, `emails.value`, `displayName`, `active` and `id`, joined with `and`. Groups, sorting and bulk requests aren't supported. Each workspace's directory can make up to 600 requests a minute.

## Activity

Every change here is on the workspace's activity page, under **Workspace & people**: saving the settings, verifying a domain, requiring single sign-on, making or revoking the token, and each person the directory adds, updates or removes. A sign-in refused because single sign-on is required shows on that person's own activity page.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.