Skip to content

Osirium PAM Osirium PAM: Accounts

Summary

This module contains actions for reading account information from PAM.

Supported Versions

This plugin supports PAM versions 6.5.0 & newer.

Remember

You must have a PAM Appliance provisioned as a Vault inside PPA to use this plugin.

Actions

pam.accounts.

display

Display accounts in a table.

The table will have the following columns:

  • Name
  • Parent Type
  • State
  • Credentials Last Updated At

Minimum Plugin Version: 2.0.0

Input

  • text: the title of the table

  • accounts: any number of Accounts

Output

Nothing is outputted by this action.

Example
1
2
3
4
5
6
7
8
- pam.accounts.get_all:
    pam_address: pam.internal.net
  save: all_accounts

- pam.accounts.display:
    text: All Accounts
  load:
    accounts: all_accounts

pam.accounts.

get_all

Get all accounts from the PAM appliance.

Minimum Plugin Version: 1.0.0

Input

pam_address: the IP or DNS address of the PAM Appliance

Output

A list of Accounts.

Example
1
2
3
- pam.accounts.get_all:
    pam_address: pam.internal.net
  save: all_accounts

pam.accounts.

get_by_id

Get an account using its ID.

Minimum Plugin Version: 1.0.0

Input

pam_address: the IP or DNS address of the PAM Appliance

account_id:_ the ID of the account

Output

A single Account.

Example
1
2
3
4
- pam.accounts.get_by_id:
    pam_address: pam.internal.net
    account_id: 10
  save: account

pam.accounts.

input_table

Display accounts in a table, & allow the task operator to make a selection.

The table will have the following columns:

  • Name
  • Parent Type
  • State
  • Credentials Last Updated At

Deprecation Warning

This action will soon be deprecated in favour of select.

Minimum Plugin Version: 1.0.0

Input

  • text: The title of the table

  • accounts: any number of Accounts

  • minimum: The minimum number of acceptable selections

  • maximum: The maximum number of acceptable selections

Output

A list of Accounts.

Tip

  • If neither a minimum or maximum is provided, the task operator will be able to submit 0 selections.

  • If minimum or maximum are provided, the operation will repeat until the task operator makes a valid number of selections.

Example
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
- pam.accounts.get_all:
    pam_address: pam.internal.net
  save: all_accounts

- pam.accounts.input_table:
    text: Select an Account
    minimum: 1
    maximum: 1
  load:
    accounts: all_accounts
  save: selected_accounts

pam.accounts.

output_table

Display accounts in a table.

The table will have the following columns:

  • Name
  • Parent Type
  • State
  • Credentials Last Updated At

Deprecation Warning

This action will soon be deprecated in favour of display.

Minimum Plugin Version: 1.0.0

Input

  • text: the title of the table

  • accounts: any number of Accounts

Output

Nothing is outputted by this action.

Example
1
2
3
4
5
6
7
8
- pam.accounts.get_all:
    pam_address: pam.internal.net
  save: all_accounts

- pam.accounts.output_table:
    text: All Accounts
  load:
    accounts: all_accounts

pam.accounts.

reveal

Reveal an account's secrets using its ID.

Minimum Plugin Version: 0.1.0

Input

pam_address: the IP or DNS address of the PAM Appliance

account_id: the ID of the account

Output

A single Secret.

Example
1
2
3
4
- pam.accounts.reveal:
    pam_address: pam.internal.net
    account_id: 3
  save: secret

pam.accounts.

Search for accounts in the PAM appliance.

Minimum Plugin Version: 2.0.0

Input

pam_address: the IP or DNS address of the PAM Appliance

queries: a list of Query dictionaries to use in the search

Output

A SearchResult containing:

Search Result Format

The search result format was updated in version 2.0.0 of this plugin.

It is not compatible with playbooks written against previous versions.

See here for more information.

Example

Finding all known accounts in PAM:

1
2
3
4
5
6
7
- pam.accounts.search:
    pam_address: pam.internal.net
    queries:
      - attribute: state
        query: equal
        value: Known
  save: search_results

Wildcard Queries

You can use the % character as a wildcard in the value of each query.

pam.accounts.

select

Display accounts in a table & prompt the task operator to make a selection.

The table will have the following columns:

  • Name
  • Parent Type
  • State
  • Credentials Last Updated At

Minimum Plugin Version: 2.0.0

Input

  • text: the title of the table

  • accounts: any number of Accounts

  • minimum: the minimum number of selections

  • maximum: the maximum number of selections

Output

A Selection containing:

Example
1
2
3
4
5
6
7
8
9
- pam.accounts.get_all:
    pam_address: pam.internal.net
  save: all_accounts

- pam.accounts.select:
    text: Select Accounts
  load:
    accounts: all_accounts
  save: selection

pam.accounts.

select_one

Display accounts in a table & prompt the task operator to select one.

The table will have the following columns:

  • Name
  • Parent Type
  • State
  • Credentials Last Updated At

Minimum Plugin Version: 2.0.0

Input

  • text: the title of the table

  • accounts: any number of Accounts

Output

A single Account.

Example
1
2
3
4
5
6
7
8
9
- pam.accounts.get_all:
    pam_address: pam.internal.net
  save: all_accounts

- pam.accounts.select_one:
    text: Select an Account
  load:
    accounts: all_accounts
  save: account