---
title: "✨ Retrieve SAML2 Settings"
method: GET
path: "/api/saml/settings"
tags: ["SSO"]
---

# ✨ Retrieve SAML2 Settings

`GET /api/saml/settings`

<Card href="https://humansignal.com/goenterprise">
        <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
        <p style="margin-top: 10px; font-size: 14px;">
            This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
        </p>
    </Card>
Retrieve SAML2 settings for the currently active organization.

## Response `200`

- SamlSettings — Serializer for reading SAML settings (GET requests). Includes all model fields plus computed read-only fields for SP URLs that are needed for IdP configuration.
  - `acs_url` string, nullable, required
  - `domain` string — Organization web domain or domains; use comma separated list with no spaces for multiple. Example:<br><br>labelstud.io,humansignal.com<br><br>IMPORTANT: DO NOT PUT COMMON DOMAINS LIKE GMAIL.COM, YAHOO.COM, ETC. IN THIS FIELD
  - `idp_provider` string, nullable — Identity Provider preset key (e.g. okta, azure, google, custom)
  - `login_url` string, nullable, required
  - `logout_url` string, nullable, required
  - `manual_role_management` boolean, nullable — Allow manually assigning organization roles instead of IdP-managed groups. None = use billing default.
  - `mapping_email` string, nullable — Mapping attributes: user email from SAML request
  - `mapping_first_name` string, nullable — Mapping attributes: user first name from SAML request
  - `mapping_groups` string, nullable — Mapping attributes: groups attribute for user mapping to workspaces and roles
  - `mapping_last_name` string, nullable — Mapping attributes: user last name from SAML request
  - `metadata_url` string — URL SAML metadata from IdP
  - `metadata_xml` string — Metadata XML file
  - `metadata_xml_url` string, nullable, required
  - `nameid_format` string, required
  - `projects_groups` ProjectGroup[], nullable — Projects to Groups Mapping. List of objects with project_id, group, role.
    - `group` string, required — Group name
    - `project_id` integer, required — Project ID
    - `role` 'Inherit' | 'Annotator' | 'Reviewer', required — * `Inherit` - Inherit * `Annotator` - Annotator * `Reviewer` - Reviewer
  - `roles_groups` array[], nullable — Organization Roles to Groups Mapping. List of [role_name, group_name] pairs.
    - string[]
  - `token` string
  - `workspaces_groups` array[], nullable — Workspaces to Groups Mapping. List of [workspace_title, group_name] pairs.
    - string[]

---

[API](https://skmtc.net/humansignal/apis/label-studio-api.md) · [All operations](https://skmtc.net/humansignal/apis/label-studio-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/humansignal/label-studio-api/versions/1b113b8df950/schema)
