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

# Single Sign-On

Following you will find information and setup instructions for SAML based Single Sign-On with Commanders Act.

## Overview

Commanders Act supports SAML 2.0 based Single Sign-On authentication and authorization.

<figure><img src="https://1259070148-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mk6XpTQ2LaRLcr2tA-d%2Fuploads%2Fgit-blob-26b3b4eef71989b27647ced7301b48dae31e4020%2Ffc15c751-6b66-4ade-9fd9-a631ff90edc7.png?alt=media" alt=""><figcaption><p>Worklfow diagram of the Single Sign-On functionality.</p></figcaption></figure>

## Setup

To setup Single Sign-On Commanders Act requires the metadata.xml of the IDP or following information:

* Single Sign-In Endpoint
* Single Sign-Out Endpoint
* Entity Id of the IDP
* Public key of the IDP (X509 certificate)

Please contact a Commanders Act consultant to initiate the setup. You will then receive a namespace parameter `<name>` and the site id `<id_site>` used in following SAML Endpoints and SAML Attributes.

### SAML Endpoints

Following you will find an overview of the SAML API endpoints used by Commanders Act.

**ACS URL/Endpoint URL**\
<https://platform.commandersact.com/saml2-acs/\\><name>

**Login URL**\
<https://platform.commandersact.com/saml/\\><name>

**SP Entity ID/Partner's Realm**\
commanders-act

### SAML Attributes

Following SAML attributes are currently supported. It is required to send the email attribute.

| Attribute                  | Description          | Type                                                                                                                                                                                        |
| -------------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| firstname                  | User first name      | optional, default empty                                                                                                                                                                     |
| lastName                   | User last name       | optional, default empty                                                                                                                                                                     |
| email                      | User email           | **required**                                                                                                                                                                                |
| companyName                | Company name         | optional, default empty                                                                                                                                                                     |
| jobTitle                   | Job title            | optional, default empty                                                                                                                                                                     |
| mobileNumber               | Mobile phone number  | optional, default empty                                                                                                                                                                     |
| lang                       | User language code   | optional, default 'en'                                                                                                                                                                      |
| commandersact\_\<id\_site> | Applied user profile | <p><strong>required</strong>, possible values :</p><ul><li>administrator</li><li>technical</li><li>marketing</li><li>custom</li><li>readOnly</li><li>partnerAdmin</li><li>partner</li></ul> |

Add "administrator|accountmanager" to enable the "Account Manager" permission for the Administrator role.

## FAQ

**How long is the SAML session duration?**\
1440 seconds.

**Which protocol is used for Single Sign-On?**\
SAML 2.0


---

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://doc.commandersact.com/configure/administration/single-sign-on.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.