Skip to content

PPA PPA: User

Summary

This module contains actions related to the user running a task.

Actions

ppa.user.

has_mfa

Find out whether the user who started the task has MFA configured in the PPA Appliance.

Minimum Plugin Version: 8.0.0

Minimum PPA Version: 3.0.0

Input
  • text: optional text to display when the action runs (defaults to Getting MFA Configuration)
Output

A boolean is outputted by this action:

  • true if the user has MFA configured

  • false if the user does not have MFA configured

Example
1
2
- ppa.user.has_mfa:
  save: has_mfa

ppa.user.

prompt_mfa

Prompt the user who started the task for MFA.

This action will fail if the user does not have MFA configured in the PPA appliance.

Minimum Plugin Version: 8.0.0

Minimum PPA Version: 3.0.0

Input

  • text: optional text to display as the MFA prompt (defaults to Please provide an MFA token.)

  • max_attempts: maximum number of authentication attempts before the action fails (defaults to 5)

  • sensitive: set to true to protect sensitive data (requires PPA v3 & plugin version 8.0.0)

Output

Nothing is outputted by this action.

Example
1
- ppa.user.prompt_mfa: