PPA API: Users

Summary

This module contains actions for viewing users in PPA.

PPA Version

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

Actions

ppa_api.users.

access_report

Generates a CSV export of the Users page in PPA.

Minimum Plugin Version: 4.1.0

Input

This action takes no inputs.

Output

The generated CSV report as a string.

See the snippet below for an example of how to download the CSV report from the Task Interface.

Example

- ppa_api.users.access_report:
  save: report

- ppa.ui.output_file:
    text: User Access Report
    filename: access_report.csv
  load:
    data: report

ppa_api.users.

display

Display users 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

• users: any number of Users to display in the table

Output

Nothing is outputted by this action.

Example

- ppa_api.users.get_all:
  save: users

- ppa_api.users.display:
    text: All Users
  load:
    users: users

ppa_api.users.

get_all

Get all current users from PPA.

Minimum Plugin Version: 4.1.0

Input

This action takes no inputs.

Output

A list of Users.

Example

- ppa_api.users.get_all:
  save: users

ppa_api.users.

get_by_logon_name

Get the user with the supplied logon name.

Minimum Plugin Version: 4.1.0

Input

• name: the user's logon name

Output

A single User.

Example

- ppa_api.users.get_by_logon_name:
    name: example.user
  save: user

ppa_api.users.

get_deleted

Get all deleted users from PPA.

Minimum Plugin Version: 4.1.0

Input

This action takes no inputs.

Output

A list of Users.

Example

- ppa_api.users.get_deleted:
  save: deleted_users

ppa_api.users.

select

Display users 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

• users: any number of Users 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 Users

• all: a list of selected Users

• first: the first selected Users

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.users.get_all:
  save: users

- ppa_api.users.select:
    text: Select Users
  load:
    users: users
  save: selection

- ppa_api.users.display:
    text: Selected Users
  load:
    users: selection.all

ppa_api.users.

select_one

Display users 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

• users: any number of Users to display in the table

Output

A single User.

Example

- ppa_api.users.get_all:
  save: users

- ppa_api.users.select:
    text: Select Users
  load:
    users: users
  save: user

- ppa_api.users.display:
    text: Selected User
  load:
    users: user