Skip to content

Commit d3f3964

Browse files
committed
Minor correction.
1 parent 7dbc06e commit d3f3964

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

articles/active-directory/external-identities/self-service-sign-up-secure-api-connector.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,25 @@ services: active-directory
55
ms.service: active-directory
66
ms.subservice: B2B
77
ms.topic: article
8-
ms.date: 07/16/2021
8+
ms.date: 02/15/2023
99

1010
ms.author: mimart
1111
author: msmimart
1212
manager: celestedg
1313
ms.custom: "it-pro"
14-
ms.collection: M365-identity-device-management
14+
ms.collection: engagement-fy23, M365-identity-device-management
15+
16+
# Customer intent: As a tenant administrator, I want to make sure that I protect my API endpoint with proper authentication.
1517
---
1618

1719
# Secure your API used an API connector in Azure AD External Identities self-service sign-up user flows
1820

19-
When integrating a REST API within an Azure AD external identities self-service sign-up user flow, you must protect your REST API endpoint with authentication. The REST API authentication ensures that only services that have proper credentials, such as Azure AD, can make calls to your endpoint. This article will explore how to secure REST API.
21+
When integrating a REST API within an Azure AD external identities self-service sign-up user flow, you must protect your REST API endpoint with authentication. The REST API authentication ensures that only services that have proper credentials, such as Azure AD, can make calls to your endpoint. This article explores how to secure REST API.
2022

2123
## Prerequisites
2224
Complete the steps in the [Walkthrough: Add an API connector to a sign-up user flow](self-service-sign-up-add-api-connector.md) guide.
2325

24-
You can protect your API endpoint by using either HTTP basic authentication or HTTPS client certificate authentication. In either case, you provide the credentials that Azure AD will use when calling your API endpoint. Your API endpoint then checks the credentials and performs authorization decisions.
26+
You can protect your API endpoint by using either HTTP basic authentication or HTTPS client certificate authentication. In either case, you provide the credentials that Azure AD uses when calling your API endpoint. Your API endpoint then checks the credentials and performs authorization decisions.
2527

2628

2729
## HTTP basic authentication
@@ -81,17 +83,17 @@ Your API must implement the authorization based on sent client certificates in o
8183
../../api-management/api-management-howto-mutual-certificates-for-clients.md) against desired values.
8284

8385
### Renewing certificates
84-
It's recommended you set reminder alerts for when your certificate will expire. You will need to generate a new certificate and repeat the steps above when used certificates are about to expire. To "roll" the use of a new certificate, your API service can continue to accept old and new certificates for a temporary amount of time while the new certificate is deployed.
86+
It's recommended you set reminder alerts for when your certificate expires. You'll need to generate a new certificate and repeat the steps above when used certificates are about to expire. To "roll" the use of a new certificate, your API service can continue to accept old and new certificates for a temporary amount of time while the new certificate is deployed.
8587

86-
To upload a new certificate to an existing API connector, select the API connector under **API connectors** and click on **Upload new certificate**. The most recently uploaded certificate which is not expired and whose start date has passed will automatically be used by Azure AD.
88+
To upload a new certificate to an existing API connector, select the API connector under **API connectors** and select on **Upload new certificate**. The most recently uploaded certificate that isn't expired and whose start date has passed will automatically be used by Azure AD.
8789

8890
:::image type="content" source="media/secure-api-connector/api-connector-renew-cert.png" alt-text="Providing a new certificate to an API connector when one already exists.":::
8991

9092
## API key authentication
9193

9294
Some services use an "API key" mechanism to obfuscate access to your HTTP endpoints during development by requiring the caller to include a unique key as an HTTP header or HTTP query parameter. For [Azure Functions](../../azure-functions/functions-bindings-http-webhook-trigger.md#authorization-keys), you can accomplish this by including the `code` as a query parameter in the **Endpoint URL** of your API connector. For example, `https://contoso.azurewebsites.net/api/endpoint`<b>`?code=0123456789`</b>).
9395

94-
This is not a mechanism that should be used alone in production. Therefore, configuration for basic or certificate authentication is always required. If you do not wish to implement any authentication method (not recommended) for development purposes, you can select 'basic' authentication in the API connector configuration and use temporary values for `username` and `password` that your API can disregard while you implement proper authorization.
96+
This isn't a mechanism that should be used alone in production. Therefore, configuration for basic or certificate authentication is always required. If you don't wish to implement any authentication method (not recommended) for development purposes, you can select 'basic' authentication in the API connector configuration and use temporary values for `username` and `password` that your API can disregard while you implement proper authorization.
9597

9698
## Next steps
9799
- Get started with our [quickstart samples](code-samples-self-service-sign-up.md#api-connector-azure-function-quickstarts).

0 commit comments

Comments
 (0)