> For the complete documentation index, see [llms.txt](https://docs.tomorrowx.com/cap/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tomorrowx.com/cap/product-reference/administration-functions/authenticating-via-saml.md).

# Authenticating via SAML

Another alternative to managing users locally is to use SAML authentication, where an Identity Provider (IdP) is the entity providing the identities, including the ability to authenticate a user.

SAML authentication is set up manually by providing an access manager plugin in the console’s configuration.properties file. Please see Console server configuration below for more information.

In the SAML Identity provider (IdP) you need to specify the single sign on URL as:

```
https://[server URL]/console/SAML
```

You have the option of passing the following parameters along in the sign on:

<table data-header-hidden><thead><tr><th width="294"></th><th></th></tr></thead><tbody><tr><td>Parameter</td><td>Values</td></tr><tr><td>UserType</td><td>Admin/User/Super/Security</td></tr><tr><td>UserLocale</td><td>Any valid locale. Default is en_US</td></tr><tr><td>UserTimeZone</td><td>Any valid time zone. Default is GMT</td></tr><tr><td>UserName</td><td>User full name. Default is SAML ID</td></tr><tr><td>UserEmail</td><td>User email. Default is SAML ID</td></tr><tr><td>UserRole (can be multiple)</td><td>Any valid role</td></tr><tr><td>UserIU</td><td>Classic/Portal. Defaults to console default</td></tr></tbody></table>

One of UserType or UserRole MUST be provided. If a role is provided, but no type, the type will be set to User.


---

# 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.tomorrowx.com/cap/product-reference/administration-functions/authenticating-via-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.