Microsoft Azure Microsoft Azure: AD - Users

Summary

This module contains actions for viewing and managing Azure AD Users.

Actions

azure.ad.users.

get_all

Get all AD users.

Minimum Plugin Version: 1.0.0

Input
Output

A list of ADUser dictionaries.

Example
1
2
3
4
- azure.ad.users.get_all:
  load:
    azure_client: azure_secrets
  save: all_users

azure.ad.users.

get_by_name

Get an AD user by name

Minimum Plugin Version: 1.0.0

Input
  • azure_client: an AzureClient dictionary

  • name: User name

Output

A list of ADUser dictionaries.

Example
1
2
3
4
5
- azure.ad.users.get_by_name:
    name: Jon Smith
  load:
    azure_client: azure_secrets
  save: ppa_group

azure.ad.users.

group_memberships

Get an all group memberships for an AD user

Minimum Plugin Version: 1.0.0

Input
  • azure_client: an AzureClient dictionary

  • user_id: User Object ID

Output

A list of ADGroup dictionaries.

Example
1
2
3
4
5
- azure.ad.users.group_memberships:
  load:
    user_id: user_id
    azure_client: azure_secrets
  save: user_groups

azure.ad.users.

output_table

Display a list of users in a table. The table will have the following columns:

The table will have the following columns:

  • Display Name
  • Principal Name
  • Object ID

Minimum Plugin Version: 1.0.0

Input
  • text: the title of the table

  • user_list: a list of ADUser dictionaries to display in the table

Output

Nothing is outputted by this action.

Example
  • Show a list of users in a table
1
2
3
4
- azure.ad.users.output_table:
    text: All users in AD group: ppa
  load:
    user_list: group_users