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

# Configure SAML

> Exchange SAML metadata and register Rima as a service provider.

Rima must register your connection before SAML sign-in can be tested.

Rima starts SAML sign-in at a browser launch URL, redirects to your IdP, and receives an HTTP POST at the assertion consumer service (ACS). Start with [SSO setup](/sso-setup) for the environment URLs and the `providerId` assigned to your connection.

## Exchange metadata

1. Give Rima your IdP metadata, or its entity ID, SSO URL, and signing certificate. If your IdP requires Rima's service-provider metadata first, contact Rima before proceeding.
2. Rima registers the connection and provides the `providerId`. Retrieve Rima's service-provider metadata from the URL for that environment, or use the supplied registration details.
3. Configure the IdP with Rima's service-provider metadata and ACS URL. Confirm required attributes, signature settings, and the test identity with Rima.
4. Open the browser launch URL supplied by Rima to test a service-provider-initiated sign-in.

## Identity attributes

| Attribute | Behavior |
| - | - |
| NameID | Stable identifier used to link repeat sign-ins to the same identity. |
| `email` | Default email attribute for first sign-in. |
| Name attributes | `givenName`, `surname`, or `displayName` can be supplied. |

Use the browser launch flow. First sign-in also depends on [Rima account and invitation access](/sso-access).


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