{
  "id": "sso",
  "title": "SSO object",
  "url": "https://redis.io/docs/latest/operate/rs/8.0/references/rest-api/objects/sso/",
  "summary": "An object for single sign-on (SSO) configuration",
  "content": "\nAn 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.\u003cbr\u003eContains the following fields:\u003cbr\u003e**id**: Unique ID of the issuer side (example: \"urn:sso:example:idp\")\u003cbr\u003e**login_url**: SSO login URL (example: \"https://idp.example.com/sso/saml\")\u003cbr\u003e**logout_url**: SSO logout URL (example: \"https://idp.example.com/sso/slo\")\u003cbr /\u003e**metadata**: Base64 encoded IdP metadata (read-only) |\n| service | complex object\t | Service related configuration.\u003cbr /\u003eFor SAML2 service configuration:\u003cbr /\u003e{\n  \"address\": \"string\",\n  \"saml2\": {\n    \"entity_id\": \"string\",\n    \"acs_url\": \"string\",\n    \"slo_url\": \"string\"\n  }\n}\u003cbr\u003e**address**: External service address used for SSO. By default, the cluster name with the Cluster Manager port is used.\u003cbr /\u003e**acs_url**: Assertion Consumer Service URL (read-only)\u003cbr\u003e**slo_url**: Single Logout URL (read-only)\u003cbr\u003e**entity_id**: Service entity ID (read-only) |\n",
  "tags": ["docs","operate","rs"],
  "last_updated": "2026-07-23T12:05:56-05:00"
}