Azure Active Directory Toolkit
The Azure Active Directory Toolkit is a workflow node. Its tools include Create User, Get User, Update User, and Delete User, plus 3 more listed below. Connect an Azure Active Directory account before you use any of these tools. Type @ in a field when the value should come from an earlier step.
Authentication
Every Azure Active Directory tool needs a connected account before it can run. On the node, open Azure Active Directory Account.
- Choose Use my Azure Active Directory account or Use team account.
- If no personal account is connected, click Connect Azure Active Directory Account and finish sign-in.
- For a team account, choose Use team account and pick one from Team account. The list shows accounts already connected for the project.
Tools
Create User
Creates user.
| Field | Required | Description |
|---|---|---|
| Display Name | Yes | The name to display in the address book for the user. Type @ to select a variable. |
| User Principal Name | Yes | The user principal name (UPN) - must be unique and follow format: user@domain.com. Type @ to select a variable. |
| Password | Yes | Initial password for the user (minimum 8 characters). Type @ to select a variable. |
| Mail Nickname | No | The mail alias for the user (if not provided, derived from UPN). Default is null. Type @ to select a variable. |
| Given Name | No | The user's first name. Default is null. Type @ to select a variable. |
| Surname | No | The user's last name. Default is null. Type @ to select a variable. |
| Job Title | No | The user's job title. Default is null. Type @ to select a variable. |
| Department | No | The department where the user works. Default is null. Type @ to select a variable. |
| Office Location | No | The office location. Default is null. Type @ to select a variable. |
| Mobile Phone | No | The primary cellular telephone number. Default is null. Type @ to select a variable. |
| Business Phones | No | List of business telephone numbers. Default is null. |
| Force Change Password Next Sign In | No | Whether user must change password on next sign-in. Default is true. |
| Account Enabled | No | Whether the account is enabled. Default is true. |
Get User
Retrieves user.
| Field | Required | Description |
|---|---|---|
| Azure Active Directory Account | Yes | Select your personal or team Azure Active Directory account. |
| User ID | Yes | User ID (GUID) or user principal name (UPN) of the user to retrieve. Type @ to select a variable. |
Update User
Updates user.
| Field | Required | Description |
|---|---|---|
| Azure Active Directory Account | Yes | Select your personal or team Azure Active Directory account. |
| User ID | Yes | User ID (GUID) or user principal name (UPN) of the user to update. Type @ to select a variable. |
| Display Name | No | The name to display in the address book. Default is null. Type @ to select a variable. |
| Given Name | No | The user's first name. Default is null. Type @ to select a variable. |
| Surname | No | The user's last name. Default is null. Type @ to select a variable. |
| Job Title | No | The user's job title. Default is null. Type @ to select a variable. |
| Department | No | The department where the user works. Default is null. Type @ to select a variable. |
| Office Location | No | The office location. Default is null. Type @ to select a variable. |
| Mobile Phone | No | The primary cellular telephone number. Default is null. Type @ to select a variable. |
| Business Phones | No | List of business telephone numbers. Default is null. |
Delete User
Deletes user.
| Field | Required | Description |
|---|---|---|
| Azure Active Directory Account | Yes | Select your personal or team Azure Active Directory account. |
| User ID | Yes | User ID (GUID) or user principal name (UPN) of the user to delete. Type @ to select a variable. |
List Users
Lists users.
| Field | Required | Description |
|---|---|---|
| Azure Active Directory Account | Yes | Select your personal or team Azure Active Directory account. |
| Filter Query | No | OData filter query (e.g., "department eq 'Sales'"). Default is null. Type @ to select a variable. |
| Select Fields | No | Comma-separated list of fields to select (e.g., "id,displayName,mail"). Default is null. Type @ to select a variable. |
| Top | No | Maximum number of users to return. Default is null. |
Reset User Password
Runs the reset user password tool.
| Field | Required | Description |
|---|---|---|
| Azure Active Directory Account | Yes | Select your personal or team Azure Active Directory account. |
| User ID | Yes | User ID (GUID) or user principal name (UPN) of the user. Type @ to select a variable. |
| New Password | Yes | New password for the user (minimum 8 characters). Type @ to select a variable. |
| Force Change Password Next Sign In | No | Whether user must change password on next sign-in. Default is true. |
Enable Disable User
Runs the enable disable user tool.
| Field | Required | Description |
|---|---|---|
| Azure Active Directory Account | Yes | Select your personal or team Azure Active Directory account. |
| User ID | Yes | User ID (GUID) or user principal name (UPN) of the user. Type @ to select a variable. |
| Enabled | Yes | True to enable account, False to disable. Type @ to select a variable. |
Related
Agents can use this integration from chat. See Azure Active Directory.
See all integrations on the toolkits overview.