Delete User

This is an interactive task for deleting a user in Office 365.

Playbook Files

Requires PPA version 2.10.0 or newer

plugins:
  ppa: ^6
  hashicorp_vault: ^5
  microsoft_graph: ^2.1


set:
  domain: null


steps:


  - name: Check Domain
    when: not domain
    actions:

      - ppa.ui.output_error:
          text: The Office 365 domain is not configured in the playbook.

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


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

      - exit:
          exit_code: 2


  - name: Greeting
    actions:

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


            ### Office 365 - Delete User


            Use this task to delete an Office 365 user.


            You will need to:


            - Select & confirm the user to delete.


      - ppa.ui.input_accept:
          text: Start


  - name: Get Secrets
    actions:

      - hashicorp_vault.key_value.read_secret_keys:
          secret: office_365
          keys:
            - name: tenant_id
            - name: client_id
            - name: client_secret
              sensitive: true
          reason: Getting Office 365 details
          create_missing: true
        save: graph_client


  - name: Get All Users
    actions:

      - ppa.ui.output_progress:
          text: Getting all users from Office 365...
          element_id: get_users

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

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


  - name: Select User
    while:
      name: user_confirmed
      value: false
    actions:

      - microsoft_graph.users.select_one:
          text: Select user to delete
        load:
          users: users
        save: selected_user

      - microsoft_graph.users.display:
          text: Selected user
        load:
          users: selected_user

      - ppa.ui.input_confirm:
          text: Delete the selected user?
        save: user_confirmed

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


  - name: Delete User
    actions:

      - ppa.ui.output_progress:
          text: Deleting user in Office 365...
          element_id: delete_user

      - microsoft_graph.users.delete:
        load:
          user_principal_name: selected_user.user_principal_name
          client: graph_client

      - ppa.ui.output_progress:
          text: Deleted user in Office 365
          percent: 100
          element_id: delete_user


  - name: Summary
    actions:

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

            User {{ selected_user.user_principal_name }} was deleted successfully.

Running this Playbook

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

* Requires PPA v2.9.x or newer

Required Configuration

You will need to configure your Office 365 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

Office 365

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

The Office 365 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 user 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.