Skip to content

Commit 362055b

Browse files
committed
DOC-5858 RS: Added SSO certs to RS REST API reference and certs list
1 parent 3eba31d commit 362055b

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@ An API object that represents a certificate used by a Redis Enterprise Software
1414

1515
| Name | Type/Value | Description |
1616
|------|------------|-------------|
17-
| name | `cm`<br />`api`<br />`mtls_trusted_ca`<br />`proxy`<br />`metrics_exporter`<br />`syncer`<br />`ldap_client`<br />`ccs_internode_encryption`<br />`data_internode_encryption` | Certificate type.<br />See the [certificates table]({{< relref "/operate/rs/security/certificates" >}}) for the list of cluster certificates and their descriptions. |
17+
| name | "cm"<br />"api"<br />"mtls_trusted_ca"<br />"proxy"<br />"metrics_exporter"<br />"syncer"<br />"ldap_client"<br />"ccs_internode_encryption"<br />"data_internode_encryption"<br />"sso_service"<br />"sso_issuer" | Certificate type.<br />See the [certificates table]({{< relref "/operate/rs/security/certificates" >}}) for the list of cluster certificates and their descriptions. |
1818
| certificate | string | The certificate in PEM format |
1919
| key | string | The private key in PEM format |

content/operate/rs/security/certificates/_index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,11 @@ Here's the list of supported certificates that create secure, encrypted connecti
2929
| `metrics_exporter` | <span title="Yes">&#x2705;</span> | Sends Redis Enterprise metrics to external [monitoring tools]({{< relref "/operate/rs/monitoring/" >}}) over a secure connection. |
3030
| `mtls_trusted_ca` | <span title="No">:x:</span> | Required to enable certificate-based authentication for secure, passwordless access to the REST API. |
3131
| `proxy` | <span title="Yes">&#x2705;</span> | Creates secure, encrypted connections between clients and databases. |
32+
| `sso_issuer` | <span title="No">:x:</span> | Identity provider certificate for [single sign-on (SSO)]({{< relref "/operate/rs/security/access-control/saml-sso" >}}). |
33+
| `sso_service` | <span title="No">:x:</span> | Service provider certificate for [single sign-on (SSO)]({{< relref "/operate/rs/security/access-control/saml-sso" >}}). |
3234
| `syncer` | <span title="Yes">&#x2705;</span> | For [Active-Active]({{< relref "/operate/rs/databases/active-active/" >}}) or [Replica Of]({{< relref "/operate/rs/databases/import-export/replica-of/" >}}) databases, encrypts data during the synchronization of participating clusters. |
3335

34-
Certificates that are not autogenerated are optional unless you want to use certain features. For example, you must provide your own `ldap_client` certificate to enable [LDAP authentication]({{<relref "/operate/rs/security/access-control/ldap">}}) or an `mtls_trusted_ca` certificate to enable certificate-based authentication.
36+
Certificates that are not autogenerated are optional unless you want to use certain features. For example, you must provide your own `ldap_client` certificate to enable [LDAP authentication]({{<relref "/operate/rs/security/access-control/ldap">}}), an `mtls_trusted_ca` certificate to enable certificate-based authentication, or `sso_issuer` and `sso_service` certificates for [single sign-on (SSO)]({{<relref "/operate/rs/security/access-control/saml-sso">}}).
3537

3638
## Accept self-signed certificates to access the Cluster Manager UI
3739

0 commit comments

Comments
 (0)