Skip to content

Commit 2dd6182

Browse files
committed
DOC-5858 A few adjustments to RS SSO draft
1 parent 882a009 commit 2dd6182

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

content/operate/rs/security/access-control/saml-sso.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,10 @@ You can also initiate single sign-on from the Redis Enterprise Software Cluster
4646

4747
To set up SAML single sign-on for a Redis Enterprise Software cluster:
4848

49+
1. Upload the new service provider certificate and private key (PUT /v1/cluster/certificates /sso_service/ or Redis Enterprise Software Cluster Manager UI)
50+
51+
1. Export the metadata (GET /v1/cluster/sso/saml/metadata or Redis Enterprise Software Cluster Manager UI)
52+
4953
1. [Set up a SAML app](#set-up-app) to integrate Redis Enterprise Software with your identity provider.
5054

5155
1. [Configure SAML identity provider in Redis Enterprise Software](#configure-idp).
@@ -74,13 +78,17 @@ Set up a SAML app to integrate Redis Enterprise Software with your identity prov
7478

7579
1. Create or add a SAML integration app for the service provider Redis Enterprise Software.
7680

81+
1. Single sign-on URL: `https://<cluster-host>:8443/cluster/sso` <!-- Is this supposed to be visible in the CM UI or REST API? Or do I just need to provide this pattern? -->
82+
83+
1. Audience URI (SP Entity ID): `https://<cluster-host>/sp` <!-- Is this supposed to be visible in the CM UI or REST API? Or do I just need to provide this pattern? -->
84+
7785
1. Set up your SAML service provider app so the SAML assertion contains the following attributes:
7886

79-
| Attribute&nbsp;name<br />(case-sensitive) | Description |
87+
| Attribute name (case-sensitive) | Description |
8088
|-------------------------------------------|-------------|
81-
| FirstName | User's first name |
82-
| LastName | User's last name |
83-
| Email | User's email address (used as the username in the Redis Enterprise Software Cluster Manager UI) |
89+
| firstName | User's first name |
90+
| lastName | User's last name |
91+
| email | User's email address (used as the username in the Redis Enterprise Software Cluster Manager UI) |
8492
| redisRoleMapping | Key-value pair of a lowercase role name (owner, member, manager, billing_admin, or viewer) |
8593

8694
For `redisRoleMapping`, you can add the same user to multiple SAML-enabled accounts using one of these options:
@@ -116,16 +124,14 @@ To confirm the identity provider's SAML assertions contain the required attribut
116124

117125
If your identity provider lets you configure custom attributes with workflows or group rules, you can set up automation to configure the `redisRoleMapping` field automatically instead of manually.
118126

119-
### Configure SAML in Redis Enterprise Software {#configure-idp}
127+
### Configure SSO in Redis Enterprise Software {#configure-idp}
120128

121129
After you set up the SAML integration app and create a SAML user in your identity provider, you need to configure your Redis Enterprise Software cluster to set up SSO.
122130

123131
1. Sign in to Redis Enterprise Software Cluster Manager UI with the email address associated with the SAML user you set up with your identity provider.
124132

125133
1. Go to **Access Control > Single Sign-On**.
126134

127-
1. [Verify at least one domain](#verify-domain) if you haven't.
128-
129135
1. Configure the **Identity Provider metadata** settings.
130136

131137
{{<image filename="images/rc/access-management-saml-config.png" alt="SAML Single Sign-On configuration screen.">}}
@@ -161,8 +167,8 @@ Next, you need to download the service provider metadata for Redis Enterprise So
161167

162168
| XML attribute | Value | Description |
163169
|---------------|-------|-------------|
164-
| EntityDescriptor's **entityID** | https://<nobr>auth.redis.com</nobr>/saml2/<nobr>service-provider</nobr>/\<ID\> | Unique URL that identifies the Redis Enterprise Software service provider |
165-
| AssertionConsumerService's **Location** | <nobr> https://<nobr>auth.redis.com</nobr>/sso/saml2/\<ID\> | The service provider endpoint where the identity provider sends a SAML assertion that authenticates a user |
170+
| EntityDescriptor's **entityID** | https://auth.redis.com/saml2/service-provider/\<ID\> | Unique URL that identifies the Redis Enterprise Software service provider |
171+
| AssertionConsumerService's **Location** | https://auth.redis.com/sso/saml2/\<ID\> | The service provider endpoint where the identity provider sends a SAML assertion that authenticates a user |
166172

167173
- To use [IdP-initiated SSO](#idp-initiated-sso) with certain identity providers, you also need to set the RelayState parameter to the following URL:
168174

0 commit comments

Comments
 (0)