> For the complete documentation index, see [llms.txt](https://help.rechat.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.rechat.com/appendix/brokerage-set-up/single-sign-on.md).

# Single Sign-On (SSO)

Rechat supports SAML 2.0 single sign-on (SSO) and identity provider-initiated single logout (SLO). This guide is intended for administrators who are configuring Rechat in their identity provider (IdP)

### Overview

Activating SSO requires two steps. Configuring Single Logout is optional:

1. Add Rechat as a SAML service provider.
2. Provide your IdP metadata to Rechat.
3. Optional: Configure SAML Single Logout (SLO).

### Step 1: Add Rechat as a SAML Service Provider

Add Rechat as a SAML service provider in your identity provider (IdP) using the settings below:

| Key                       | Value                                     |
| ------------------------- | ----------------------------------------- |
| ACS URL                   | <https://api.rechat.com/auth/saml>        |
| Entity ID                 | <https://api.rechat.com/auth/saml>        |
| Signed Response           | Enabled                                   |
| NameID Format             | Email address                             |
| Single Logout Service URL | <https://api.rechat.com/auth/saml/logout> |

Rechat can use the following SAML attributes to populate the user’s profile:

| Property               | Example                                   |
| ---------------------- | ----------------------------------------- |
| `firstName`            | John                                      |
| `lastName`             | Smith                                     |
| `phoneNumber`          | (555) 555-1234                            |
| `timezone`             | America/Chicago                           |
| `profileImage`         | <https://yourwebsite.com/agents/1002.jpg> |
| `userid` (primary key) | 12345                                     |

### Step 2: Provide Your IdP Metadata to Rechat

Provide Rechat with the following information:

* SSO URL
* Entity ID (issuer)
* IdP signing certificate
* Single Logout URL (optional)

Many IdPs provide these values in a downloadable metadata XML file. You can send that file to Rechat instead of listing each value separately.

After completing Steps 1 and 2, contact Rechat to activate SSO for your organization.

### Optional: Configure SAML Single Logout

Rechat supports identity provider-initiated SAML 2.0 Single Logout (SLO) at:

`https://api.rechat.com/auth/saml/logout`

The endpoint supports HTTP-Redirect (GET) and HTTP-POST bindings. The IdP must send a signed `LogoutRequest` containing its issuer and the user’s `NameID`; `SessionIndex` and `RelayState` are optional.

Rechat validates the request, expires the matching SSO session, and redirects the browser to the IdP with a `LogoutResponse`. If no `SessionIndex` is provided, all sessions for that user and SSO provider are expired; other authentication tokens are unaffected.

Invalid issuers, payloads, or signatures are rejected without expiring a session.


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.rechat.com/appendix/brokerage-set-up/single-sign-on.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.