# Single Sign On (SS0)

### Overview

Activating Rechat as an SSO requires 2 steps:

1. Adding Rechat as a Service Provider
2. Adding your IdP to Rechat

### Step 1: Creating a SAML Service Provider

The first step in activating Rechat's Single Sign On is to add Rechat as a Service Provider.\
You can add Rechat as a service provider using the following specs:

| Key             | `Value`                            |
| --------------- | ---------------------------------- |
| ACL URL         | <https://api.rechat.com/auth/saml> |
| Entity ID       | <https://api.rechat.com/auth/saml> |
| Signed Response | Enabled                            |
| NameID Format   | EMAIL                              |

Rechat will also look for the following data coming from SSO users to populate their information:

| 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: Providing Metadata to Rechat

You need to provide Rechat the following information:

* SSO Url
* Entity ID
* Certificate
* Service Provider's ID

Some IdP Providers allow you to download all required metadata in a in a XML file. The XML file is also a valid method of gaining this information.

Once you have completed Step 1, you can contact us to activate your SSO.


---

# Agent Instructions: 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:

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

The question should be specific, self-contained, and written in natural language.
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.