Skip to content

Commit 160f2d8

Browse files
committed
DOC-5858 RS: Added more info about enforce_control_plane SSO to RS REST API reference
1 parent b60236a commit 160f2d8

File tree

1 file changed

+1
-1
lines changed
  • content/operate/rs/references/rest-api/objects

1 file changed

+1
-1
lines changed

content/operate/rs/references/rest-api/objects/sso.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ An API object that represents single sign-on (SSO) configuration in the cluster.
1515
| Name | Type/Value | Description |
1616
|------|------------|-------------|
1717
| control_plane | boolean (default: false) | If `true`, enables single sign-on (SSO) for the control plane. |
18-
| enforce_control_plane | boolean (default: false) | Enforce SSO login for the control plane for non-admin users. |
18+
| 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. |
1919
| protocol | "saml2" | SSO protocol to use. |
2020
| issuer | complex object | 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") |
2121
| service | complex object | Service related configuration.<br />For SAML2 service configuration:<br />{{<code>}}{

0 commit comments

Comments
 (0)