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

# SAML

{% hint style="info" %}
*Every SSO provider is a little bit different. Please* [*contact us*](mailto:hello@appetize.io) *with any questions!*
{% endhint %}

## Configure app settings

Please ensure that the user's email address is sent as the username in the SAML response.

Please create group assignments for `appetize_developer` and `appetize_admin`, and assign to users appropriately. All users who have access to the SAML app, with no group assignments, will default to the user role. Please ensure these group assignments are passed in the SAML response as an attribute named `groups`.

| Field                                | Value                            |
| ------------------------------------ | -------------------------------- |
| SP Entity Id / Audience URI          | appetizeio-saml                  |
| Assertion Consumer Service URL (ACS) | TBD - provided by Appetize.io    |
| Recipient URL                        | N/A - leave blank or same as ACS |
| Destination URL                      | N/A - leave blank or same as ACS |

## **Information to provide to Appetize**

* **entryPoint** - the URL from your service provider that will initiate a login.
* **x509 certificate** used to sign SAML responses

{% hint style="info" %}
your provider may provide an **IdP metadata file** that contains both the **entryPoint** and the **x509 certificate**. You may send that file to us.
{% endhint %}

* authentication context (optional) - usually necessary for Microsoft ADFS
* **signature algorithm** (default SHA256)
* which **identify provider** are you using? (ADFS, OKTA, etc)

## Example Configuration with OKTA

<figure><img src="/files/aigpFblsMkLaK7n29Vs7" alt="Creating a SAML app"><figcaption><p>Creating a SAML app</p></figcaption></figure>

<figure><img src="/files/wovsm0b4cNEAXXlUhLZz" alt="General Settings - you may customize as you see fit"><figcaption><p>General Settings - you may customize as you see fit</p></figcaption></figure>

<figure><img src="/files/6w95dn7TLj60FA8HK0wz" alt="Enter the Single Sign On URL Provided by Appetize"><figcaption><p>Enter the Single Sign On URL Provided by Appetize.</p></figcaption></figure>

<figure><img src="/files/Cods41AjfQBvf6IDgwHX" alt="Save the IdP metadata file and send to Appetize.io"><figcaption><p>Save the IdP metadata file and send to Appetize.io</p></figcaption></figure>


---

# 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://docs.appetize.io/account/single-sign-on/saml.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.