Azure AD: Users
Summary
This module contains actions for managing Users in Azure AD.
Actions
azure_ad.users.
clear_automatic_replies
Clear a user's automatic replies settings.
Minimum Plugin Version: 2.0.0
Input
-
client: an AzureClient
-
user_principal_name: the User's principal name
Output
Nothing is outputted by this action.
Example
1 2 3 4 | |
azure_ad.users.
create
Create a user.
This action will do nothing if a user with the supplied principal name already exists.
Minimum Plugin Version: 1.0.0
Input
-
client: an AzureClient
-
display_name: a display name for the user
-
mail_nickname: a mail alias for the user
-
user_principal_name: the User's principal name
-
password: a password to set for the user
-
enabled: set to
falseto create the user in a disabled state (defaults totrue) -
force_password_change: set to
trueto force password reset on first logon (defaults tofalse) -
force_password_change_mfa: set to
trueto force password reset with MFA on first logon (defaults tofalse)
Output
Nothing is outputted by this action.
Example
1 2 3 4 5 6 7 8 9 10 | |
azure_ad.users.
delete
Delete a user.
This action will do nothing if the supplied user does not exist.
Minimum Plugin Version: 1.0.0
Input
-
client: an AzureClient
-
user_principal_name: the User's principal name
Output
Nothing is outputted by this action.
Example
1 2 3 4 | |
azure_ad.users.
disable
Disable a user.
Minimum Plugin Version: 1.0.0
Input
-
client: an AzureClient
-
user_principal_name: the User's principal name
Output
Nothing is outputted by this action.
Example
1 2 3 4 | |
azure_ad.users.
display
Display users in a table.
The table will have the following columns:
- Display Name
- User Principal Name
- Email Address
- Enabled
Minimum Plugin Version: 1.0.0
Input
-
text: the title of the table
-
users: any number of Users
Output
Nothing is outputted by this action.
Example
1 2 3 4 5 6 7 8 9 | |
azure_ad.users.
enable
Enable a user.
Minimum Plugin Version: 1.0.0
Input
-
client: an AzureClient
-
user_principal_name: the User's principal name
Output
Nothing is outputted by this action.
Example
1 2 3 4 | |
azure_ad.users.
force_password_change
Force the supplied user to reset their password at next logon.
Minimum Plugin Version: 1.0.0
Required API Permissions
See passwordProfile in this table for the required API permissions & roles.
Input
-
client: an AzureClient
-
user_principal_name: the User's principal name
Output
Nothing is outputted by this action.
Example
1 2 3 4 | |
azure_ad.users.
get_all
Get all users.
Minimum Plugin Version: 1.0.0
Input
- client: an AzureClient
Output
A list of Users.
Example
1 2 3 4 | |
azure_ad.users.
get_automatic_replies
Get the supplied user's automatic replies settings.
Minimum Plugin Version: 2.0.0
Input
-
client: an AzureClient
-
user_principal_name: the User's principal name
Output
Example
1 2 3 4 5 | |
azure_ad.users.
get_by_id
Get the user with the supplied user ID.
Minimum Plugin Version: 1.0.0
Input
-
client: an AzureClient
-
user_id: the User ID
Output
A single User.
Example
1 2 3 4 5 | |
azure_ad.users.
get_by_principal_name
Get the user with the supplied user principal name.
Minimum Plugin Version: 1.0.0
Input
-
client: an AzureClient
-
user_principal_name: the User's principal name
Output
A single User.
Example
1 2 3 4 5 | |
azure_ad.users.
get_free_principal_name
Takes a list of user principal names & finds the first that is currently available.
Minimum Plugin Version: 1.0.0
Input
-
client: an AzureClient
-
user_principal_names: a list of userPrincipalNames to check
Output
Either the first available user_principal_name or null if they are all in use.
Example
1 2 3 4 5 6 7 8 | |
azure_ad.users.
get_interactive
Allow the task operator to search for & select a User interactively.
Minimum Plugin Version: 1.1.0
Input
- client: an AzureClient
Output
A single User.
Automatic Wildcards
When using this action all provided search terms will have a wildcard appended.
Example
1 2 3 4 | |
azure_ad.users.
get_manager
Get the supplied user's manager.
Minimum Plugin Version: 1.0.0
Input
-
client: an AzureClient
-
user_principal_name: the User's principal name
Output
Either a User if the supplied user has a manager, or null if they do not.
Example
1 2 3 4 5 | |
azure_ad.users.
get_security_groups
Get a list of security groups the supplied user is a member of.
Minimum Plugin Version: 1.0.0
Input
-
client: an AzureClient
-
user_principal_name: the User's principal name
Output
A list of SecurityGroups.
Example
1 2 3 4 | |
azure_ad.users.
remove_manager
Remove the supplied user's manager.
Minimum Plugin Version: 1.0.0
Input
-
client: an AzureClient
-
user_principal_name: the User's principal name
Output
Nothing is outputted by this action.
Example
1 2 3 4 | |
azure_ad.users.
select
Display users in a table & prompt the task operator to make a selection.
The table will have the following columns:
- Display Name
- User Principal Name
- Email Address
- Enabled
Minimum Plugin Version: 1.0.0
Input
-
text: the title of the table
-
users: any number of Users
-
minimum: the minimum number of selections
-
maximum: the maximum number of selections
Output
A Selection containing:
Example
1 2 3 4 5 6 7 8 9 10 | |
azure_ad.users.
select_one
Display users in a table & prompt the task operator to select one.
The table will have the following columns:
- Display Name
- User Principal Name
- Email Address
- Enabled
Minimum Plugin Version: 1.0.0
Input
-
text: the title of the table
-
users: any number of Users
Output
A single User.
Example
1 2 3 4 5 6 7 8 9 10 | |
azure_ad.users.
set_automatic_replies
Set a user's automatic replies settings.
Minimum Plugin Version: 2.0.0
Input
-
client: an AzureClient
-
user_principal_name: the User's principal name
-
internal_message: message to use when replying to senders within the organisation
-
external_message: message to use when replying to senders outside the organisation
-
external_audience: optional external audience (all, contactsOnly, or none, defaults to all)
-
start_date: optional start date in YYYY-MM-DD HH:MM:SS format
-
end_date: optional end date in YYYY-MM-DD HH:MM:SS format
-
time_zone: optional time zone to apply to start_date & end_date (defaults to
Europe/London)
Output
Nothing is outputted by this action.
Example
1 2 3 4 5 6 7 8 9 | |
azure_ad.users.
set_manager
Set the supplied user's manager.
Minimum Plugin Version: 1.0.0
Input
-
client: an AzureClient
-
user_principal_name: the User's principal name
-
manager_principal_name: the new manager's principal name
Output
Nothing is outputted by this action.
Example
1 2 3 4 5 | |
azure_ad.users.
set_password
Set a user's password.
Minimum Plugin Version: 1.0.0
Required API Permissions
See passwordProfile in this table for the required API permissions & roles.
Input
-
client: an AzureClient
-
user_principal_name: the User's principal name
-
password: the new password to set
Output
Nothing is outputted by this action.
Example
1 2 3 4 5 | |
azure_ad.users.
update
Update one or more attributes for a user.
Minimum Plugin Version: 1.0.0
Input
-
client: an AzureClient
-
user_principal_name: the User's principal name
-
attributes: a dictionary of attribute names & values to set
Valid Attributes
See this Microsoft article for a list of user attributes.
This action will fail if any invalid attributes are supplied.
Output
Nothing is outputted by this action.
Example
```YAML linenums="1" - azure_ad.users.update: user_principal_name: john.smith@domain.com attributes: givenName: John surname: Smith companyName: Acme Corporation load: client: azure_client
```