azure_rm_aduser

Modify an Azure Active Directory user

Collection: azure.azcollection

Full Name: azure.azcollection.azure_rm_aduser

Synopsis

Modify an Azure Active Directory user

Parameters

Name	Type	Default	Description
account_enabled	bool		A boolean determing whether or not the user account is enabled.
Used when either creating or updating a user account.
ad_user	string		Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url	string		Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile	string	`latest`	Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack.
attribute_name	string		The name of an attribute that you want to match to I(attribute_value).
If I(attribute_name) is not a collection type it will update or delete the user where I(attribute_name) is equal to I(attribute_value).
If I(attribute_name) is a collection type it will update or delete the user where I(attribute_value) is in I(attribute_name).
Mutually exclusive with I(object_id), I(user_principal_name), and I(odata_filter).
Required together with I(attribute_value).
attribute_value	string		The value to match I(attribute_name) to.
If I(attribute_name) is not a collection type it will update or delete the user where I(attribute_name) is equal to I(attribute_value).
If I(attribute_name) is a collection type it will update or delete the user where I(attribute_value) is in I(attribute_name).
Required together with I(attribute_name).
auth_source	string	`auto`	Controls the source of the credentials to use for authentication.
Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli).
When set to C(env), the credentials will be read from the environment variables.
When set to C(credential_file), it will read the profile from C(~/.azure/credentials).
When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable C(AZURE_SUBSCRIPTION_ID) can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used.
When set to C(msi), the host machine must be an azure resource with an enabled MSI extension. C(subscription_id) or the environment variable C(AZURE_SUBSCRIPTION_ID) can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen.
The C(msi) was added in Ansible 2.6.
cert_validation_mode	string		Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable.
client_id	string		Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi).
Can also be set via the C(AZURE_CLIENT_ID) environment variable.
cloud_environment	string	`AzureCloud`	For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable.
company_name	string		The name of the company that the user is associated with.
This property can be useful for describing the company that an external user comes from.
The maximum length is 64 characters.Returned only on $select.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
disable_instance_discovery	bool	`false`	Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to True, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy.
Set via credential file profile or the C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment variable.
display_name	string		The display name of the user.
Used when either creating or updating a user account.
given_name	string		The given name for the user.
Used when either creating or updating a user account.
log_mode	string		Parent argument.
log_path	string		Parent argument.
mail	string		The primary email address of the user.
Used when either creating or updating a user account.
mail_nickname	string		The mail alias for the user.
Used when either creating or updating a user account.
mobile_phone	string		Mobile phone number of the user.
Used when either creating or updating a user account.
object_id	string		The object id for the user.
Updates or deletes the user who has this object ID.
Mutually exclusive with I(user_principal_name), I(attribute_name), and I(odata_filter).
odata_filter	string		Filter that can be used to specify a user to update or delete.
Mutually exclusive with I(object_id), I(attribute_name), and I(user_principal_name).
oidc_token	string		Direct OpenID Connect (OIDC) token (JWT) used for workload identity authentication.
This token is exchanged with Azure AD using OIDC federated identity.
Useful in CI systems (for example GitHub Actions, Azure DevOps) where an OIDC token is provided directly by the platform.
Can also be set via the C(AZURE_FEDERATED_TOKEN) environment variable.
oidc_token_file_path	string		Path to a file containing an OpenID Connect (OIDC) token (JWT) used for workload identity authentication.
The file must contain only raw token.
This method is commonly used in platforms that materialize OIDC tokens as files
Can also be set via the C(AZURE_FEDERATED_TOKEN_FILE) environment variable.
on_premises_extension_attributes	dict		Contains extensionAttributes1-15 for the user.
These extension attributes are also known as Exchange custom attributes 1-15.
For an onPremisesSyncEnabled user, the source of authority for this set of properties is the on-premises and is read-only.
For a cloud-only user (where onPremisesSyncEnabled is false), these properties can be set during the creation or update of a user object.
For a cloud-only user previously synced from on-premises Active Directory, these properties are read-only in Microsoft Graph but can be fully managed through the Exchange Admin Center or the Exchange Online V2 module in PowerShell.
on_premises_immutable_id	string		The on_premises_immutable_id of the user.
Used when either creating or updating a user account.
password	string		Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
password_force_change	bool		Whether or not the user will be forced to change their password at next logon.
If unspecified, Azure defaults this to true for new users.
Used when either creating or updating a user account.
password_force_change_mfa	bool		Identical behavior to password_force_change except multi-factor authentication (MFA) must be performed prior to changing the password.
Used when either creating or updating a user account.
password_profile	string		The password for the user.
Used when either creating or updating a user account.
profile	string		Security profile found in ~/.azure/credentials file.
secret	string		Azure client secret. Use when authenticating with a Service Principal.
state	string	`present`	State of the ad user. Use C(present) to create or update an ad user and C(absent) to delete an ad user.
subscription_id	string		Your Azure subscription Id.
surname	string		The surname for the user.
Used when either creating or updating a user account.
tenant	string		Azure tenant ID. Use when authenticating with a Service Principal.
thumbprint	string		The thumbprint of the private key specified in I(x509_certificate_path).
Use when authenticating with a Service Principal.
Required if I(x509_certificate_path) is defined.
usage_location	string		A two letter country code, ISO standard 3166.
Required for a user that will be assigned licenses due to legal requirement to check for availability of services in countries.
Used when either creating or updating a user account.
user_principal_name	string		The principal name of the user.
Creates, updates, or deletes the user who has this principal name.
Mutually exclusive with I(object_id), I(attribute_name), and I(odata_filter).
user_type	string		A string value that can be used to classify user types in your directory, such as Member and Guest.
Used when either creating or updating a user account.
x509_certificate_path	string		Path to the X509 certificate used to create the service principal in PEM format.
The certificate must be appended to the private key.
Use when authenticating with a Service Principal.

Example

yaml

- name: Create user
  azure.azcollection.azure_rm_aduser:
    user_principal_name: "{{ user_id }}"
    state: "present"
    account_enabled: "True"
    display_name: "Test_{{ user_principal_name }}_Display_Name"
    password_profile: "password"
    mail_nickname: "Test_{{ user_principal_name }}_mail_nickname"
    on_premises_immutable_id: "{{ object_id }}"
    given_name: "First"
    surname: "Last"
    user_type: "Member"
    usage_location: "US"
    mail: "{{ user_principal_name }}@contoso.com"
    mobile_phone: "+1234567890123"
    company_name: 'Test Company'
    on_premises_extension_attributes:
      extension_attribute1: "test_extension_attribute1"
      extension_attribute2: "test_extension_attribute2"
      extension_attribute11: "test_extension_attribute11"

- name: Update user with new value for account_enabled
  azure.azcollection.azure_rm_aduser:
    user_principal_name: "{{ user_id }}"
    state: "present"
    account_enabled: "False"

- name: Delete user
  azure.azcollection.azure_rm_aduser:
    user_principal_name: "{{ user_id }}"
    state: "absent"