Skip to content

Commit 6bd30bf

Browse files
v-edmckillopv-edmckillop
authored
Update partner-biocatch.md
1 parent a0a8905 commit 6bd30bf

File tree

1 file changed

+64
-65
lines changed

1 file changed

+64
-65
lines changed

‎articles/active-directory-b2c/partner-biocatch.md

Lines changed: 64 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -16,69 +16,66 @@ ms.subservice: B2C
1616

1717
# Tutorial: Configure BioCatch with Azure Active Directory B2C
1818

19-
In this sample tutorial, learn how to integrate Azure Active Directory (AD) B2C authentication with [BioCatch](https://www.biocatch.com/) to further augment your Customer Identity and Access Management (CIAM) security posture. BioCatch analyzes a user's physical and cognitive digital behaviors to generate insights that distinguish between legitimate customers and cyber-criminals.
19+
Learn how to integrate Azure Active Directory B2C (Azure AD B2C) authentication with BioCatch technology to augment your Customer Identity and Access Management (CIAM) security posture. BioCatch products analyze user physical and cognitive digital behaviors for insights that help distinguish legitimate customers.
2020

21-
## Prerequisites
22-
23-
To get started, you'll need:
21+
Go to biocatch.com to learn more [BioCatch](https://www.biocatch.com/)
2422

25-
- An Azure subscription. If you don't have a subscription, you can get a [free account](https://azure.microsoft.com/free/).
23+
## Prerequisites
2624

27-
- [An Azure AD B2C tenant](tutorial-create-tenant.md) that is linked to your Azure subscription.
25+
To get started, you need:
2826

29-
- A [BioCatch](https://www.biocatch.com/contact-us) account.
27+
* An Azure subscription
28+
* If you don't have one, get an [Azure free account](https://azure.microsoft.com/free/)
29+
* An Azure AD B2C tenant linked to the Azure subscription
30+
* See, [Tutorial: Create an Azure Active Directory B2C tenant](tutorial-create-tenant.md)
31+
* Go to the biocatch.com [Contact Us](https://www.biocatch.com/contact-us) page to request an account
32+
* Mention Azure AD B2C integration
3033

3134
## Scenario description
3235

3336
BioCatch integration includes the following components:
3437

35-
- **A web app or web service** - The user first browses to this web service. This web service instantiates a unique client session ID that is sent to BioCatch. The client session ID then immediately begins transmitting user behavior characteristics to BioCatch.
36-
37-
- **A method** - Sends the unique client session ID to Azure AD B2C. In the provided example, JavaScript is used to input the value into a hidden HTML field.
38-
39-
- **An Azure AD B2C customized UI** - Hides an HTML field for the client session ID input from JavaScript, if using the above method
40-
41-
- **Azure AD B2C custom policy**
42-
43-
- Takes the custom client session ID from the UI in the form of a claim. This is achieved via a self-asserted technical profile
38+
* **A web app or web service** - users browse to this web service that instantiates a unique client session ID that goes to BioCatch
39+
* The session ID transmits user behavior characteristics to BioCatch
40+
* **A method** - sends the session ID to Azure AD B2C. In the example, JavaScript inputs the value into a hidden HTML field.
41+
* **An Azure AD B2C customized UI** - hides an HTML field for the session ID input from JavaScript
42+
* **Azure AD B2C custom policy**:
43+
* Takes the session ID as a claim via a self-asserted technical profile
44+
* Integrates with BioCatch via a REST API claims provider and passes the session ID to BioCatch
45+
* Multiple custom claims return from BioCatch for the custom policy logic
46+
* A user journey evaluates a returned claim, and executes a conditional action, such as multi-factor authentication
4447

45-
- Integrates with BioCatch via a REST API claims provider and passes the client session ID to the BioCatch platform
48+
Learn more:
4649

47-
- Multiple custom claims are returned from BioCatch for the custom policy logic to then act upon
50+
* [Azure AD B2C custom policy overview](custom-policy-overview.md)
51+
* [Tutorial: Create user flows and custom policies in Azure AD B2C](./tutorial-create-user-flows.md?pivots=b2c-custom-policy&tabs=applications)
4852

49-
- A userjourney, which evaluates a returned claim, for example, session risk, and conditionally executes an action, such as invoke Multi-factor authentication (MFA).
53+
The following diagram illustrates user flows with session information.
5054

51-
![Diagram of the bio catch architecture.](media/partner-biocatch/biocatch-architecture-diagram.png)
55+
![Diagram of user flows with session information.](media/partner-biocatch/biocatch-architecture-diagram.png)
5256

53-
| Step | Description |
54-
|:---|:-----------------------|
55-
|1a | The user browses the web service. The web service then returns HTML, CSS, or JavaScript values and configures to load the BioCatch JavaScript SDK. Client-side JavaScript configures/sets client session ID for the BioCatch SDK. Alternately, the web service can pre-configure client session ID and send to the client. |
56-
|1b | Configure the instantiated BioCatch JavaScript SDK against the BioCatch platform. Immediately begin to send user behavior characteristics to BioCatch from the client device, using the client session ID from step 1a. |
57-
|2 | User tries to sign-up/sign-in and is redirected to Azure AD B2C. |
58-
|3a | Part of the userjourney is a self-asserted claimsprovider, which takes the client session ID as input. This field is hidden on the screen. You can use JavaScript to input the session ID into the field. Select the *next* button, to continue the sign-up/sign-in process.|
59-
|3b | The client session ID is submitted to the BioCatch platform to determine a risk score. |
60-
|3c | BioCatch returns information about the session, such as risk score, and a recommendation on what to do – allow or block |
61-
|3d |The userjourney has a conditional check step, which acts upon the returned claims|
62-
| 4 | Based on the conditional check result, an action such as *step-up MFA* is invoked|
63-
|5 | At any time from when the user first hits the web service page, the web service can use the client session ID to query the BioCatch API to determine risk score and session information in real-time. |
57+
1. The user browses to the web service, which returns HTML, CSS, or JavaScript values, then loads the BioCatch JavaScript SDK. Client-side JavaScript configures a client session ID for the BioCatch SDK. Alternately, the web service pre-configures client session ID and sends it to the client. You can configure the instantiated BioCatch JavaScript SDK for BioCatch, which sends user behavior to BioCatch from the client device, using the client session ID.
58+
2. User signs-up or signs-in and is redirected to Azure AD B2C.
59+
3. The user journey includes a self-asserted claimsprovider, which inputs the client session ID. This field is hidden. Use JavaScript to input the session ID into the field. Select **Next**, to continue sign-up or sign-in. The session ID goes to BioCatch for a risk score. BioCatch returns session information, and recommends allow or block. The user journey has a conditional check, which acts upon the returned claims.
60+
4. Based on the conditional check result, an action is invoked.
61+
5. The web service can use the session ID to query BioCatch API to determine risk and session information.
6462

65-
## Onboard with BioCatch
63+
## Get started with BioCatch
6664

67-
Contact [BioCatch](https://www.biocatch.com/contact-us) and create an account.
65+
Go to the biocatch.com [Contact Us](https://www.biocatch.com/contact-us) page to initiate an account.
6866

6967
## Configure the custom UI
7068

71-
It's recommended to hide the client session ID field. Use CSS, JavaScript, or any other method to hide the field. For testing purposes, you may unhide the field. For example, JavaScript is used to hide the input field as:
69+
We recommended you hide the Client Session ID field with CSS, JavaScript, or another method. For testing, unhide the field. For example, JavaScript hides the input field as:
7270

7371
```JavaScript
7472
document.getElementById("clientSessionId").style.display = 'none';
7573
```
7674

77-
## Configure Azure AD B2C Identity Experience Framework policies
75+
## Configure Azure AD B2C Identity Experience Framework policies
7876

79-
1. Configure the initial [custom policy configuration](./tutorial-create-user-flows.md?pivots=b2c-custom-policy).
80-
81-
2. Create a new file, which inherits from the extensions file.
77+
1. To get started, See [Tutorial: Create user flows and custom policies in Azure AD B2C](./tutorial-create-user-flows.md?pivots=b2c-custom-policy).
78+
2. Create a new file that inherits from the extensions file.
8279

8380
```xml
8481
<BasePolicy>
@@ -106,7 +103,7 @@ document.getElementById("clientSessionId").style.display = 'none';
106103
</ContentDefinitions>
107104
```
108105

109-
4. Add the following claims under the BuildingBlocks resource.
106+
4. Under the BuildingBlocks resource, add the following claims.
110107

111108
```xml
112109
<ClaimsSchema>
@@ -140,7 +137,7 @@ document.getElementById("clientSessionId").style.display = 'none';
140137
</ClaimsSchema>
141138
```
142139

143-
5. Configure self-asserted claims provider for the client session ID field.
140+
5. Configure a self-asserted claims provider for the client session ID field.
144141

145142
```xml
146143
<ClaimsProvider>
@@ -184,7 +181,7 @@ document.getElementById("clientSessionId").style.display = 'none';
184181
</ClaimsProvider>
185182
```
186183

187-
6. Configure REST API claims provider for BioCatch.
184+
6. Configure a REST API claims provider for BioCatch.
188185

189186
```xml
190187
<TechnicalProfile Id="BioCatch-API-GETSCORE">
@@ -233,15 +230,13 @@ document.getElementById("clientSessionId").style.display = 'none';
233230
```
234231

235232
> [!NOTE]
236-
> BioCatch will provide you the URL, customer ID and unique user ID (UUID) to configure. The customer SessionID claim is passed through as a query string parameter to BioCatch. You can choose the activity type, for example *MAKE_PAYMENT*.
237-
238-
7. Configure the userjourney; follow the example
239-
240-
1. Get the clientSessionID as a claim
233+
> BioCatch provides the URL, customer ID, and unique user ID (UUID). The customer SessionID claim passes through as a query string parameter to BioCatch. You can select the activity type, for example **MAKE_PAYMENT**.
241234

242-
1. Call the BioCatch API to get the session information
235+
7. Configure the user journey using the following example:
243236

244-
1. If the returned claim *risk* equals *low*, skip the step for MFA, else force user MFA
237+
* Get the clientSessionID as a claim.
238+
* Call BioCatch API to get the session information.
239+
* If the returned claim risk is **low**, skip the step for MFA, otherwise enforce user MFA.
245240

246241
```xml
247242
<OrchestrationStep Order="8" Type="ClaimsExchange">
@@ -287,9 +282,7 @@ document.getElementById("clientSessionId").style.display = 'none';
287282
</ClaimsExchanges>
288283
```
289284

290-
8. Configure on relying party configuration (optional)
291-
292-
It is useful to pass the BioCatch returned information to your application as claims in the token, specifically *risklevel* and *score*.
285+
8. Configure relying party (optional). You can pass the BioCatch returned information to your application as claims in the token: risklevel and score.
293286

294287
```xml
295288
<RelyingParty>
@@ -345,21 +338,28 @@ document.getElementById("clientSessionId").style.display = 'none';
345338

346339
## Integrate with Azure AD B2C
347340

348-
Follow these steps to add the policy files to Azure AD B2C
341+
Add the policy files to Azure AD B2C. For the following instructions, use the directory with the Azure AD B2C tenant.
349342

350-
1. Sign in to the [**Azure portal**](https://portal.azure.com/) as the global administrator of your Azure AD B2C tenant.
351-
1. Make sure you're using the directory that contains your Azure AD B2C tenant. Select the **Directories + subscriptions** icon in the portal toolbar.
352-
1. On the **Portal settings | Directories + subscriptions** page, find your Azure AD B2C directory in the **Directory name** list, and then select **Switch**.
353-
1. Choose **All services** in the top-left corner of the Azure portal, search for and select Azure AD B2C.
354-
1. Navigate to **Azure AD B2C** > **Identity Experience Framework**
355-
1. Upload all the policy files to your tenant.
343+
1. Sign in to the [**Azure portal**](https://portal.azure.com/) as the Global Administrator of the Azure AD B2C tenant.
344+
1. In the portal toolbar, select **Directories + subscriptions**.
345+
1. On the **Portal settings, Directories + subscriptions** page, in the **Directory name** list, locate the Azure AD B2C directory.
346+
2. Select **Switch**.
347+
3. In the top-left corner of the Azure portal, select **All services**.
348+
4. Search for and select **Azure AD B2C**.
349+
5. Navigate to **Azure AD B2C** > **Identity Experience Framework**.
350+
6. Upload the policy files to the tenant.
356351

357352
## Test the solution
358353

359-
1. [Register a dummy application, which redirects to JWT.MS](./tutorial-register-applications.md?tabs=app-reg-ga)
360-
1. Under the **Identity Experience Framework**, select the policy you created
361-
1. In the policy window, select the dummy JWT.MS application, and select **run now**
362-
1. Go through sign-up flow and create an account. Token returned to JWT.MS should have 2x claims for riskLevel and score. Follow the example.
354+
For the following instructions, see [Tutorial: Register a web application in Azure Active Directory B2C](./tutorial-register-applications.md?tabs=app-reg-ga)
355+
356+
1. Register a dummy application that redirects to JWT.MS.
357+
2. Under **Identity Experience Framework**, select the policy you created.
358+
3. In the policy window, select the dummy JWT.MS application
359+
4. Select **run now**.
360+
5. Perform a sign-up flow and create an account.
361+
6. The token returned to JWT.MS has 2x claims for riskLevel and score.
362+
7. Use the following example.
363363

364364
```JavaScript
365365
{
@@ -412,6 +412,5 @@ Follow these steps to add the policy files to Azure AD B2C
412412

413413
## Additional resources
414414

415-
- [Custom policies in Azure AD B2C](./custom-policy-overview.md)
416-
417-
- [Get started with custom policies in Azure AD B2C](./tutorial-create-user-flows.md?pivots=b2c-custom-policy&tabs=applications)
415+
* [Azure AD B2C custom policy overview](./custom-policy-overview.md)
416+
* [Tutorial: Create user flows and custom policies in Azure AD B2C](./tutorial-create-user-flows.md?pivots=b2c-custom-policy&tabs=applications)

0 commit comments

Comments
 (0)