Osirium PAM: Account Mappings

Summary

This module contains actions for reading account mapping information from PAM.

Supported Versions

This plugin supports PAM versions 9.0.0 & newer.

Remember

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

Actions

pam.account_mappings.

display

Display account mappings in a table.

The table will have the following columns:

• Name
• Pattern
• Notes

Minimum Plugin Version: 6.0.0

Input

• text: the title of the table

• account_mappings: any number of AccountMappings

Output

Nothing is outputted by this action.

Example

- pam.account_mappings.get_all:
    pam_address: pam.internal.net
  save: account_mappings

- pam.account_mappings.display:
    text: Users
  load:
    account_mappings: account_mappings

pam.account_mappings.

get_all

Get all device account mappings from the PAM appliance.

Minimum Plugin Version: 6.0.0

Input

pam_address: the IP or DNS address of the PAM Appliance

Output

A list of AccountMappings.

Example

- pam.account_mappings.get_all:
    pam_address: pam.internal.net
  save: all_account_mappings

pam.account_mappings.

get_by_id

Get an account mapping using its ID.

Minimum Plugin Version: 6.0.0

Input

pam_address: the IP or DNS address of the PAM Appliance

account_mapping_id: the ID of the account mapping

Output

A single AccountMapping.

Example

- pam.account_mappings.get_by_id:
    pam_address: pam.internal.net
    account_mapping_id: 123
  save: account_mapping

pam.account_mappings.

get_by_name

Get an account mapping using its name.

Minimum Plugin Version: 6.0.0

Input

pam_address: the IP or DNS address of the PAM Appliance

name: the name of the account mapping

Output

A single AccountMapping.

Example

- pam.account_mappings.get_by_name:
    pam_address: pam.internal.net
    name: Admin Mapping
  save: admin_account_mapping

pam.account_mappings.

get_by_pattern

Get an account mapping using its pattern.

Minimum Plugin Version: 6.0.0

Input

pam_address: the IP or DNS address of the PAM Appliance

pattern: the account mapping's pattern

Output

A single AccountMapping.

Example

- pam.account_mappings.get_by_pattern:
    pam_address: pam.internal.net
    pattern: %username%_admin
  save: admin_account_mapping

pam.account_mappings.

select

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

The table will have the following columns:

• Name
• Pattern
• Notes

Minimum Plugin Version: 6.0.0

Input

• text: The title of the table

• account_mappings: any number of AccountMappings

• minimum: The minimum number of acceptable selections

• maximum: The maximum number of acceptable selections

Output

A Selection containing:

• total: the number of selected AccountMappings

• all: a list of selected AccountMappings

• first: the first selected AccountMapping

Example

- pam.account_mappings.get_all:
    pam_address: pam.internal.net
  save: account_mappings

- pam.account_mappings.select:
    text: Select Account Mappings
  load:
    account_mappings: account_mappings
  save: selection

pam.account_mappings.

select_one

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

The table will have the following columns:

• Name
• Pattern
• Notes

Minimum Plugin Version: 6.0.0

Input

• text: The title of the table

• account_mappings: any number of AccountMappings

Output

A single AccountMapping.

Example

- pam.account_mappings.get_all:
    pam_address: pam.internal.net
  save: account_mappings

- pam.account_mappings.select_one:
    text: Select Account Mapping
  load:
    account_mappings: account_mappings
  save: account_mapping