Modify User

This is an interactive task for modifying attributes of an existing user in Active Directory.

Playbook Files

This playbook was built for PPA version 3.3

# The task was built to work with these plugin versions.
plugins:
  ppa: ^11.4
  ppa_tools: ^11.0
  hashicorp_vault: ^8.0
  active_directory: ^13.0

set:
  attributes:
    - name: First Name
      attribute: givenName
      validator: text
    - name: Surname
      attribute: sn
      validator: text
    - name: Display Name
      attribute: displayName
      validator: text
    - name: Description
      attribute: description
      validator: text
    - name: Login Shell
      attribute: loginShell
      validator: text
    - name: Email Address
      attribute: mail
      validator: email
    - name: Telephone Number
      attribute: telephoneNumber
      validator: text
    - name: Employee Number
      attribute: employeeNumber
      validator: text
  new_values: []


steps:


  - name: Greeting
    actions:

      - ppa.ui.output_markdown:
          doc: >
            {{ globals.icons.active_directory.full }}


            ### Active Directory - Modify User


            Use this task to modify one or more attributes for an Active Directory user.


            You will need to:


            - Search for & select an Active Directory user

            - Choose attributes to modify

            - Supply & confirm new attribute values


      - ppa.ui.input_accept:
          text: Start


  - name: Get Secrets
    actions:

      - hashicorp_vault.key_value.read_secret_keys:
          secret: active_directory
          reason: Getting Active Directory details
          keys:
            - name: address
            - name: domain
            - name: username
            - name: password
              sensitive: true
          create_missing: true
        save: domain_controller


  - name: Get User
    actions:

      - active_directory.users.get_interactive:
        load:
          domain_controller: domain_controller
        save: active_directory_user


  - name: Choose Attributes
    actions:

      - ppa_tools.generate.table_from_dictionaries:
          header:
            - Name
            - Active Directory Attribute
          keys:
            - name
            - attribute
        load:
          dictionaries: attributes
        save: attribute_table

      - ppa.ui.input_table:
          text: Select Attribute(s)
          minimum: 1
        load:
          header: attribute_table.header
          rows: attribute_table.rows
        save: indices

      - ppa_tools.lists.get_items:
        load:
          items: attributes
          indices: indices
        save: selected_attributes


  - name: Supply Attribute Values
    for_each:
      items: selected_attributes
      name: current_attribute
      skip: skip
    actions:

      - ppa.ui.output_markdown:
          doc: >
            **Attribute ({{ step_counter }} of {{ selected_attributes | length }}):** {{ current_attribute.name }}


            **Current Value:** {{ active_directory_user[current_attribute.attribute] }}

      - ppa.ui.input_confirm:
          text: Please choose an option
          confirm: Set New Value
          cancel: Keep Existing Value
        save: set_new_value

      - ppa.ui.output_error:
          text: The {{ current_attribute.name | lower }} will not be updated.
        when: not set_new_value

      - set:
          name: skip
          value: true
        when: not set_new_value

      - ppa.ui.input_text:
          text: New value for {{ current_attribute.name }}
        save: new_value
        when: current_attribute.validator == "text"

      - ppa.ui.input_email:
          text: New value for {{ current_attribute.name }}
        save: new_value
        when: current_attribute.validator == "email"

      - ppa_tools.dictionaries.create:
        load:
          name: current_attribute.name
          attribute: current_attribute.attribute
          new_value: new_value
        save: updated_attribute

      - ppa_tools.lists.append:
        load:
          items: new_values
          value: updated_attribute
        save: new_values


  - name: Exit If No New Values
    when: not new_values
    actions:

      - ppa.ui.output_info:
          text: No new attribute values have been supplied, goodbye!

      - exit:
          exit_code: 0


  - name: Count & Display Attribute Updates
    actions:

      - count:
        load:
          item: new_values
        save: attribute_count

      - ppa.ui.output_markdown:
          doc: >
           ### Updates


           {% for update in new_values %}


           **Attribute {{ loop.index }}:** {{ update.name }}


           **New Value:** {{ update.new_value }}

           {% endfor %}

      - ppa.ui.input_confirm:
          text: Set new values?
        save: confirm


  - name: Exit If Update Cancelled
    when: not confirm
    actions:

      - ppa.ui.output_error:
          text: Operation cancelled, no attributes will be modified.

      - exit:
          exit_code: 0


  - name: Set New Values
    for_each:
      items: new_values
      name: attribute
    actions:

      - ppa.ui.output_progress:
          text: Setting {{ attribute_count }} attribute value(s) for {{ active_directory_user.cn }}...
          percent: null
          element_id: set_values
        when: step_counter == 1

      - active_directory.users.replace_attribute:
        load:
          name: attribute.attribute
          value: attribute.new_value
          distinguishedName: active_directory_user.distinguishedName
          domain_controller: domain_controller

      - ppa.ui.output_progress:
          text: Successfully set {{ attribute_count }} attribute value(s) for {{ active_directory_user.cn }}
          percent: 100
          element_id: set_values
        when: step_counter == attribute_count


  - name: Get & Display Updated Attributes
    actions:

      - ppa.ui.output_progress:
          text: Getting updated attributes for {{ active_directory_user.cn }}...
          percent: null
          element_id: get_updates

      - ppa_tools.dictionaries.get_key_values:
          key: attribute
        load:
          dictionaries: new_values
        save: table_attributes

      - ppa_tools.dictionaries.get_key_values:
          key: name
        load:
          dictionaries: new_values
        save: table_header

      - active_directory.users.by_samaccountname:
        load:
         sAMAccountName: active_directory_user.sAMAccountName
         domain_controller: domain_controller
        save: updated_user

      - ppa.ui.output_progress:
          text: Got updated attributes for {{ active_directory_user.cn }}
          percent: 100
          element_id: get_updates

      - active_directory.users.output_custom_table:
          text: Updated attributes for {{ updated_user.cn }}
        load:
          header: table_header
          attributes: table_attributes
          users: updated_user

Running this Playbook

Click download playbook
Import the playbook on the Playbooks page in PPA
Build the playbook from the Edit & Build tab
Run the playbook from the Preview & Deploy tab

Integrations

PPA User Interface
Hashicorp Vault Key-Value engine
Active Directory Users

Required Vault Details

Active Directory

IP/DNS address of a Domain Controller
Domain FQDN
Username
Password

The Active Directory credentials need permission to create a user & add them to groups.

Vault Configuration Wizard

The first time you run a task built from this playbook, PPA will check the required Vault details exist.

If they don't exist, PPA will ask you to supply the details at the start of the task.

Below you can see a user providing details the first time they run an Active Directory task.

vault-config-wizard

Once the details are added to Vault, the task won't ask for them again.

If you don't know the required details, ask an administrator to run the task or configure Vault manually.

What the Task Does

Once started, this task allows the operator to:

Search for & select an Active Directory user
Choose attributes to modify
Supply & confirm new attribute values

See our other playbooks

Get PPA for free!

Start automating your estate with a free 30 day trial today. No signup required!

Get PPA Express

Documentation

Installation Guide
See how easy it is to get started with our installation guide
Playbooks
View our task writing reference guide
Plugins
See how to integrate with different systems using our plugins reference guide.