PPA API: Groups

Summary

This module contains actions for viewing groups in PPA.

PPA Version

The actions in this module require PPA v2.10.x or newer.

Actions

ppa_api.groups.

display

Display groups in a table.

The table will have the following columns:

• Display Name
• Logon Name
• Email Address
• Can Start Tasks

Minimum Plugin Version: 4.1.0

Input

• text: the title of the table

• groups: any number of Groups to display in the table

Output

Nothing is outputted by this action.

Example

- ppa_api.groups.get_all:
  save: groups

- ppa_api.groups.display:
    text: All Groups
  load:
    groups: groups

ppa_api.groups.

get_all

Get all current groups from PPA.

Minimum Plugin Version: 4.1.0

Input

This action takes no inputs.

Output

A list of Groups.

Example

- ppa_api.groups.get_all:
  save: groups

ppa_api.groups.

get_by_name

Get the group with the supplied name.

Minimum Plugin Version: 4.1.0

Input

• name: the group's name

Output

A single Group.

Example

- ppa_api.groups.get_by_name:
    name: example.group
  save: group

ppa_api.groups.

select

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

The table will have the following columns:

• Display Name
• Logon Name
• Email Address
• Can Start Tasks

Minimum Plugin Version: 4.1.0

Input

• text: the title of the table

• groups: any number of Groups to display in the table

• minimum: the minimum number of acceptable selections

• maximum: the maximum number of acceptable selections

Output

A Selection containing:

• total: the number of selected Groups

• all: a list of selected Groups

• first: the first selected Groups

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

- ppa_api.groups.get_all:
  save: groups

- ppa_api.groups.select:
    text: Select Groups
  load:
    groups: groups
  save: selection

- ppa_api.groups.display:
    text: Selected Groups
  load:
    groups: selection.all

ppa_api.groups.

select_one

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

The table will have the following columns:

• Display Name
• Logon Name
• Email Address
• Can Start Tasks

Minimum Plugin Version: 4.1.0

Input

• text: the title of the table

• groups: any number of Groups to display in the table

Output

A single Group.

Example

- ppa_api.groups.get_all:
  save: groups

- ppa_api.groups.select:
    text: Select Groups
  load:
    groups: groups
  save: group

- ppa_api.groups.display:
    text: Selected Group
  load:
    groups: group