{
  "schema_version": 2,
  "id": "operate/rs/references/rest-api/objects/sso",
  "title": "SSO object",
  "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/objects/sso/",
  "summary": "An object for single sign-on (SSO) configuration",
  "tags": [
    "docs",
    "operate",
    "rs"
  ],
  "last_updated": "2025-12-22T11:45:26-06:00",
  "page_type": "content",
  "content_hash": "1f085787020ccfffe314287f321c6b60b742aa2c8634dbc15783859eb2a990bd",
  "sections": [
    {
      "id": "content",
      "title": "Content",
      "role": "content",
      "text": "An API object that represents single sign-on (SSO) configuration in the cluster.\n\n| Name | Type/Value | Description |\n|------|------------|-------------|\n| control_plane | boolean (default: false) | If `true`, enables single sign-on (SSO) for the control plane. |\n| enforce_control_plane | boolean (default: false) | If `true`, enforce SSO login for the control plane for non-admin users. If `false`, all users can still login using their local username and password if SSO is down. |\n| protocol | \"saml2\" | SSO protocol to use. |\n| issuer | complex object\t | Issuer related configuration.<br>Contains the following fields:<br>**id**: Unique ID of the issuer side (example: \"urn:sso:example:idp\")<br>**login_url**: SSO login URL (example: \"https://idp.example.com/sso/saml\")<br>**logout_url**: SSO logout URL (example: \"https://idp.example.com/sso/slo\")<br />**metadata**: Base64 encoded IdP metadata (read-only) |\n| service | complex object\t | Service related configuration.<br />For SAML2 service configuration:<br />{\n  \"address\": \"string\",\n  \"saml2\": {\n    \"entity_id\": \"string\",\n    \"acs_url\": \"string\",\n    \"slo_url\": \"string\"\n  }\n}<br>**address**: External service address used for SSO. By default, the cluster name with the Cluster Manager port is used.<br />**acs_url**: Assertion Consumer Service URL (read-only)<br>**slo_url**: Single Logout URL (read-only)<br>**entity_id**: Service entity ID (read-only) |"
    }
  ],
  "examples": []
}