Skip to content

Commit bf5e6a7

Browse files
iambmeltBrian Melton-GraceS3Prototype
authored
Update docs for Azure AD product rename (now Microsoft Entra ID) (#1314)
[Azure AD was renamed to Microsoft Entra ID last year](https://learn.microsoft.com/en-us/entra/fundamentals/new-name#naming-changes-and-exceptions). This PR updates references in our docs to use the new naming. In some places you will see existing references to `Entra ID` changed to `Microsoft Entra ID` to align with Microsoft's branding ([example](https://learn.microsoft.com/en-us/entra/identity/role-based-access-control/permissions-reference#global-administrator:~:text=administrative%20features%20in-,Microsoft%20Entra%20ID,-%2C%20as%20well%20as)) -- the product name is "Microsoft Entra ID" not just "Entra ID". Please review (somewhat) carefully, this PR was mostly done with `grep` / `sed`. I've given it a twice-over to ensure changes make sense in context. I have also updated links to Microsoft documentation to use the latest versions/URLs of reference articles on `learn.microsoft.com` --------- Co-authored-by: Brian Melton-Grace <[email protected]> Co-authored-by: Shaquil Hansford <[email protected]>
1 parent 3a801e2 commit bf5e6a7

File tree

13 files changed

+81
-81
lines changed

13 files changed

+81
-81
lines changed

docs/guides/device-gateway/agent.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This guide will walk you through an example scenario using ngrok to set up a sec
2525

2626
Consider a situation where a network of smart factories is coming online, each with IoT-connected machines, telemetry sensors, and a real-time monitoring dashboard.
2727

28-
In this scenario, each factory's network blocks inbound connections, but the technicians need temporary access to the dashboard. The telemetry API and sensor database must remain permanently accessible from the company's cloud, and access to the dashboard must be authenticated via Azure AD.
28+
In this scenario, each factory's network blocks inbound connections, but the technicians need temporary access to the dashboard. The telemetry API and sensor database must remain permanently accessible from the company's cloud, and access to the dashboard must be authenticated via Microsoft Entra ID.
2929

3030
Each factory would only need one ngrok agent running.
3131

docs/guides/other-guides/security-dev-productivity/security-dev-productivity.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ ngrok lets you configure authentication in different ways:
8080

8181
### Enterprise authentication and MFA
8282

83-
Use any OIDC-compliant provider—such as Okta, Microsoft Azure AD or AD
83+
Use any OIDC-compliant provider—such as Okta, Microsoft Entra ID or AD
8484
FS, Ping, and Auth0—to control access to public endpoints.
8585

8686
With the [`openid-connect` Traffic Policy
@@ -200,7 +200,7 @@ className="border rounded"
200200

201201
## Add SSO and MFA to the admin UI
202202

203-
With Dashboard SSO, you can restrict access to the ngrok administrative interface only for users authenticated in your identity providers — such as Okta, Azure AD, Ping, AD FS, and Auth0. The ngrok dashboard SSO works with any SAML provider, and can be used with your identity provider MFA — i.e., Windows Hello, Okta Verify, FIDO, and PingID — to ensure two-factor authentication (2FA) in compliance with your security requirements.
203+
With Dashboard SSO, you can restrict access to the ngrok administrative interface only for users authenticated in your identity providers — such as Okta, Microsoft Entra ID, Ping, AD FS, and Auth0. The ngrok dashboard SSO works with any SAML provider, and can be used with your identity provider MFA — i.e., Windows Hello, Okta Verify, FIDO, and PingID — to ensure two-factor authentication (2FA) in compliance with your security requirements.
204204

205205
<img
206206
src={require('./img/mfa-sso.png').default}

docs/iam/sso.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ ngrok supports identity providers which support either SAML or OpenID Connect fo
2323
SSO including
2424
[Okta](https://help.okta.com/oie/en-us/Content/Topics/Apps/apps-about-saml.htm)
2525
and [Microsoft
26-
AzureAD](https://learn.microsoft.com/en-us/azure/active-directory/fundamentals/auth-saml).
26+
AzureAD](https://learn.microsoft.com/en-us/entra/architecture/auth-saml).
2727

2828
## Enforcement
2929

@@ -78,7 +78,7 @@ to log in. The description provided when configuring the IdP in your account wil
7878
ngrok supports a limited subset of [RFC
7979
7644](https://datatracker.ietf.org/doc/html/rfc7644) to enable SCIM
8080
provisioning and deprovisioning. ngrok's SCIM implementation works with major
81-
IdPs like Okta and Azure AD.
81+
IdPs like Okta and Microsoft Entra ID.
8282

8383
ngrok's SCIM API Base URL is:
8484

docs/integrations/azure-ad/index.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
name: azure-ad
3-
title: Azure AD Integration Hub
4-
sidebar_label: Azure AD
2+
name: microsoft-entra-id
3+
title: Microsoft Entra ID Integration Hub
4+
sidebar_label: Microsoft Entra ID
55
description: |
6-
Secure access to ngrok tunnels with Azure Active Directory.
6+
Secure access to ngrok tunnels with Microsoft Entra ID.
77
No VPNs, Firewalls, or complex network rules required.
88
excerpt: |
9-
Secure access to ngrok tunnels with Azure Active Directory.
9+
Secure access to ngrok tunnels with Microsoft Entra ID.
1010
---
1111

1212
import IntegrationPageList from "@site/src/components/IntegrationPageList";

docs/integrations/azure-ad/k8s.mdx

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
description: Add ingress to any app running in Kubernetes, then restrict access to only users authorized through Microsoft Entra ID, using the ngrok Kubernetes Operator.
33
---
44

5-
# Ingress to apps secured by Azure AD (Microsoft Entra ID) in Kubernetes
5+
# Ingress to apps secured by Microsoft Entra ID in Kubernetes
66

77
:::tip TL;DR
88

9-
To use the ngrok Kubernetes Operator with Azure AD (Microsoft Entra ID):
9+
To use the ngrok Kubernetes Operator with Microsoft Entra ID:
1010

1111
1. [Create a cluster and deploy an example app](#create-cluster-deploy-example-app)
1212
2. [Add the ngrok Kubernetes Operator](#add-the-ngrok-kubernetes-operator)
@@ -22,18 +22,18 @@ Microsoft Azure Active Directory (AD)—now known as [Microsoft Entra ID](https:
2222

2323
:::note
2424

25-
In October 2023, Microsoft Azure Active Directory (AD) was [renamed Microsoft Entra ID](https://learn.microsoft.com/en-us/entra/fundamentals/new-name) to "communicate the multicloud, multiplatform functionality" and "alleviate confusion with Windows Server Active Directory." This name change changes nothing about the product or its capabilities. We have used **Azure AD** up to this point due to the recency of the change, but will use **Entra ID** for the remainder.
25+
In October 2023, Azure Active Directory (AD) was [renamed to Microsoft Entra ID](https://learn.microsoft.com/en-us/entra/fundamentals/new-name) to "communicate the multicloud, multiplatform functionality" and "alleviate confusion with Windows Server Active Directory." This name change changes nothing about the product or its capabilities. We have used **Microsoft Entra ID** up to this point due to the recency of the change, but will use **Entra ID** for the remainder.
2626

2727
:::
28+
b
29+
The ngrok Kubernetes Operator and Microsoft Entra ID integrate by letting you not only route public traffic to an app deployed on a Kubernetes cluster, but also restrict access only to users who you have authorized through Microsoft Entra ID.
2830

29-
The ngrok Kubernetes Operator and Entra ID integrate by letting you not only route public traffic to an app deployed on a Kubernetes cluster, but also restrict access only to users who you have authorized through Entra ID.
30-
31-
With this guide, you'll (optionally) create a new Kubernetes cluster and example deployment and install the ngrok Kubernetes Operator to securely route traffic through the [ngrok Cloud Edge](https://ngrok.com/product/cloud-edge). You'll then use the ngrok dashboard to enable Security Assertion Markup Language (SAML), using Entra ID as your identity provider, to authorize specific users with a single sign-on experience.
31+
With this guide, you'll (optionally) create a new Kubernetes cluster and example deployment and install the ngrok Kubernetes Operator to securely route traffic through the [ngrok Cloud Edge](https://ngrok.com/product/cloud-edge). You'll then use the ngrok dashboard to enable Security Assertion Markup Language (SAML), using Microsoft Entra ID as your identity provider, to authorize specific users with a single sign-on experience.
3232

3333
:::caution This tutorial requires:
3434

3535
1. An [ngrok account](https://ngrok.com/signup) at the [**pay-as-you-go** or **custom**](https://ngrok.com/pricing) tiers.
36-
2. A Microsoft Azure account with access to an existing Entra ID tenant or the ability to create a new tenant with an Entra ID P1 or P2 license.
36+
2. A Microsoft Azure account with access to an existing Microsoft Entra ID tenant or the ability to create a new tenant with an Microsoft Entra ID P1 or P2 license.
3737
3. A Kubernetes cluster, either locally or in a public cloud, with an app you'd like to be publicly accessible to specific users.
3838

3939
:::
@@ -154,7 +154,7 @@ Next, you'll configure and deploy the [ngrok Kubernetes Operator](https://github
154154

155155
## **Step 3**: Update your ngrok Edge to enable SAML {#update-your-ngrok-edge-to-enable-SAML}
156156

157-
Your Kubernetes-based app is now publicly accessible through the ngrok Cloud Edge—to restrict access to only authorized users with proper Entra ID credentials, you first need to enable SAML on your Edge.
157+
Your Kubernetes-based app is now publicly accessible through the ngrok Cloud Edge—to restrict access to only authorized users with proper Microsoft Entra ID credentials, you first need to enable SAML on your Edge.
158158

159159
1. Navigate to the [**Edges** section](https://dashboard.ngrok.com/edges) of the ngrok dashboard and click on the Edge created by the ngrok Kubernetes Operator. The domain name should match your `NGROK_DOMAIN`, and you should see **Created by kubernetes-ingress-controller** in the edge's description.
160160

@@ -176,11 +176,11 @@ Your Kubernetes-based app is now publicly accessible through the ngrok Cloud Edg
176176

177177
With SAML configured on your ngrok Edge, you can now configure Microsoft Entra ID to operate as your identity provider, often called **IdP**.
178178

179-
1. Access your [Entra ID tenant](https://portal.azure.com/#view/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/~/Overview) in the Azure console.
179+
1. Access your [Microsoft Entra ID tenant](https://portal.azure.com/#view/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/~/Overview) in the Azure console.
180180

181181
1. Click **Enterprise applications** in the left-hand sidebar, then **+ New application**, and finally **+ Create your own application**. Give your app a name—for our example, `online-boutique` will work nicely, and make sure you've selected the **Integrate any other application you don't find in the gallery (Non-gallery)** option.
182182

183-
![Create an application on Amazon Entra ID](img/k8s_create-app.png)
183+
![Create an application on Amazon Microsoft Entra ID](img/k8s_create-app.png)
184184

185185
1. Click **Create** to build your enterprise app, which will take you to its Overview dashboard.
186186

@@ -196,7 +196,7 @@ With SAML configured on your ngrok Edge, you can now configure Microsoft Entra I
196196

197197
1. In the **SAML Certificates** box, download the **Federation Metadata XML**.
198198

199-
## **Step 5**: Finish adding Entra ID authorization to your ngrok Edge {#finish-adding-entra-ID-authorization-ngrok-edge}
199+
## **Step 5**: Finish adding Microsoft Entra ID authorization to your ngrok Edge {#finish-adding-entra-ID-authorization-ngrok-edge}
200200

201201
Time to head back to your ngrok dashboard to finish the SAML configuration.
202202

@@ -208,23 +208,23 @@ Time to head back to your ngrok dashboard to finish the SAML configuration.
208208

209209
## **Step 6**: Test authorization to your app using Microsoft Entra ID {#test-authorization-using-microsoft-entra-id}
210210

211-
You've finished integrating the ngrok Kubernetes Operator and Microsoft Entra ID! Your app, whether the Online Boutique used throughout this guide or a custom deployment, is now publicly accessible only to those authorized with their Entra ID credentials. Time to test how it works:
211+
You've finished integrating the ngrok Kubernetes Operator and Microsoft Entra ID! Your app, whether the Online Boutique used throughout this guide or a custom deployment, is now publicly accessible only to those authorized with their Microsoft Entra ID credentials. Time to test how it works:
212212

213213
1. Open an incognito/private window in your browser, or a different browser than you've used so far, and navigate again to your `NGROK_DOMAIN`. You should see a single sign-on screen from Microsoft.
214214

215215
![The single sign-on screen from Microsoft](img/k8s_sso-enabled.png)
216216

217-
2. Enter credentials for a Microsoft account you assigned, either as an individual user or a group, to your enterprise application in Entra ID during [step 4](#create-an-enterprise-app).
217+
2. Enter credentials for a Microsoft account you assigned, either as an individual user or a group, to your enterprise application in Microsoft Entra ID during [step 4](#create-an-enterprise-app).
218218

219-
Behind the scenes, ngrok requests your identity provider, Microsoft Entra ID, for authentication. Once you sign in, or are already logged in, Entra ID then returns a SAML assertion to ngrok, telling ngrok your authentication is confirmed and you have authorization to access the app.
219+
Behind the scenes, ngrok requests your identity provider, Microsoft Entra ID, for authentication. Once you sign in, or are already logged in, Microsoft Entra ID then returns a SAML assertion to ngrok, telling ngrok your authentication is confirmed and you have authorization to access the app.
220220

221-
Entra ID will then redirect you back to your app!
221+
Microsoft Entra ID will then redirect you back to your app!
222222

223223
## What's next?
224224

225-
You've now integrated the ngrok Kubernetes Operator with Microsoft Entra ID to restrict access to your app to only authenticated users. With ngrok operating as middleware, handling both ingress to your Kubernetes cluster and the handshake with an Entra ID as an identity provider, you can deploy and secure new apps in a multi-cloud environment using your existing Microsoft/Azure identity and access management settings.
225+
You've now integrated the ngrok Kubernetes Operator with Microsoft Entra ID to restrict access to your app to only authenticated users. With ngrok operating as middleware, handling both ingress to your Kubernetes cluster and the handshake with an Microsoft Entra ID as an identity provider, you can deploy and secure new apps in a multi-cloud environment using your existing Microsoft/Azure identity and access management settings.
226226

227-
From an end user perspective, they only need to sign in once, using their Microsoft credentials, to authenticate themselves and access any number of applications you manage using Entra ID.
227+
From an end user perspective, they only need to sign in once, using their Microsoft credentials, to authenticate themselves and access any number of applications you manage using Microsoft Entra ID.
228228

229229
From here, you have a few options:
230230

docs/integrations/azure-ad/sso-saml.mdx

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
---
2-
description: Use Microsoft Azure AD to secure access to ngrok tunnels
2+
description: Use Microsoft Entra ID to secure access to ngrok tunnels
33
---
44

5-
# Azure Active Directory SSO (SAML)
5+
# Microsoft Entra ID SSO (SAML)
66

77
:::tip TL;DR
8-
To have ngrok enforce Single Sign-On using SAML with Azure Active Directory (Azure AD):
8+
To have ngrok enforce Single Sign-On using SAML with Microsoft Entra ID:
99

1010
1. [Create an ngrok Edge](#create-edge)
11-
1. [Create an Azure AD application](#create-app)
11+
1. [Create a Microsoft Entra ID application](#create-app)
1212
1. [Update the ngrok Edge with the IdP metadata](#update-ngrok-edge)
1313
1. [Test your integration](#test-integration)
1414
1. [Bonus: configure ngrok to enforce authorization based on Azure groups](#bonus)
1515

1616
:::
1717

18-
This article details how to configure Azure AD as an Identity Provider for your ngrok Edge. By integrating Azure AD with ngrok, you can:
18+
This article details how to configure Microsoft Entra ID as an Identity Provider for your ngrok Edge. By integrating Microsoft Entra ID with ngrok, you can:
1919

20-
- Restrict access to ngrok tunnels to only users who authenticated via Azure AD
21-
- Configure Azure AD and ngrok to enforce user and group authorization
22-
- Use Azure AD's dashboard to facilitate access to ngrok applications
20+
- Restrict access to ngrok tunnels to only users who authenticated via Microsoft Entra ID
21+
- Configure Microsoft Entra ID and ngrok to enforce user and group authorization
22+
- Use Microsoft Entra ID's dashboard to facilitate access to ngrok applications
2323

2424
## Requirements
2525

26-
To configure ngrok tunnels with Azure AD, you must have:
26+
To configure ngrok tunnels with Microsoft Entra ID, you must have:
2727

2828
- an [ngrok Enterprise Account](https://ngrok.com/pricing) with an authtoken or admin access to configure edges with SAML
29-
- a Microsoft Azure account with access to an Azure AD tenant
29+
- a Microsoft Azure account with access to an Microsoft Entra ID tenant
3030

3131
## Step 1: Create an ngrok Edge {#create-edge}
3232

@@ -36,7 +36,7 @@ To configure ngrok tunnels with Azure AD, you must have:
3636

3737
1. Click **New Edge**
3838
1. Click **HTTPS Edge**
39-
1. Click the **Pencil Icon** next to "no description". Enter _Edge With Azure Active Directory SSO_ as the Edge name and click **Save**
39+
1. Click the **Pencil Icon** next to "no description". Enter _Edge With Microsoft Entra ID SSO_ as the Edge name and click **Save**
4040

4141
1. Configure the SAML module for this Edge:
4242

@@ -52,11 +52,11 @@ To configure ngrok tunnels with Azure AD, you must have:
5252

5353
1. Click **Save**
5454

55-
1. Note that ngrok has now generated values for the fields in the Service Provider section. You will need to configure Azure AD with these values later
55+
1. Note that ngrok has now generated values for the fields in the Service Provider section. You will need to configure Microsoft Entra ID with these values later
5656

57-
## Step 2: Create an Azure AD application {#create-app}
57+
## Step 2: Create an Microsoft Entra ID application {#create-app}
5858

59-
1. Go to your [Azure AD tenant in Azure](https://portal.azure.com/#view/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/~/Overview)
59+
1. Go to your [Microsoft Entra ID tenant in Azure](https://portal.azure.com/#view/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/~/Overview)
6060

6161
1. Create an enterprise application
6262

@@ -85,7 +85,7 @@ To configure ngrok tunnels with Azure AD, you must have:
8585

8686
## Step 3: Update the ngrok Edge with the IdP metadata {#update-ngrok-edge}
8787

88-
1. Back in the ngrok dashboard for your Edge's SAML configuration, upload the XML file generated by Azure AD
88+
1. Back in the ngrok dashboard for your Edge's SAML configuration, upload the XML file generated by Microsoft Entra ID
8989

9090
![img/3-1.png](img/3-1.png)
9191

@@ -140,7 +140,7 @@ For this step, we assume you have an app running locally (i.e. on localhost:3000
140140
![img/5-3.png](img/5-3.png)
141141

142142
1. Click **Save**
143-
1. Go to your group page and copy the object Id (Azure AD returns group object Ids in the group claim)
143+
1. Go to your group page and copy the object Id (Microsoft Entra ID returns group object Ids in the group claim)
144144

145145
![img/5-5.png](img/5-5.png)
146146

docs/integrations/azure-logs-ingestion/event-destination.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,11 +128,11 @@ You now have a **Data Collection Rule** properly configured for ngrok events, al
128128

129129
These steps were adapted from the [Create a Microsoft Entra Application](https://learn.microsoft.com/en-us/azure/azure-monitor/logs/tutorial-logs-ingestion-portal?source=recommendations#create-microsoft-entra-application) docs from Microsoft.
130130

131-
1. Navigate to the search bar and type in **Entra ID**.
131+
1. Navigate to the search bar and type in **Microsoft Entra ID**.
132132

133133
2. Select the **Microsoft Entra ID** under **Services**, not the Marketplace item.
134134

135-
![search entra id](img/search-entra.png)
135+
![search Microsoft Entra ID](img/search-entra.png)
136136

137137
3. Navigate to **Manage -> App registrations** on the sidebar.
138138

@@ -146,7 +146,7 @@ These steps were adapted from the [Create a Microsoft Entra Application](https:/
146146

147147
![register app](img/register.png)
148148

149-
You have now created an **Entra ID App Registration**, which is a service user construct that grants roles/access to services like ngrok.
149+
You have now created an **Microsoft Entra ID App Registration**, which is a service user construct that grants roles/access to services like ngrok.
150150

151151
## **Step 5**: Assign IAM permissions to the Application for the DCR {#dcr-iam}
152152

@@ -197,7 +197,7 @@ In order to create an event destination in your ngrok Dashboard, we will need to
197197
- the DCR stream name
198198
- the DCE log ingestion URI
199199

200-
1. To gather the first three fields, we will navigate back to **Entra ID**. Search for **Entra** in the top search bar and select the **Entra ID** service.
200+
1. To gather the first three fields, we will navigate back to **Microsoft Entra ID**. Search for **Entra** in the top search bar and select the **Microsoft Entra ID** service.
201201

202202
2. Navigate to **Manage -> App registrations** in the sidebar, and select the application you created in [**Step 4**](#entra-application).
203203

0 commit comments

Comments
 (0)