Delete Users

This is an interactive task for deleting users in Azure AD.

Playbook Files

This playbook was built for PPA version 3.3

plugins:
  ppa: ^11.4
  ppa_tools: ^11.0
  hashicorp_vault: ^8.0
  azure_ad: ^2.0


set:
  domain: null
  deleted_users: []


steps:

  - name: Check Domain
    when: not domain
    actions:

      - ppa.ui.output_error:
          text: The Azure AD domain is not configured in the playbook.

      - ppa.ui.output_markdown:
          doc: |+
            Please add your domain to line 9 of the playbook:


            ```yaml
            domain: your-domain.com
            ```

      - ppa.ui.input_confirm:
          text: Would you like to supply a domain for this task run?
        save: supply_domain

      - ppa.ui.input_text:
          text: Domain
        save: domain
        when: supply_domain

      - exit:
          exit_code: 2
        when: not supply_domain


  - name: Greeting
    actions:

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


            ### Azure AD - Delete Users


            Use this task to delete users in Azure AD.


      - ppa.ui.input_accept:
          text: Start


  - name: Get Secrets
    actions:

      - hashicorp_vault.key_value.read_secret_keys:
          secret: azure
          keys:
            - name: tenant_id
            - name: client_id
            - name: client_secret
              sensitive: true
          reason: Getting Azure AD details
          create_missing: true
        save: graph_client


  - name: Get All Users
    actions:

      - ppa.ui.output_progress:
          text: Getting all users from Azure AD...
          element_id: get_users

      - azure_ad.users.get_all:
        load:
          client: graph_client
        save: users

      - ppa.ui.output_progress:
          text: Got {{ users | length }} users from Azure AD
          percent: 100
          element_id: get_users


  - name: Select Users
    while:
      name: users_confirmed
      value: false
    actions:

      - azure_ad.users.select:
          text: Select user(s) to delete
          minimum: 1
        load:
          users: users
        save: selected_users

      - azure_ad.users.display:
          text: Selected user(s)
        load:
          users: selected_users.all

      - ppa.ui.input_confirm:
          text: Delete the selected user(s)?
        save: users_confirmed

      - ppa.ui.output_error:
          text: Please select the user(s) again.


  - name: Delete User(s)
    for_each:
      items: selected_users.all
      name: current_user
      skip: skip
    actions:

      - ppa.ui.output_progress:
          text: Deleting {{ selected_users.total }} user(s) in Azure AD...
          element_id: delete_user
        when: step_counter == 1

      - azure_ad.users.delete:
        load:
          user_principal_name: current_user.user_principal_name
          client: graph_client
        rescue:

          - ppa.ui.output_error:
              text: "Failed to delete {{ current_user.user_principal_name }}: {{ rescue.error }}"

          - set:
              name: skip
              value: true

      - ppa_tools.lists.append:
        load:
          items: deleted_users
          value: current_user
        save: deleted_users

      - ppa.ui.output_progress:
          text: Deleted {{ selected_users.total}} user(s) in Azure AD
          percent: 100
          element_id: delete_user
        when: step_counter == selected_users.total


  - name: Summary
    actions:

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

            The following users were deleted successfully:

            {% for user in deleted_users %}

            - {{ user.user_principal_name }}

            {% endfor %}

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

Required Configuration

You will need to configure your Azure AD domain on line 8 of the playbook:

  domain: your-domain.com

Integrations

PPA User Interface
Hashicorp Vault Key-Value engine
Microsoft Graph Users

Required Vault Details

Azure AD

Azure Tenant ID
Client ID (the ID of the app registration in Azure)
Client Secret

The Azure AD credentials require the following permissions:

Directory.Read.All
User.ReadWrite.All

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:

Select & confirm the users to delete

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.