Skip to content

Commit 5461480

Browse files
authored
docs: fix entra id mixup (#4110)
* docs: fix entra id mixup * docs: fix SAML wrong steps
1 parent 2fc1faa commit 5461480

1 file changed

Lines changed: 38 additions & 27 deletions

File tree

  • docs/production-deployment/cloud

docs/production-deployment/cloud/saml.mdx

Lines changed: 38 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
id: saml
33
title: SAML authentication
44
sidebar_label: SAML authentication
5-
description: Integrate SAML 2.0 with your Temporal Cloud account for secure user authentication. Connect via Microsoft Entra ID or Okta and ensure seamless SSO. Charges apply.
5+
description:
6+
Integrate SAML 2.0 with your Temporal Cloud account for secure user authentication. Connect via Microsoft Entra ID or
7+
Okta and ensure seamless SSO. Charges apply.
68
slug: /cloud/saml
79
toc_max_heading_level: 4
810
keywords:
@@ -16,7 +18,8 @@ tags:
1618
- Users
1719
---
1820

19-
To authenticate the users of your Temporal Cloud account, you can connect an identity provider (IdP) to your account by using Security Assertion Markup Language (SAML) 2.0.
21+
To authenticate the users of your Temporal Cloud account, you can connect an identity provider (IdP) to your account by
22+
using Security Assertion Markup Language (SAML) 2.0.
2023

2124
:::info
2225

@@ -26,28 +29,29 @@ SAML is a paid feature. See the [pricing page](/cloud/pricing) for details.
2629

2730
## Integrate SAML with your Temporal Cloud account
2831

29-
1. Locate your [Temporal Cloud Account Id](/cloud/namespaces#temporal-cloud-account-id).
30-
Your Account Id can be viewed and copied from the Temporal Cloud user profile dropdown menu in the top right corner.
31-
Alternatively, find your [Namespace Id](/cloud/namespaces#temporal-cloud-namespace-id).
32-
The Account Id is the five or six characters following the period (.), such as `f45a2`.
33-
You will need the Account Id to construct your callback URL and your entity identifier.
32+
1. Locate your [Temporal Cloud Account Id](/cloud/namespaces#temporal-cloud-account-id). Your Account Id can be viewed
33+
and copied from the Temporal Cloud user profile dropdown menu in the top right corner. Alternatively, find your
34+
[Namespace Id](/cloud/namespaces#temporal-cloud-namespace-id). The Account Id is the five or six characters following
35+
the period (.), such as `f45a2`. You will need the Account Id to construct your callback URL and your entity
36+
identifier.
3437
1. Configure SAML with your IdP by following one of these sets of instructions:
3538
- [Microsoft Entra ID](#configure-saml-with-azure-ad)
3639
- [Okta](#configure-saml-with-okta)
3740
1. [Share your connection information with us and test your connection.](#finish-saml-configuration)
3841

3942
## How to configure SAML with Microsoft Entra ID {#configure-saml-with-azure-ad}
4043

41-
If you want to use the general Microsoft login mechanism, you don't need to set up SAML with Entra ID.
42-
Just select **Continue with Microsoft** on the Temporal Cloud sign-in page.
44+
If you want to use the general Microsoft login mechanism, you don't need to set up SAML with Entra ID. Just select
45+
**Continue with Microsoft** on the Temporal Cloud sign-in page.
4346

4447
To use Entra ID as your SAML IdP, create a Microsoft Entra ID Enterprise application.
4548

4649
1. Sign in to the [Microsoft Entra ID](https://portal.azure.com/).
4750
1. On the home page, under **Manage Microsoft Entra ID**, select **View**.
4851
1. On the **Overview** page near the top, select **Add > Enterprise application**.
4952
1. On the **Browse Microsoft Entra ID Gallery** page near the top, select **Create your own application**.
50-
1. In the **Create your own application** pane, provide a name for your application (such as `temporal-cloud`) and select **Integrate any other application you don't find in the gallery**.
53+
1. In the **Create your own application** pane, provide a name for your application (such as `temporal-cloud`) and
54+
select **Integrate any other application you don't find in the gallery**.
5155
1. Select **Save**.
5256
1. In the **Getting Started** section, select **2. Set up single sign on**.
5357
1. On the **Single sign-on** page, select **SAML**.
@@ -64,7 +68,8 @@ To use Entra ID as your SAML IdP, create a Microsoft Entra ID Enterprise applica
6468
urn:auth0:prod-tmprl:f45a2-saml
6569
```
6670

67-
1. In **Reply URL (Assertion Consumer Service URL)**, enter the following callback URL, including your Account Id where indicated:
71+
1. In **Reply URL (Assertion Consumer Service URL)**, enter the following callback URL, including your Account Id where
72+
indicated:
6873

6974
```bash
7075
https://login.tmprl.cloud/login/callback?connection=ACCOUNT_ID-saml
@@ -88,14 +93,18 @@ To use Entra ID as your SAML IdP, create a Microsoft Entra ID Enterprise applica
8893
https://cloud.temporal.io/login/saml?connection=f45a2-saml
8994
```
9095

91-
1. You can leave the other fields blank.
92-
Near the top of the pane, select **Save**.
93-
1. In the **Attributes & Claims** section, select **Edit**.
94-
1. We require the user's full email address when connecting to Temporal.
95-
In the **Required claim** section, set **email** and **name**.
96-
Verify that **Unique User Identifier (NameID)** is set to `user.userprincipalname [nameid-format:emailAddress]`.
96+
1. You can leave the other fields blank. Near the top of the pane, select **Save**.
97+
1. In the **Attributes & Claims** section, select **Edit**. Configure the following settings. Under **Required claim**:
98+
99+
- Set **Unique User Identifier (NameID)** to `user.userprincipalname`
100+
- Set the **NameID format** to `emailAddress`
101+
102+
These are the default settings for Microsoft Entra ID. Then under **Additional claims**, ensure **Email** and
103+
**Name** are present.
104+
97105
1. Collect information that you need to send to us:
98-
- In the **SAML Certificates** section of the **SAML-based Sign-on** page, select the download link for **Certificate (Base64)**.
106+
- In the **SAML Certificates** section of the **SAML-based Sign-on** page, select the download link for **Certificate
107+
(Base64)**.
99108
- In the **Set up _APPLICATION_NAME_** section of the **SAML-based Sign-on** page, copy the value of **Login URL**.
100109

101110
To finish setting up Microsoft Entra ID as your SAML IdP, see [Finish SAML configuration](#finish-saml-configuration).
@@ -108,8 +117,10 @@ To use Okta as your SAML IdP, configure a new Okta application integration.
108117
1. In the left navigation pane, select **Applications > Applications**.
109118
1. On the **Applications** page, select **Create App Integration**.
110119
1. In the **Create a new app integration** dialog, select **SAML 2.0** and then select **Next**.
111-
1. On the **Create SAML Integration** page in the **General Settings** section, provide a name for your application (such as `temporal-cloud`) and then select **Next**.
112-
1. In the **Configure SAML** section in **Single sign on URL**, enter the following callback URL, including your Account Id where indicated:
120+
1. On the **Create SAML Integration** page in the **General Settings** section, provide a name for your application
121+
(such as `temporal-cloud`) and then select **Next**.
122+
1. In the **Configure SAML** section in **Single sign on URL**, enter the following callback URL, including your Account
123+
Id where indicated:
113124

114125
```bash
115126
https://login.tmprl.cloud/login/callback?connection=ACCOUNT_ID-saml
@@ -145,7 +156,8 @@ To use Okta as your SAML IdP, configure a new Okta application integration.
145156
- Copy the IdP settings.
146157
- Download the active certificate.
147158

148-
To finish setting up Okta as your SAML IdP, see the next section, [Finish SAML configuration](#finish-saml-configuration).
159+
To finish setting up Okta as your SAML IdP, see the next section,
160+
[Finish SAML configuration](#finish-saml-configuration).
149161

150162
## How to finish your SAML configuration {#finish-saml-configuration}
151163

@@ -156,10 +168,9 @@ After you configure SAML with your IdP, we can finish the configuration on our s
156168
- The X.509 SAML sign-in certificate in PEM format
157169
- One or more IdP domains to map to the SAML connection
158170

159-
Generally, the provided IdP domain is the same as the domain for your email address.
160-
You can provide multiple IdP domains.
171+
Generally, the provided IdP domain is the same as the domain for your email address. You can provide multiple IdP
172+
domains.
161173

162-
When you receive confirmation from us that we have finished configuration, log in to Temporal Cloud.
163-
This time, though, enter your email address in **Enterprise identity** and select **Continue**.
164-
Do not select **Continue with Google** or **Continue with Microsoft**.
165-
You will be redirected to the authentication page of your IdP.
174+
When you receive confirmation from us that we have finished configuration, log in to Temporal Cloud. This time, though,
175+
enter your email address in **Enterprise identity** and select **Continue**. Do not select **Continue with Google** or
176+
**Continue with Microsoft**. You will be redirected to the authentication page of your IdP.

0 commit comments

Comments
 (0)