Skip to content

Commit 3043357

Browse files
authored
Merge pull request #250235 from kengaderdus/disable-signup-in-user-flow
[CIAM] Disable sign-up in a user flow.
2 parents 756fc70 + 2177311 commit 3043357

File tree

4 files changed

+34
-3
lines changed

4 files changed

+34
-3
lines changed

articles/active-directory/external-identities/customers/how-to-define-custom-attributes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ If your application relies on certain built-in or custom user attributes, you ca
4949

5050
1. Select **Create**. The custom attribute is now available in the list of user attributes and can be [added to your user flows](#include-custom-attributes-in-a-sign-up-flow).
5151

52-
### About referencing custom attributes
52+
### Referencing custom attributes
5353

5454
The custom attributes you create are added to the *b2c-extensions-app* registered in your customer tenant. If you want to call a custom attribute from an application or manage it via Microsoft Graph, use the naming convention `extension_<b2c-extensions-app-id>_<custom-attribute-name>` where:
5555

articles/active-directory/external-identities/customers/how-to-user-flow-sign-up-sign-in-customers.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.service: active-directory
88
ms.workload: identity
99
ms.subservice: ciam
1010
ms.topic: how-to
11-
ms.date: 07/12/2023
11+
ms.date: 09/04/2023
1212
ms.author: mimart
1313
ms.custom: it-pro
1414

@@ -89,6 +89,35 @@ You can choose the order in which the attributes are displayed on the sign-up pa
8989

9090
1. Select **Save**.
9191

92+
## Disable sign-up in a sign-up and sign-in user flow
93+
94+
If you want your customer users to only sign in and not sign up, you can disable sign-up experience in your user flow by using [Microsoft Graph API](microsoft-graph-operations.md). You need to know the ID of the user flow that you want whose sign-up you want to disable. You can't read the user flow ID from the Microsoft Entra Admin center, but you can retrieve it via Microsoft Graph API if you know the app associated with it.
95+
96+
1. Read the application ID associated with the user flow:
97+
1. Browse to **Identity > External Identities > User flows**.
98+
1. From the list, select your user flow.
99+
1. In the left menu, under **Use**, select **Applications**.
100+
1. From the list, under **Application (client) ID** column, copy the Application (client) ID.
101+
102+
1. Identify the ID of the user flow whose sign-up you want to disable. To do so, [List the user flow associated with the specific application](/graph/api/identitycontainer-list-authenticationeventsflows?#example-4-list-user-flow-associated-with-specific-application-id). This's a Microsoft Graph API, which requires you to know the application ID you obtained from the previous step.
103+
104+
1. [Update your user flow](/graph/api/authenticationeventsflow-update) to disable sign-up.
105+
106+
**Example**:
107+
108+
```http
109+
PATCH https://graph.microsoft.com/beta/identity/authenticationEventsFlows/{user-flow-id}
110+
{
111+
"@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow",
112+
"onInteractiveAuthFlowStart": {
113+
"@odata.type": "#microsoft.graph.onInteractiveAuthFlowStartExternalUsersSelfServiceSignUp",
114+
"isSignUpAllowed": "false"
115+
  }
116+
}
117+
```
118+
119+
Replace `{user-flow-id}` with the user flow ID that you obtained in the previous step. Notice the `isSignUpAllowed` parameter is set to *false*. To re-enable sign-up, make a call to the Microsoft Graph API endpoint, but set the `isSignUpAllowed` parameter to *true*.
120+
92121
## Next steps
93122
94123
- [Add your application to the user flow](how-to-user-flow-add-application.md)

articles/active-directory/external-identities/customers/microsoft-graph-operations.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.service: active-directory
99
ms.workload: identity
1010
ms.subservice: ciam
1111
ms.topic: how-to
12-
ms.date: 07/12/2023
12+
ms.date: 09/04/2023
1313
ms.custom: developer
1414

1515
#Customer intent: As a dev, devops, I want to learn how to use the Microsoft Graph to manage operations in my Azure AD customer tenant.
@@ -105,6 +105,7 @@ Configure pre-built policies for sign-up, sign-in, combined sign-up and sign-in,
105105
- [Create a user flow](/graph/api/identitycontainer-post-authenticationeventsflows)
106106
- [Get a user flow](/graph/api/authenticationeventsflow-get)
107107
- [Delete a user flow](/graph/api/authenticationeventsflow-delete)
108+
- [Update a user flow](/graph/api/authenticationeventsflow-update)
108109

109110
## Identity providers (Preview)
110111

articles/active-directory/external-identities/customers/toc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -260,6 +260,7 @@ items:
260260
href: how-to-register-ciam-app.md
261261
- name: Add a sign-up and sign-in flow
262262
href: how-to-user-flow-sign-up-sign-in-customers.md
263+
displayName: disable sign-up, disable sign up
263264
- name: Add an application to the user flow
264265
href: how-to-user-flow-add-application.md
265266
- name: Enable password reset

0 commit comments

Comments
 (0)