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

# SAML and SCIM settings

> The values to enter in any SAML 2.0 identity provider, and how SCIM 2.0 provisioning maps your people to Connectly accounts

This page lists what your identity provider needs, whatever the provider. Field names differ between providers; the table gives the common names. For a full walkthrough in one provider, see the [Microsoft Entra example](https://docs.connectly.ai/enterprise-sso/microsoft-entra.md).

***

## SAML sign-in

Create a custom (generic) SAML 2.0 application in your identity provider, for example a non-gallery **Enterprise application** in Microsoft Entra or a **SAML 2.0** app integration in Okta. Then enter these values. They are specific to your connection, so copy them exactly.

| Setting | Also called | Example value | Where it comes from |
| - | - | - | - |
| Identifier | Entity ID, Audience URI, SP Entity ID | `urn:auth0:connectly-production:ent-yourcompany` | Setup link: the wizard's **Service Provider Entity ID**. Manual: Connectly. |
| Reply URL | Assertion Consumer Service (ACS) URL, Single sign-on URL | `https://authn.connectly.ai/login/callback?connection=ent-yourcompany` | Setup link: the wizard's **Single Sign-On URL**. Manual: Connectly. |
| Sign on URL | Start URL, Login URL | `https://app.connectly.ai/?sso=ent-yourcompany` | Connectly, both ways. |
| Relay State, Logout URL | | Leave empty. | |

The assertion your identity provider sends must carry:

| Attribute | Value | Note |
| - | - | - |
| Name ID | The person's sign-in name, for example the user principal name in Microsoft Entra or the username in Okta | Must be the same value your provider sends as the SCIM `userName`. Connectly links each person by it, so keep it stable. |
| `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress` | The person's email address | Required. If people have no mailbox, send the sign-in name here. |
| `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name` | The person's display name | Optional. |

Then give Connectly your application's SAML metadata:

* **Setup link:** paste your provider's metadata URL into the wizard's **Configure Connection** page.
* **Manual:** download the metadata XML file and send it to Connectly.

Finally, require assignment, so that only people you assign to the application can sign in, and assign the people who will use Connectly.

> [!NOTE]
>
> Connectly starts the sign-in (SP-initiated SAML). A tile in your provider's app portal works when it opens the Sign on URL.

***

## SCIM provisioning

SCIM is optional. Without it, see [SSO without SCIM](https://docs.connectly.ai/enterprise-sso/without-scim.md).

In your identity provider's provisioning settings for the same application:

1. Choose **Bearer** (token) authentication.
2. Enter the SCIM endpoint as the base or tenant URL. With a setup link, it is the wizard's **Provisioning Endpoint URL** without the final slash; otherwise Connectly sends it.
3. Enter the SCIM token as the bearer token or secret.
4. Test the connection, then save.
5. Set the scope to provision only the people and groups assigned to the application.
6. Do not start provisioning for everyone yet. Provision one person first and test their sign-in.

### Attribute mapping

Connectly reads these SCIM attributes. Most providers send them by default.

| SCIM attribute | Source in your identity provider | Note |
| - | - | - |
| `userName` | The person's sign-in name | Must equal the SAML Name ID. |
| `emails[type eq "work"].value` | The person's email address | Required. Use the sign-in name if people have no mailbox. |
| `displayName` | The person's display name | The name Connectly shows, cut to 32 characters. |
| `externalId` | Your provider's default | Keep the default. |
| `active` | Your provider's default | Becomes `false` when a person is unassigned, disabled or deleted. |

Connectly does not use groups yet. If you assign groups to the application, turn off provisioning of the groups themselves; their members are still provisioned.

### The SCIM token

The token lets your identity provider create, change and deactivate your company's Connectly accounts on this connection, so treat it like a password.

* **Setup link:** you generate the token yourself in the wizard, and nobody sends it. The wizard shows it once: click **Copy And Close** and paste it into your identity provider right away.
* **Manual:** Connectly creates the token and sends it to one named administrator over a secure channel, such as a password manager share or a one-time secret link. It never travels in plain email or chat.
* Paste it into your identity provider and nowhere else.
* The token does not expire. It stops working only when it is revoked, by Connectly or, with a setup link, on the wizard's **Provisioning** page.
* To replace it, get a second token from a new setup link or from Connectly (two can exist at once), paste it, test the connection and save. Then Connectly revokes the old one. Provisioning keeps working throughout.
* If the token may have leaked, tell Connectly. We revoke it at once and send a new one or a new setup link.

***

## What each change does in Connectly

| In your identity provider | In Connectly |
| - | - |
| A person is assigned and provisioned | Connectly creates their account, with their email as the username, links it to your connection and adds them to your business with the agreed role. An existing account with that email is linked instead; if it is already a member of your business, its membership and role stay as they are. |
| Their name changes | The display name follows. The username stays the same. |
| They are unassigned, disabled or deleted | Sign-in through your connection stops, and Connectly removes the business access provisioning gave them. Owners, and memberships you added by invitation, stay. Their SSO sessions end. |
| They sign in | Your provider's sign-in with your policies, then straight into your Connectly business. |


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