SSO

✨ Retrieve SAML2 Settings

Changed on
<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.
get/api/saml/settings

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/api/saml/settings
  • Auth
    API key in header Authorization

Response

acs_urlstring nullable required
domainstring

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_providerstring nullable

Identity Provider preset key (e.g. okta, azure, google, custom)

login_urlstring nullable required
logout_urlstring nullable required
manual_role_managementboolean nullable

Allow manually assigning organization roles instead of IdP-managed groups. None = use billing default.

mapping_emailstring nullable

Mapping attributes: user email from SAML request

mapping_first_namestring nullable

Mapping attributes: user first name from SAML request

mapping_groupsstring nullable

Mapping attributes: groups attribute for user mapping to workspaces and roles

mapping_last_namestring nullable

Mapping attributes: user last name from SAML request

metadata_urlstring

URL SAML metadata from IdP

metadata_xmlstring

Metadata XML file

metadata_xml_urlstring nullable required
nameid_formatstring required
tokenstring
user_type_capacitiesobject required

Live seat usage and limits by seat type (Standard, View Only, Flex).

Changes

  • caa722a934c3Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status