Assigned Licence Report

This is an interactive task for auditing which users are currently assigned a licence for each licence.

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:
  users_licences: {}
  licences_users: {}

steps:

  - name: Greeting
    actions:

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


            ### Azure AD - Assigned Licences Report


            Use this task to view which users are currently assigned a licence for each licence.


            You will need to:


            - Choose whether to audit _all_ users or select them manually

      - 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...
          percent: null
          element_id: get_users

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

      - ppa.ui.output_progress:
          text: Got all users
          percent: 100
          element_id: get_users

      - ppa.ui.input_confirm:
          text: Check all users, or select users manually?
          confirm: All Users
          cancel: Select Manually
        save: check_all_users


  - name: Select Users
    when: not check_all_users
    actions:

      - azure_ad.users.select:
          text: Select Users
          minimum: 1
        load:
          users: users
        save: users

      # When picking from a table the list of users is inside the 'all' key.
      - set:
          name: users
        load:
          value: users.all


  - name: Run Licences Report
    actions:

      - azure_ad.licences.display_for_users:
        load:
          users: users
          client: graph_client

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
Microsoft Graph Users & Licences

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:

User.Read.All
Directory.Read.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 whether to audit all users or select users manually.

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.