SecretManager (PingFederate Server SDK)

All Superinterfaces:

ConfigurablePlugin, DescribablePlugin, Plugin
```
public interface SecretManager
extends Plugin
```
This interface defines the methods that the PingFederate server calls to retrieve secrets from external secret storage services.

Since:

11.0

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`IN_PARAMETER_NAME_USERNAME`	The input parameter key for the configured username associated with the secret in the "inParameters" map.
`static String`	`SECRET_REFERENCE_PREFIX`	The prefix for secret references.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`SecretInfo`	`getSecretInfo(String secretId, Map<String,Object> inParameters)`	Gets the secret for the given secret id and input parameters from an external secret storage service.

Methods inherited from interface com.pingidentity.sdk.ConfigurablePlugin
configure

Methods inherited from interface com.pingidentity.sdk.DescribablePlugin
getPluginDescriptor

- Field Detail
  - SECRET_REFERENCE_PREFIX
```
static final String SECRET_REFERENCE_PREFIX
```
    The prefix for secret references. Secret Reference format: 'OBF:MGR:{secretManagerId}:{secretId}'.
    
    See Also:
    
    Constant Field Values
  - IN_PARAMETER_NAME_USERNAME
```
static final String IN_PARAMETER_NAME_USERNAME
```
    The input parameter key for the configured username associated with the secret in the "inParameters" map.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getSecretInfo
```
SecretInfo getSecretInfo(String secretId,
                         Map<String,Object> inParameters)
                  throws SecretManagerException
```
    Gets the secret for the given secret id and input parameters from an external secret storage service.
    
    Parameters:
    
    secretId - the identifier used to identify a secret in an external secret storage service
    
    inParameters - the input parameters
    
    Returns:
    
    SecretInfo
    
    Throws:
    
    SecretManagerException - if there are errors retrieving the secret