PPA: Vaults
Summary
This module contains actions for viewing & selecting PPA Vaults in a task.
Actions
ppa.vaults.
aws_vault_by_name
Get the AWS Secrets Manager Vault with the supplied name.
Minimum Plugin Version: 5.5.0
Minimum PPA Version: 2.7.1
Input
- name: the name of the AWS Secrets Manager Vault
Output
A single Vault.
Example
1 2 3 |
|
ppa.vaults.
aws_vaults
Get all AWS Secrets Manager Vaults configured in PPA.
Minimum Plugin Version: 5.5.0
Minimum PPA Version: 2.7.1
Input
- reason: text to display in the task interface (defaults to
Getting AWS Secrets Manager Vaults
)
Output
A list of Vaults.
Example
1 2 |
|
ppa.vaults.
azure_vault_by_name
Get the Azure Key Vault with the supplied name.
Minimum Plugin Version: 5.5.0
Minimum PPA Version: 2.7.0
Input
- name: the name of the Azure Key Vault
Output
A single Vault.
Example
1 2 3 |
|
ppa.vaults.
azure_vaults
Get all Azure Key Vaults configured in PPA.
Minimum Plugin Version: 5.5.0
Minimum PPA Version: 2.7.0
Input
- reason: text to display in the task interface (defaults to
Getting Azure Key Vaults
)
Output
A list of Vaults.
Example
1 2 |
|
ppa.vaults.
get_all
Get all Vaults configured in PPA.
Minimum Plugin Version: 5.5.0
Input
- reason: text to display in the task interface (defaults to
Getting all Vaults
)
Output
A list of Vaults.
Example
1 2 |
|
ppa.vaults.
hashicorp_vault_by_name
Get the Hashicorp Vault with the supplied name.
Minimum Plugin Version: 5.5.0
Input
- name: the name of the Hashicorp Vault
Output
A single Vault.
Example
1 2 3 |
|
ppa.vaults.
hashicorp_vaults
Get all Hashicorp Vaults configured in PPA.
Minimum Plugin Version: 5.5.0
Input
- reason: text to display in the task interface (defaults to
Getting Hashicorp Vaults
)
Output
A list of Vaults.
Example
1 2 |
|
ppa.vaults.
input_table
Display vaults in a table, & allow the task operator to make a selection.
The table will have the following columns:
- Name
- Type
- Address
- Expires At
Minimum Plugin Version: 5.5.0
Input
-
text: the title of the table
-
vaults: a single or list of Vaults to display in the table
-
minimum: the minimum number of acceptable selections
-
maximum: the maximum number of acceptable selections
Output
A list of Vaults.
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 |
|
ppa.vaults.
output_table
Display vaults in a table.
The table will have the following columns:
- Name
- Type
- Address
- Expires At
Minimum Plugin Version: 5.5.0
Input
-
text: the title of the table
-
vaults: a single or list of Vaults to display in the table
Output
Nothing is outputted by this action.
Example
1 2 3 4 5 6 7 |
|
ppa.vaults.
pam_vault_by_name
Get the Osirium PAM Vault with the supplied name.
Minimum Plugin Version: 5.5.0
Input
- name: the name of the Osirium PAM Vault
Output
A single Vault.
Example
1 2 3 |
|
ppa.vaults.
pam_vaults
Get all Osirium PAM Vaults configured in PPA.
Minimum Plugin Version: 5.5.0
Input
- reason: text to display in the task interface (defaults to
Getting Osirium PAM Vaults
)
Output
A list of Vaults.
Example
1 2 |
|
ppa.vaults.
select_aws_vault
Select an AWS Secrets Manager vault from the PPA configuration.
By default if only 1 AWS Secrets Manager vault exists, it will be selected automatically.
Minimum Plugin Version: 5.5.0
Input
- auto_select: set to false to force table selection if only 1 vault exists (defaults to true)
Output
A single Vault.
Example
1 2 |
|
ppa.vaults.
select_azure_vault
Select an Azure Key vault from the PPA configuration.
By default if only 1 Azure Key vault exists, it will be selected automatically.
Minimum Plugin Version: 5.5.0
Input
- auto_select: set to false to force table selection if only 1 vault exists (defaults to true)
Output
A single Vault.
Example
1 2 |
|
ppa.vaults.
select_hashicorp_vault
Select a Hashicorp vault from the PPA configuration.
By default if only 1 Hashicorp vault exists, it will be selected automatically.
Minimum Plugin Version: 5.5.0
Input
- auto_select: set to false to force table selection if only 1 vault exists (defaults to true)
Output
A single Vault.
Example
1 2 |
|
ppa.vaults.
select_pam_vault
Select a PAM vault from the PPA configuration.
By default if only 1 PAM vault exists, it will be selected automatically.
Minimum Plugin Version: 5.5.0
Input
- auto_select: set to false to force table selection if only 1 vault exists (defaults to true)
Output
A single Vault.
Example
1 2 |
|