You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/active-directory/external-identities/tutorial-bulk-invite.md
+38-30Lines changed: 38 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
3
3
title: Tutorial for bulk inviting B2B collaboration users - Azure AD
4
-
description: In this tutorial, you learn how to use PowerShell and a CSV file to send bulk invitations to external Azure AD B2B collaboration users. You'll use the Microsoft.Graph.Users PowerShell module.
4
+
description: In this tutorial, you learn how to send bulk invitations using a CSV file to external Azure AD B2B collaboration users.
# Tutorial: Bulk invite Azure AD B2B collaboration users
22
22
23
-
If you use Azure Active Directory (Azure AD) B2B collaboration to work with external partners, you can invite multiple guest users to your organization at the same time. In this tutorial, you learn how to use the Azure portal to send bulk invitations to external users. Specifically, you'll follow these steps:
23
+
If you use [Azure Active Directory (Azure AD) B2B collaboration](what-is-b2b.md) to work with external partners, you can invite multiple guest users to your organization at the same time. In this tutorial, you learn how to use the Azure portal to send bulk invitations to external users. Specifically, you'll follow these steps:
24
24
25
25
> [!div class="checklist"]
26
+
>
26
27
> * Use **Bulk invite users** to prepare a comma-separated value (.csv) file with the user information and invitation preferences
27
28
> * Upload the .csv file to Azure AD
28
29
> * Verify the users were added to the directory
29
30
30
31
If you don’t have Azure Active Directory, create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
31
32
32
-
## Understand the CSV template
33
-
34
-
Download and fill in the bulk upload CSV template to help you successfully invite Azure AD guest users in bulk. The CSV template you download might look like this example:
35
-
36
-
37
-
38
-
### CSV template structure
39
-
40
-
The rows in a downloaded CSV template are as follows:
41
-
42
-
-**Version number**: The first row containing the version number must be included in the upload CSV.
43
-
-**Column headings**: The format of the column headings is <*Item name*>[PropertyName]<*Required or blank*>. For example, `Email address to invite [inviteeEmail] Required`. Some older versions of the template might have slight variations.
44
-
-**Examples row**: We've included in the template a row of examples of values for each column. You must remove the examples row and replace it with your own entries.
45
-
46
-
### Additional guidance
47
-
48
-
- The first two rows of the upload template must not be removed or modified, or the upload can't be processed.
49
-
- The required columns are listed first.
50
-
- We don't recommend adding new columns to the template. Any columns you add are ignored and not processed.
51
-
- We recommend that you download the latest version of the CSV template as often as possible.
52
33
53
34
## Prerequisites
54
35
55
36
You need two or more test email accounts that you can send the invitations to. The accounts must be from outside your organization. You can use any type of account, including social accounts such as gmail.com or outlook.com addresses.
56
37
38
+
57
39
## Invite guest users in bulk
58
40
59
41
1. Sign in to the Azure portal with an account that is a global administrator in the organization.
60
42
2. In the navigation pane, select **Azure Active Directory**.
:::image type="content" source="media/tutorial-bulk-invite/bulk-invite-button.png" alt-text="Screenshot of the bulk invite button.":::
65
47
66
-
4. On the **Bulk invite users** page, select **Download** to get a valid .csv template with invitation properties.
67
48
68
-
49
+
4. On the **Bulk invite users** page, select **Download** to get a [valid .csv template](tutorial-bulk-invite.md#understand-the-csv-template) with invitation properties.
50
+
51
+
:::image type="content" source="media/tutorial-bulk-invite/download-button.png" alt-text="Screenshot of the download the csv file button.":::
69
52
70
53
1. Open the .csv template and add a line for each guest user. Required values are:
71
54
72
55
***Email address to invite** - the user who will receive an invitation
73
56
74
57
***Redirection url** - the URL to which the invited user is forwarded after accepting the invitation. If you want to forward the user to the My Apps page, you must change this value to https://myapps.microsoft.com or https://myapplications.microsoft.com.
75
58
76
-
59
+
:::image type="content" source="media/tutorial-bulk-invite/bulk-invite-csv.png" alt-text="Screenshot of the example csv file with guest users entered.":::
77
60
78
61
> [!NOTE]
79
62
> Don't use commas in the **Customized invitation message** because they'll prevent the message from being parsed successfully.
@@ -84,10 +67,34 @@ You need two or more test email accounts that you can send the invitations to. T
84
67
9. When your file passes validation, select **Submit** to start the Azure bulk operation that adds the invitations.
85
68
10. To view the job status, select **Click here to view the status of each operation**. Or, you can select **Bulk operation results** in the **Activity** section. For details about each line item within the bulk operation, select the values under the **# Success**, **# Failure**, or **Total Requests** columns. If failures occurred, the reasons for failure will be listed.
86
69
87
-
70
+
:::image type="content" source="media/tutorial-bulk-invite/bulk-operation-results.png" alt-text="Screenshot of the bulk operation results." lightbox="media/tutorial-bulk-invite/bulk-operation-results.png":::
71
+
88
72
89
73
11. When the job completes, you'll see a notification that the bulk operation succeeded.
90
74
75
+
76
+
## Understand the CSV template
77
+
78
+
Download and fill in the bulk upload CSV template to help you successfully invite Azure AD guest users in bulk. The CSV template you download might look like this example:
79
+
80
+
81
+
82
+
### CSV template structure
83
+
84
+
The rows in a downloaded CSV template are as follows:
85
+
86
+
-**Version number**: The first row containing the version number must be included in the upload CSV.
87
+
-**Column headings**: The format of the column headings is <*Item name*>[PropertyName]<*Required or blank*>. For example, `Email address to invite [inviteeEmail] Required`. Some older versions of the template might have slight variations.
88
+
-**Examples row**: We've included in the template a row of examples of values for each column. You must remove the examples row and replace it with your own entries.
89
+
90
+
### Additional guidance
91
+
92
+
- The first two rows of the upload template must not be removed or modified, or the upload can't be processed.
93
+
- The required columns are listed first.
94
+
- We don't recommend adding new columns to the template. Any columns you add are ignored and not processed.
95
+
- We recommend that you download the latest version of the CSV template as often as possible.
96
+
97
+
91
98
## Verify guest users in the directory
92
99
93
100
Check to see that the guest users you added exist in the directory either in the Azure portal or by using PowerShell.
@@ -128,7 +135,8 @@ For example: `Remove-MgUser -UserId "lstokes_fabrikam.com#EXT#@contoso.onmicroso
128
135
129
136
## Next steps
130
137
131
-
In this tutorial, you sent bulk invitations to guest users outside of your organization. Next, learn how the invitation redemption process works.
138
+
In this tutorial, you sent bulk invitations to guest users outside of your organization. Next, learn how the invitation redemption process works, and how to enforce multi-factor authentication for guest users.
139
+
132
140
133
-
> [!div class="nextstepaction"]
134
-
> [Learn about the Azure AD B2B collaboration invitation redemption process](redemption-experience.md)
141
+
-[Learn about the Azure AD B2B collaboration invitation redemption process](redemption-experience.md)
142
+
-[Enforce multi-factor authentication for B2B guest users](b2b-tutorial-require-mfa.md)
0 commit comments